Package com.google.cloud.discoveryengine.v1

Enum SearchResponse.Summary.SummarySkippedReason

    • Enum Constant Detail

      • 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 populated when
 [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1.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.

 Only populated when
 [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1.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;

    • Field Detail

      • 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:
        Constant Field Values

      • ADVERSARIAL_QUERY_IGNORED_VALUE

        public static final int ADVERSARIAL_QUERY_IGNORED_VALUE
         The adversarial query ignored case.

 Only populated when
 [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query]
 is set to `true`.
        ADVERSARIAL_QUERY_IGNORED = 1;
        See Also:
        Constant Field Values

      • NON_SUMMARY_SEEKING_QUERY_IGNORED_VALUE

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

 Only populated when
 [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query]
 is set to `true`.
        NON_SUMMARY_SEEKING_QUERY_IGNORED = 2;
        See Also:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

    • Method Detail

      • values

        public static SearchResponse.Summary.SummarySkippedReason[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SearchResponse.Summary.SummarySkippedReason c : SearchResponse.Summary.SummarySkippedReason.values())
    System.out.println(c);
        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.

      • 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 final 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