Class Summary (0.12.2)

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

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

Attributes
Name	Description
`summary_text`	`str` The summary content.
`summary_skipped_reasons`	`MutableSequence[google.cloud.discoveryengine_v1.types.SearchResponse.Summary.SummarySkippedReason]` Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
`safety_attributes`	`google.cloud.discoveryengine_v1.types.SearchResponse.Summary.SafetyAttributes` A collection of Safety Attribute categories and their associated confidence scores.
`summary_with_metadata`	`google.cloud.discoveryengine_v1.types.SearchResponse.Summary.SummaryWithMetadata` Summary with metadata information.

Classes

Citation

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

Citation info for a segment.

CitationMetadata

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

Citation metadata.

CitationSource

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

Citation source.

Reference

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

Document reference.

SafetyAttributes

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

Safety Attribute categories and their associated confidence scores.

SummarySkippedReason

SummarySkippedReason(value)

An Enum for summary-skipped reasons.

    Only used when
    <xref uid="google.cloud.discoveryengine.v1.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 used when
    <xref uid="google.cloud.discoveryengine.v1.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.
POTENTIAL_POLICY_VIOLATION (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.
LLM_ADDON_NOT_ENABLED (5):
    The LLM addon not enabled case.

    Google skips the summary if the LLM addon is not
    enabled.
NO_RELEVANT_CONTENT (6):
    The no relevant content case.

    Google skips the summary if there is no relevant
    content in the retrieved search results.
JAIL_BREAKING_QUERY_IGNORED (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`.
CUSTOMER_POLICY_VIOLATION (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.

SummaryWithMetadata

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

Summary with metadata information.