Package com.google.cloud.discoveryengine.v1beta

Interface AnswerOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Answer, Answer.Builder
@Generated public interface AnswerOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Immutable. Fully qualified name
 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Immutable. Fully qualified name
 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for name.

    • getStateValue

      int getStateValue()
       The state of the answer generation.
      .google.cloud.discoveryengine.v1beta.Answer.State state = 2;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Answer.State getState()
       The state of the answer generation.
      .google.cloud.discoveryengine.v1beta.Answer.State state = 2;
      Returns:
      The state.

    • getAnswerText

      String getAnswerText()
       The textual answer.
      string answer_text = 3;
      Returns:
      The answerText.

    • getAnswerTextBytes

      com.google.protobuf.ByteString getAnswerTextBytes()
       The textual answer.
      string answer_text = 3;
      Returns:
      The bytes for answerText.

    • getCitationsList

      List<Answer.Citation> getCitationsList()
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

    • getCitations

      Answer.Citation getCitations(int index)
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

    • getCitationsCount

      int getCitationsCount()
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

    • getCitationsOrBuilderList

      List<? extends Answer.CitationOrBuilder> getCitationsOrBuilderList()
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

    • getCitationsOrBuilder

      Answer.CitationOrBuilder getCitationsOrBuilder(int index)
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

    • getReferencesList

      List<Answer.Reference> getReferencesList()
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

    • getReferences

      Answer.Reference getReferences(int index)
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

    • getReferencesCount

      int getReferencesCount()
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

    • getReferencesOrBuilderList

      List<? extends Answer.ReferenceOrBuilder> getReferencesOrBuilderList()
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

    • getReferencesOrBuilder

      Answer.ReferenceOrBuilder getReferencesOrBuilder(int index)
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

    • getRelatedQuestionsList

      List<String> getRelatedQuestionsList()
       Suggested related questions.
      repeated string related_questions = 6;
      Returns:
      A list containing the relatedQuestions.

    • getRelatedQuestionsCount

      int getRelatedQuestionsCount()
       Suggested related questions.
      repeated string related_questions = 6;
      Returns:
      The count of relatedQuestions.

    • getRelatedQuestions

      String getRelatedQuestions(int index)
       Suggested related questions.
      repeated string related_questions = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The relatedQuestions at the given index.

    • getRelatedQuestionsBytes

      com.google.protobuf.ByteString getRelatedQuestionsBytes(int index)
       Suggested related questions.
      repeated string related_questions = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the relatedQuestions at the given index.

    • getStepsList

      List<Answer.Step> getStepsList()
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

    • getSteps

      Answer.Step getSteps(int index)
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

    • getStepsCount

      int getStepsCount()
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

    • getStepsOrBuilderList

      List<? extends Answer.StepOrBuilder> getStepsOrBuilderList()
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

    • getStepsOrBuilder

      Answer.StepOrBuilder getStepsOrBuilder(int index)
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

    • hasQueryUnderstandingInfo

      boolean hasQueryUnderstandingInfo()
       Query understanding information.
      .google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;
      Returns:
      Whether the queryUnderstandingInfo field is set.

    • getQueryUnderstandingInfo

      Answer.QueryUnderstandingInfo getQueryUnderstandingInfo()
       Query understanding information.
      .google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;
      Returns:
      The queryUnderstandingInfo.

    • getQueryUnderstandingInfoOrBuilder

      Answer.QueryUnderstandingInfoOrBuilder getQueryUnderstandingInfoOrBuilder()
       Query understanding information.
      .google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

    • getAnswerSkippedReasonsList

      List<Answer.AnswerSkippedReason> getAnswerSkippedReasonsList()
       Additional answer-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
      Returns:
      A list containing the answerSkippedReasons.

    • getAnswerSkippedReasonsCount

      int getAnswerSkippedReasonsCount()
       Additional answer-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
      Returns:
      The count of answerSkippedReasons.

    • getAnswerSkippedReasons

      Answer.AnswerSkippedReason getAnswerSkippedReasons(int index)
       Additional answer-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The answerSkippedReasons at the given index.

    • getAnswerSkippedReasonsValueList

      List<Integer> getAnswerSkippedReasonsValueList()
       Additional answer-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
      Returns:
      A list containing the enum numeric values on the wire for answerSkippedReasons.

    • getAnswerSkippedReasonsValue

      int getAnswerSkippedReasonsValue(int index)
       Additional answer-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of answerSkippedReasons at the given index.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Answer creation timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Answer creation timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Answer creation timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasCompleteTime

      boolean hasCompleteTime()
       Output only. Answer completed timestamp.
      .google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the completeTime field is set.

    • getCompleteTime

      com.google.protobuf.Timestamp getCompleteTime()
       Output only. Answer completed timestamp.
      .google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The completeTime.

    • getCompleteTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder()
       Output only. Answer completed timestamp.
      .google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];