Google Cloud Discovery Engine V1 Client - Class Summary (1.4.0)

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

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

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchResponse

Methods

__construct

Constructor.

Parameters
Name
Description
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
Summary\SafetyAttributes

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

↳ summary_with_metadata
Summary\SummaryWithMetadata

Summary with metadata information.

getSummaryText

The summary content.

Returns
Type
Description
string

setSummaryText

The summary content.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSummarySkippedReasons

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

Returns
Type
Description

setSummarySkippedReasons

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

Parameter
Name
Description
var
int[]
Returns
Type
Description
$this

getSafetyAttributes

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

Returns
Type
Description

hasSafetyAttributes

clearSafetyAttributes

setSafetyAttributes

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

Parameter
Name
Description
Returns
Type
Description
$this

Summary with metadata information.

Returns
Type
Description

Summary with metadata information.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: