Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummary

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchResponseSummary

Returns a new instance of GoogleCloudDiscoveryengineV1SearchResponseSummary.



4539
4540
4541
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4539

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#safety_attributes ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes

Safety Attribute categories and their associated confidence scores. Corresponds to the JSON property safetyAttributes

Returns:



4521
4522
4523
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4521

def safety_attributes
  @safety_attributes
end

#summary_skipped_reasons ⇒ Array<String>

Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. Corresponds to the JSON property summarySkippedReasons

Returns:

  • (Array<String>) 


4527
4528
4529
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4527

def summary_skipped_reasons
  @summary_skipped_reasons
end

#summary_text ⇒ String

The summary content. Corresponds to the JSON property summaryText

Returns:

  • (String) 


4532
4533
4534
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4532

def summary_text
  @summary_text
end

#summary_with_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata

Summary with metadata information. Corresponds to the JSON property summaryWithMetadata

Returns:



4537
4538
4539
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4537

def summary_with_metadata
  @summary_with_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4544
4545
4546
4547
4548
4549
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4544

def update!(**args)
  @safety_attributes = args[:safety_attributes] if args.key?(:safety_attributes)
  @summary_skipped_reasons = args[:summary_skipped_reasons] if args.key?(:summary_skipped_reasons)
  @summary_text = args[:summary_text] if args.key?(:summary_text)
  @summary_with_metadata = args[:summary_with_metadata] if args.key?(:summary_with_metadata)
end