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 \ SearchResponseMethods
__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 |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\SafetyAttributes
A collection of Safety Attribute categories and their associated confidence scores. |
↳ summary_with_metadata |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\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 |
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 | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSafetyAttributes
A collection of Safety Attribute categories and their associated confidence scores.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\SafetyAttributes|null |
|
hasSafetyAttributes
clearSafetyAttributes
setSafetyAttributes
A collection of Safety Attribute categories and their associated confidence scores.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\SafetyAttributes
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSummaryWithMetadata
Summary with metadata information.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\SummaryWithMetadata|null |
|
hasSummaryWithMetadata
clearSummaryWithMetadata
setSummaryWithMetadata
Summary with metadata information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\SummaryWithMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|