Reference documentation and code samples for the Google Cloud Retail V2 Client class QueryExpansionSpec.
Specification to determine under which conditions query expansion should occur.
Generated from protobuf message google.cloud.retail.v2.SearchRequest.QueryExpansionSpec
Namespace
Google \ Cloud \ Retail \ V2 \ SearchRequestMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ condition |
int
The condition under which query expansion should occur. Default to Condition.DISABLED. |
↳ pin_unexpanded_results |
bool
Whether to pin unexpanded results. The default value is false. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. |
getCondition
The condition under which query expansion should occur. Default to Condition.DISABLED.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Condition. |
setCondition
The condition under which query expansion should occur. Default to Condition.DISABLED.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Condition. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPinUnexpandedResults
Whether to pin unexpanded results. The default value is false. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setPinUnexpandedResults
Whether to pin unexpanded results. The default value is false. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|