Google Cloud Discovery Engine V1 Client - Class SearchParams (1.0.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SearchParams.

Search parameters.

Generated from protobuf message google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchParams

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ AnswerQueryRequest \ SearchSpec

Methods

__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 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
↳ boost_spec Google\Cloud\DiscoveryEngine\V1\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. order_by expression is case-sensitive. For more information on ordering, see Ordering If this field is unrecognizable, an INVALID_ARGUMENT is returned.
↳ search_result_mode int

Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to CHUNKS. * Otherwise, it defaults to DOCUMENTS. See parse and chunk documents
↳ data_store_specs array<Google\Cloud\DiscoveryEngine\V1\SearchRequest\DataStoreSpec>

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

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\V1\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\V1\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

getSearchResultMode

Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config:

  • If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to CHUNKS.

  • Otherwise, it defaults to DOCUMENTS. See parse and chunk documents

Returns
Type Description
int

setSearchResultMode

Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config:

  • If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to CHUNKS.

  • Otherwise, it defaults to DOCUMENTS. See parse and chunk documents

Parameter
Name Description
var int
Returns
Type Description
$this

getDataStoreSpecs

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDataStoreSpecs

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\SearchRequest\DataStoreSpec>
Returns
Type Description
$this