View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummary (google_api_discovery_engine v0.27.0)

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

Attributes

safetyAttributes (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes.t, default: nil) - A collection of Safety Attribute categories and their associated confidence scores.
summarySkippedReasons (type: list(String.t), default: nil) - Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
summaryText (type: String.t, default: nil) - The summary content.
summaryWithMetadata (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata.t, default: nil) - Summary with metadata information.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummary{
    safetyAttributes:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes.t()
      | nil,
    summarySkippedReasons: [String.t()] | nil,
    summaryText: String.t() | nil,
    summaryWithMetadata:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata.t()
      | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.