Google Cloud Discovery Engine V1 Client - Class SummarySkippedReason (1.3.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SummarySkippedReason.

An Enum for summary-skipped reasons.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchResponse \ Summary

Methods

static::name

Parameter
Name	Description
`value`	`mixed`

static::value

Parameter
Name	Description
`name`	`mixed`

Constants

SUMMARY_SKIPPED_REASON_UNSPECIFIED

Value: 0

Default value. The summary skipped reason is not specified.

Generated from protobuf enum SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0;

ADVERSARIAL_QUERY_IGNORED

Value: 1

The adversarial query ignored case.

Only used when SummarySpec.ignore_adversarial_query is set to true.

Generated from protobuf enum ADVERSARIAL_QUERY_IGNORED = 1;

NON_SUMMARY_SEEKING_QUERY_IGNORED

Value: 2

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 is set to true.

Generated from protobuf enum NON_SUMMARY_SEEKING_QUERY_IGNORED = 2;

OUT_OF_DOMAIN_QUERY_IGNORED

Value: 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.

Generated from protobuf enum OUT_OF_DOMAIN_QUERY_IGNORED = 3;

POTENTIAL_POLICY_VIOLATION

Value: 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.

Generated from protobuf enum POTENTIAL_POLICY_VIOLATION = 4;

LLM_ADDON_NOT_ENABLED

Value: 5

The LLM addon not enabled case.

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

Generated from protobuf enum LLM_ADDON_NOT_ENABLED = 5;

NO_RELEVANT_CONTENT

Value: 6

The no relevant content case.

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

Generated from protobuf enum NO_RELEVANT_CONTENT = 6;

JAIL_BREAKING_QUERY_IGNORED

Value: 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.

Generated from protobuf enum JAIL_BREAKING_QUERY_IGNORED = 7;

CUSTOMER_POLICY_VIOLATION

Value: 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.

Generated from protobuf enum CUSTOMER_POLICY_VIOLATION = 8;

NON_SUMMARY_SEEKING_QUERY_IGNORED_V2

Value: 9

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.

Generated from protobuf enum NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9;