Google Cloud Retail V2 Client - Class QueryExpansionInfo (1.0.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class QueryExpansionInfo.

Information describing query expansion including whether expansion has occurred.

Generated from protobuf message google.cloud.retail.v2.SearchResponse.QueryExpansionInfo

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ expanded_query
bool

Bool describing whether query expansion has occurred.

↳ pinned_result_count
int|string

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

getExpandedQuery

Bool describing whether query expansion has occurred.

Generated from protobuf field bool expanded_query = 1;

Returns
Type
Description
bool

setExpandedQuery

Bool describing whether query expansion has occurred.

Generated from protobuf field bool expanded_query = 1;

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getPinnedResultCount

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

Generated from protobuf field int64 pinned_result_count = 2;

Returns
Type
Description
int|string

setPinnedResultCount

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

Generated from protobuf field int64 pinned_result_count = 2;

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: