Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary (v1.3.0)

Version 1.3.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#safety_attributes

def safety_attributes() -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes) — A collection of Safety Attribute categories and their associated confidence scores.

#safety_attributes=

def safety_attributes=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes) — A collection of Safety Attribute categories and their associated confidence scores.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes) — A collection of Safety Attribute categories and their associated confidence scores.

#summary_skipped_reasons

def summary_skipped_reasons() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummarySkippedReason>

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummarySkippedReason>) — Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

#summary_skipped_reasons=

def summary_skipped_reasons=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummarySkippedReason>

Parameter

• value (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummarySkippedReason>) — Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummarySkippedReason>) — Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

#summary_text

def summary_text() -> ::String

Returns

• (::String) — The summary content.

#summary_text=

def summary_text=(value) -> ::String

Parameter

• value (::String) — The summary content.

Returns

• (::String) — The summary content.

#summary_with_metadata

def summary_with_metadata() -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummaryWithMetadata

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummaryWithMetadata) — Summary with metadata information.

#summary_with_metadata=

def summary_with_metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummaryWithMetadata

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummaryWithMetadata) — Summary with metadata information.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummaryWithMetadata) — Summary with metadata information.