Enum google_api_proto::google::cloud::discoveryengine::v1beta::search_response::summary::SummarySkippedReason

#[repr(i32)]
pub enum SummarySkippedReason {
    Unspecified = 0,
    AdversarialQueryIgnored = 1,
    NonSummarySeekingQueryIgnored = 2,
    OutOfDomainQueryIgnored = 3,
    PotentialPolicyViolation = 4,
    LlmAddonNotEnabled = 5,
    NoRelevantContent = 6,
    JailBreakingQueryIgnored = 7,
    CustomerPolicyViolation = 8,
}

An Enum for summary-skipped reasons.

Variants

Unspecified = 0

Default value. The summary skipped reason is not specified.

AdversarialQueryIgnored = 1

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.

NonSummarySeekingQueryIgnored = 2

The non-summary seeking query ignored case.

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.

OutOfDomainQueryIgnored = 3

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.

PotentialPolicyViolation = 4

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.

LlmAddonNotEnabled = 5

The LLM addon not enabled case.

Google skips the summary if the LLM addon is not enabled.

NoRelevantContent = 6

The no relevant content case.

Google skips the summary if there is no relevant content in the retrieved search results.

JailBreakingQueryIgnored = 7

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.

CustomerPolicyViolation = 8

The customer policy violation case.

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

Implementations

impl SummarySkippedReason

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of SummarySkippedReason.

pub fn from_i32(value: i32) -> Option<SummarySkippedReason>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a SummarySkippedReason, or None if value is not a valid variant.

impl SummarySkippedReason

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for SummarySkippedReason

fn clone(&self) -> SummarySkippedReason

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SummarySkippedReason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SummarySkippedReason

fn default() -> SummarySkippedReason

Returns the “default value” for a type.

impl From<SummarySkippedReason> for i32

fn from(value: SummarySkippedReason) -> i32

Converts to this type from the input type.

impl Hash for SummarySkippedReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SummarySkippedReason

fn cmp(&self, other: &SummarySkippedReason) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SummarySkippedReason

fn eq(&self, other: &SummarySkippedReason) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SummarySkippedReason

fn partial_cmp(&self, other: &SummarySkippedReason) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for SummarySkippedReason

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<SummarySkippedReason, UnknownEnumValue>

Performs the conversion.

impl Copy for SummarySkippedReason

impl Eq for SummarySkippedReason

impl StructuralPartialEq for SummarySkippedReason