Google Cloud Retail V2 Client - Class QueryExpansionInfo (1.5.0)

Version 1.5.0

• 2.1.0 (latest)
• 2.0.0
• 1.7.0
• 1.6.4
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 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

Namespace

Google \ Cloud \ Retail \ V2 \ SearchResponse

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.

Returns
Type	Description
bool

setExpandedQuery

Bool describing whether query expansion has occurred.

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.

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.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this