Package com.google.cloud.discoveryengine.v1beta

Enum SearchResponse.Summary.SummarySkippedReason

java.lang.Object
java.lang.Enum<SearchResponse.Summary.SummarySkippedReason>
com.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchResponse.Summary.SummarySkippedReason>
Enclosing class:
SearchResponse.Summary
public static enum SearchResponse.Summary.SummarySkippedReason extends Enum<SearchResponse.Summary.SummarySkippedReason> implements com.google.protobuf.ProtocolMessageEnum
 An Enum for summary-skipped reasons.
Protobuf enum google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason

  • Enum Constant Details

    • SUMMARY_SKIPPED_REASON_UNSPECIFIED

      public static final SearchResponse.Summary.SummarySkippedReason SUMMARY_SKIPPED_REASON_UNSPECIFIED
       Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0;

    • ADVERSARIAL_QUERY_IGNORED

      public static final SearchResponse.Summary.SummarySkippedReason ADVERSARIAL_QUERY_IGNORED
       The adversarial query ignored case.

 Only used when
 [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query]
 is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1;

    • NON_SUMMARY_SEEKING_QUERY_IGNORED

      public static final SearchResponse.Summary.SummarySkippedReason NON_SUMMARY_SEEKING_QUERY_IGNORED
       The non-summary seeking query ignored case.

 Google skips the summary if the query is chit chat.
 Only used when
 [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query]
 is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2;

    • OUT_OF_DOMAIN_QUERY_IGNORED

      public static final SearchResponse.Summary.SummarySkippedReason OUT_OF_DOMAIN_QUERY_IGNORED
       The out-of-domain query ignored case.

 Google skips the summary if there are no high-relevance search results.
 For example, the data store contains facts about company A but the
 user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3;

    • POTENTIAL_POLICY_VIOLATION

      public static final SearchResponse.Summary.SummarySkippedReason POTENTIAL_POLICY_VIOLATION
       The potential policy violation case.

 Google skips the summary if there is a potential policy violation
 detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4;

    • LLM_ADDON_NOT_ENABLED

      public static final SearchResponse.Summary.SummarySkippedReason LLM_ADDON_NOT_ENABLED
       The LLM addon not enabled case.

 Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5;

    • NO_RELEVANT_CONTENT

      public static final SearchResponse.Summary.SummarySkippedReason NO_RELEVANT_CONTENT
       The no relevant content case.

 Google skips the summary if there is no relevant content in the
 retrieved search results.
      NO_RELEVANT_CONTENT = 6;

    • JAIL_BREAKING_QUERY_IGNORED

      public static final SearchResponse.Summary.SummarySkippedReason JAIL_BREAKING_QUERY_IGNORED
       The jail-breaking query ignored case.

 For example, "Reply in the tone of a competing company's CEO".
 Only used when
 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
 is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7;

    • CUSTOMER_POLICY_VIOLATION

      public static final SearchResponse.Summary.SummarySkippedReason CUSTOMER_POLICY_VIOLATION
       The customer policy violation case.

 Google skips the summary if there is a customer policy violation
 detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8;

    • NON_SUMMARY_SEEKING_QUERY_IGNORED_V2

      public static final SearchResponse.Summary.SummarySkippedReason NON_SUMMARY_SEEKING_QUERY_IGNORED_V2
       The non-answer seeking query ignored case.

 Google skips the summary if the query doesn't have clear intent.
 Only used when
 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
 is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9;

    • UNRECOGNIZED

      public static final SearchResponse.Summary.SummarySkippedReason UNRECOGNIZED

  • Field Details

    • SUMMARY_SKIPPED_REASON_UNSPECIFIED_VALUE

      public static final int SUMMARY_SKIPPED_REASON_UNSPECIFIED_VALUE
       Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0;
      See Also:

    • ADVERSARIAL_QUERY_IGNORED_VALUE

      public static final int ADVERSARIAL_QUERY_IGNORED_VALUE
       The adversarial query ignored case.

 Only used when
 [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query]
 is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1;
      See Also:

    • NON_SUMMARY_SEEKING_QUERY_IGNORED_VALUE

      public static final int NON_SUMMARY_SEEKING_QUERY_IGNORED_VALUE
       The non-summary seeking query ignored case.

 Google skips the summary if the query is chit chat.
 Only used when
 [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query]
 is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2;
      See Also:

    • OUT_OF_DOMAIN_QUERY_IGNORED_VALUE

      public static final int OUT_OF_DOMAIN_QUERY_IGNORED_VALUE
       The out-of-domain query ignored case.

 Google skips the summary if there are no high-relevance search results.
 For example, the data store contains facts about company A but the
 user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3;
      See Also:

    • POTENTIAL_POLICY_VIOLATION_VALUE

      public static final int POTENTIAL_POLICY_VIOLATION_VALUE
       The potential policy violation case.

 Google skips the summary if there is a potential policy violation
 detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4;
      See Also:

    • LLM_ADDON_NOT_ENABLED_VALUE

      public static final int LLM_ADDON_NOT_ENABLED_VALUE
       The LLM addon not enabled case.

 Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5;
      See Also:

    • NO_RELEVANT_CONTENT_VALUE

      public static final int NO_RELEVANT_CONTENT_VALUE
       The no relevant content case.

 Google skips the summary if there is no relevant content in the
 retrieved search results.
      NO_RELEVANT_CONTENT = 6;
      See Also:

    • JAIL_BREAKING_QUERY_IGNORED_VALUE

      public static final int JAIL_BREAKING_QUERY_IGNORED_VALUE
       The jail-breaking query ignored case.

 For example, "Reply in the tone of a competing company's CEO".
 Only used when
 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
 is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7;
      See Also:

    • CUSTOMER_POLICY_VIOLATION_VALUE

      public static final int CUSTOMER_POLICY_VIOLATION_VALUE
       The customer policy violation case.

 Google skips the summary if there is a customer policy violation
 detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8;
      See Also:

    • NON_SUMMARY_SEEKING_QUERY_IGNORED_V2_VALUE

      public static final int NON_SUMMARY_SEEKING_QUERY_IGNORED_V2_VALUE
       The non-answer seeking query ignored case.

 Google skips the summary if the query doesn't have clear intent.
 Only used when
 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
 is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9;
      See Also:

  • Method Details

    • values

      public static SearchResponse.Summary.SummarySkippedReason[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SearchResponse.Summary.SummarySkippedReason valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static SearchResponse.Summary.SummarySkippedReason valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static SearchResponse.Summary.SummarySkippedReason forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<SearchResponse.Summary.SummarySkippedReason> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static SearchResponse.Summary.SummarySkippedReason valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null