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

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

Response message for CompletionService.AdvancedCompleteQuery method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ query_suggestions array<AdvancedCompleteQueryResponse\QuerySuggestion>

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

↳ tail_match_triggered bool

True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

↳ people_suggestions array<AdvancedCompleteQueryResponse\PersonSuggestion>

Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.

↳ content_suggestions array<AdvancedCompleteQueryResponse\ContentSuggestion>

Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.

↳ recent_search_suggestions array<AdvancedCompleteQueryResponse\RecentSearchSuggestion>

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

getQuerySuggestions

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

Returns
Type Description
Google\Protobuf\RepeatedField<AdvancedCompleteQueryResponse\QuerySuggestion>

setQuerySuggestions

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

Parameter
Name Description
var array<AdvancedCompleteQueryResponse\QuerySuggestion>
Returns
Type Description
$this

getTailMatchTriggered

True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

Returns
Type Description
bool

setTailMatchTriggered

True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

Parameter
Name Description
var bool
Returns
Type Description
$this

getPeopleSuggestions

Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.

Returns
Type Description
Google\Protobuf\RepeatedField<AdvancedCompleteQueryResponse\PersonSuggestion>

setPeopleSuggestions

Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.

Parameter
Name Description
var array<AdvancedCompleteQueryResponse\PersonSuggestion>
Returns
Type Description
$this

getContentSuggestions

Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.

Returns
Type Description
Google\Protobuf\RepeatedField<AdvancedCompleteQueryResponse\ContentSuggestion>

setContentSuggestions

Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.

Parameter
Name Description
var array<AdvancedCompleteQueryResponse\ContentSuggestion>
Returns
Type Description
$this

getRecentSearchSuggestions

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

Returns
Type Description
Google\Protobuf\RepeatedField<AdvancedCompleteQueryResponse\RecentSearchSuggestion>

setRecentSearchSuggestions

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

Parameter
Name Description
var array<AdvancedCompleteQueryResponse\RecentSearchSuggestion>
Returns
Type Description
$this