Reference documentation and code samples for the Google Cloud Retail V2 Client class SearchParams.
Search parameters.
Generated from protobuf message google.cloud.retail.v2.ConversationalSearchRequest.SearchParams
Namespace
Google \ Cloud \ Retail \ V2 \ ConversationalSearchRequestMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ filter |
string
Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter. |
↳ canonical_filter |
string
Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter. |
↳ sort_by |
string
Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort. |
↳ boost_spec |
Google\Cloud\Retail\V2\SearchRequest\BoostSpec
Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec. |
getFilter
Optional. The filter string to restrict search results.
The syntax of the filter string is the same as SearchRequest.filter.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. The filter string to restrict search results.
The syntax of the filter string is the same as SearchRequest.filter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCanonicalFilter
Optional. The canonical filter string to restrict search results.
The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCanonicalFilter
Optional. The canonical filter string to restrict search results.
The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSortBy
Optional. The sort string to specify the sorting of search results.
The syntax of the sort string is the same as SearchRequest.sort.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSortBy
Optional. The sort string to specify the sorting of search results.
The syntax of the sort string is the same as SearchRequest.sort.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoostSpec
Optional. The boost spec to specify the boosting of search results.
The syntax of the boost spec is the same as SearchRequest.boost_spec.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\SearchRequest\BoostSpec|null |
|
hasBoostSpec
clearBoostSpec
setBoostSpec
Optional. The boost spec to specify the boosting of search results.
The syntax of the boost spec is the same as SearchRequest.boost_spec.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\SearchRequest\BoostSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|