Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class SearchParams.
Search parameters.
Generated from protobuf message google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec.SearchParams
Namespace
Google \ Cloud \ DiscoveryEngine \ V1beta \ AnswerQueryRequest \ SearchSpecMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ max_return_results |
int
Number of search results to return. The default value is 10. |
↳ filter |
string
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an |
↳ boost_spec |
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\BoostSpec
Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting |
↳ order_by |
string
The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. |
getMaxReturnResults
Number of search results to return.
The default value is 10.
Returns | |
---|---|
Type | Description |
int |
setMaxReturnResults
Number of search results to return.
The default value is 10.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
Filter expression is case-sensitive. This will be used to filter
search results which may affect the Answer response.
If this field is unrecognizable, an INVALID_ARGUMENT
is returned.
Filtering in Vertex AI Search is done by mapping the LHS filter key
to a key property defined in the Vertex AI Search backend -- this
mapping is defined by the customer in their schema. For example a
media customers might have a field 'name' in their schema. In this
case the filter would look like this: filter --> name:'ANY("king
kong")'
For more information about filtering including syntax and filter
operators, see
Filter
Returns | |
---|---|
Type | Description |
string |
setFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
Filter expression is case-sensitive. This will be used to filter
search results which may affect the Answer response.
If this field is unrecognizable, an INVALID_ARGUMENT
is returned.
Filtering in Vertex AI Search is done by mapping the LHS filter key
to a key property defined in the Vertex AI Search backend -- this
mapping is defined by the customer in their schema. For example a
media customers might have a field 'name' in their schema. In this
case the filter would look like this: filter --> name:'ANY("king
kong")'
For more information about filtering including syntax and filter
operators, see
Filter
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getBoostSpec
Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\BoostSpec|null |
hasBoostSpec
clearBoostSpec
setBoostSpec
Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\BoostSpec
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
The order in which documents are returned. Documents can be ordered
by a field in an
Document object. Leave
it unset if ordered by relevance. order_by
expression is
case-sensitive. For more information on ordering, see
Ordering
If this field is unrecognizable, an INVALID_ARGUMENT
is returned.
Returns | |
---|---|
Type | Description |
string |
setOrderBy
The order in which documents are returned. Documents can be ordered
by a field in an
Document object. Leave
it unset if ordered by relevance. order_by
expression is
case-sensitive. For more information on ordering, see
Ordering
If this field is unrecognizable, an INVALID_ARGUMENT
is returned.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |