Google Cloud Discovery Engine V1 Client - Class ContentSuggestion (1.17.0)

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

Suggestions as content.

Generated from protobuf message google.cloud.discoveryengine.v1.AdvancedCompleteQueryResponse.ContentSuggestion

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ AdvancedCompleteQueryResponse

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ suggestion string

The suggestion for the query.

↳ content_type int

The type of the content suggestion.

↳ document Google\Cloud\DiscoveryEngine\V1\Document

The document data snippet in the suggestion. Only a subset of fields will be populated.

↳ data_store string

The name of the dataStore that this suggestion belongs to.

↳ score float

The score of each suggestion. The score is in the range of [0, 1].

↳ icon_uri string

The icon uri of the content suggestion.

↳ destination_uri string

The destination uri of the content suggestion.

getSuggestion

The suggestion for the query.

Returns
Type Description
string

setSuggestion

The suggestion for the query.

Parameter
Name Description
var string
Returns
Type Description
$this

getContentType

The type of the content suggestion.

Returns
Type Description
int Enum of type ContentType.

setContentType

The type of the content suggestion.

Parameter
Name Description
var int

Enum of type ContentType.

Returns
Type Description
$this

getDocument

The document data snippet in the suggestion. Only a subset of fields will be populated.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\Document|null

hasDocument

clearDocument

setDocument

The document data snippet in the suggestion. Only a subset of fields will be populated.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\Document
Returns
Type Description
$this

getDataStore

The name of the dataStore that this suggestion belongs to.

Returns
Type Description
string

setDataStore

The name of the dataStore that this suggestion belongs to.

Parameter
Name Description
var string
Returns
Type Description
$this

getScore

The score of each suggestion. The score is in the range of [0, 1].

Returns
Type Description
float

setScore

The score of each suggestion. The score is in the range of [0, 1].

Parameter
Name Description
var float
Returns
Type Description
$this

getIconUri

The icon uri of the content suggestion.

Returns
Type Description
string

setIconUri

The icon uri of the content suggestion.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationUri

The destination uri of the content suggestion.

Returns
Type Description
string

setDestinationUri

The destination uri of the content suggestion.

Parameter
Name Description
var string
Returns
Type Description
$this