Google Cloud Discovery Engine V1beta Client - Class Summary (0.7.1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class Summary.

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

Generated from protobuf message google.cloud.discoveryengine.v1beta.SearchResponse.Summary

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ SearchResponse

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ summary_text string

The summary content.

↳ summary_skipped_reasons array

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\V1beta\SearchResponse\Summary\SafetyAttributes

A collection of Safety Attribute categories and their associated confidence scores.

getSummaryText

The summary content.

Returns
TypeDescription
string

setSummaryText

The summary content.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSummarySkippedReasons

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSummarySkippedReasons

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

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getSafetyAttributes

A collection of Safety Attribute categories and their associated confidence scores.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1beta\SearchResponse\Summary\SafetyAttributes|null

hasSafetyAttributes

clearSafetyAttributes

setSafetyAttributes

A collection of Safety Attribute categories and their associated confidence scores.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1beta\SearchResponse\Summary\SafetyAttributes
Returns
TypeDescription
$this