Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SummaryWithMetadata.
Summary with metadata information.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ SearchResponse \ SummaryMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ summary |
string
Summary text with no citation information. |
↳ citation_metadata |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\CitationMetadata
Citation metadata for given summary. |
↳ references |
array<Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\Reference>
Document References. |
getSummary
Summary text with no citation information.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSummary
Summary text with no citation information.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCitationMetadata
Citation metadata for given summary.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\CitationMetadata|null |
|
hasCitationMetadata
clearCitationMetadata
setCitationMetadata
Citation metadata for given summary.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\CitationMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReferences
Document References.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setReferences
Document References.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\Reference>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|