Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PersonSuggestion.
Suggestions as people.
Generated from protobuf message google.cloud.discoveryengine.v1.AdvancedCompleteQueryResponse.PersonSuggestion
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ AdvancedCompleteQueryResponseMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ suggestion |
string
The suggestion for the query. |
↳ person_type |
int
The type of the person. |
↳ document |
Google\Cloud\DiscoveryEngine\V1\Document
The document data snippet in the suggestion. Only a subset of fields is 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]. |
↳ display_photo_uri |
string
The photo uri of the person suggestion. |
↳ destination_uri |
string
The destination uri of the person 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 |
|
getPersonType
The type of the person.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type PersonType. |
setPersonType
The type of the person.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type PersonType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocument
The document data snippet in the suggestion. Only a subset of fields is 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 is 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 |
|
getDisplayPhotoUri
The photo uri of the person suggestion.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayPhotoUri
The photo uri of the person suggestion.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestinationUri
The destination uri of the person suggestion.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDestinationUri
The destination uri of the person suggestion.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|