Class Summary (0.10.0)

Summary(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Summary of the top N search result specified by the summary spec.

Attributes
Name	Description
`summary_text`	`str` The summary content.
`summary_skipped_reasons`	`MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchResponse.Summary.SummarySkippedReason]` Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

Classes

SummarySkippedReason

SummarySkippedReason(value)

An Enum for summary-skipped reasons.

Values: SUMMARY_SKIPPED_REASON_UNSPECIFIED (0): Default value. The summary skipped reason is not specified. ADVERSARIAL_QUERY_IGNORED (1): The adversarial query ignored case.

    Only populated when
    <xref uid="google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query">SummarySpec.ignore_adversarial_query</xref>
    is set to `true`.
NON_SUMMARY_SEEKING_QUERY_IGNORED (2):
    The non-summary seeking query ignored case.

    Only populated when
    <xref uid="google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query">SummarySpec.ignore_non_summary_seeking_query</xref>
    is set to `true`.
OUT_OF_DOMAIN_QUERY_IGNORED (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.

Class Summary (0.10.0)

Attributes

Classes

SummarySkippedReason