Google Cloud Discovery Engine V1beta Client - Class SearchRequest (0.4.0)

Version 0.4.0

• 1.3.2 (latest)
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class SearchRequest.

Request message for SearchService.Search method.

Generated from protobuf message google.cloud.discoveryengine.v1beta.SearchRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ serving_config	string Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.
↳ branch	string The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0. Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.
↳ query	string Raw search query.
↳ page_size	int Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 will be coerced to 100. If this field is negative, an INVALID_ARGUMENT is returned.
↳ page_token	string A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
↳ offset	int A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an INVALID_ARGUMENT is returned.
↳ 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. If this field is unrecognizable, an INVALID_ARGUMENT is returned.
↳ order_by	string The order in which documents are returned. Document can be ordered by a field in an Document object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. If this field is unrecognizable, an INVALID_ARGUMENT is returned.
↳ user_info	Google\Cloud\DiscoveryEngine\V1beta\UserInfo Information about the end user. Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.
↳ facet_specs	array<Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\FacetSpec> Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
↳ boost_spec	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\BoostSpec Boost specification to boost certain documents.
↳ params	array|Google\Protobuf\Internal\MapField Additional search parameters. For public website search only, supported values are: * user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
↳ query_expansion_spec	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\QueryExpansionSpec The query expansion specification that specifies the conditions under which query expansion will occur.
↳ spell_correction_spec	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\SpellCorrectionSpec The spell correction specification that specifies the mode under which spell correction will take effect.
↳ user_pseudo_id	string A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as unknown_visitor. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
↳ content_search_spec	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\ContentSearchSpec The content search spec that configs the desired behavior of content search.
↳ safe_search	bool Whether to turn on safe search. This is only supported for ContentConfig.PUBLIC_WEBSITE.
↳ user_labels	array|Google\Protobuf\Internal\MapField The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.

getServingConfig

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config.

This field is used to identify the serving configuration name, set of models used to make the search.

Returns
Type	Description
string

setServingConfig

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config.

This field is used to identify the serving configuration name, set of models used to make the search.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBranch

The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

Returns
Type	Description
string

setBranch

The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getQuery

Raw search query.

Returns
Type	Description
string

setQuery

Raw search query.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 will be coerced to 100.

If this field is negative, an INVALID_ARGUMENT is returned.

Returns
Type	Description
int

setPageSize

Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 will be coerced to 100.

If this field is negative, an INVALID_ARGUMENT is returned.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type	Description
string

setPageToken

A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOffset

A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

If this field is negative, an INVALID_ARGUMENT is returned.

Returns
Type	Description
int

setOffset

A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

If this field is negative, an INVALID_ARGUMENT is returned.

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.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

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.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

The order in which documents are returned. Document can be ordered by a field in an Document object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Returns
Type	Description
string

setOrderBy

The order in which documents are returned. Document can be ordered by a field in an Document object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUserInfo

Information about the end user.

Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\UserInfo|null

hasUserInfo

clearUserInfo

setUserInfo

Information about the end user.

Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\UserInfo

Returns
Type	Description
$this

getFacetSpecs

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setFacetSpecs

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name	Description
var	array<Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\FacetSpec>

Returns
Type	Description
$this

getBoostSpec

Boost specification to boost certain documents.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\BoostSpec|null

hasBoostSpec

clearBoostSpec

setBoostSpec

Boost specification to boost certain documents.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\BoostSpec

Returns
Type	Description
$this

getParams

Additional search parameters.

For public website search only, supported values are:

• user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.
• search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setParams

Additional search parameters.

For public website search only, supported values are:

• user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.
• search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getQueryExpansionSpec

The query expansion specification that specifies the conditions under which query expansion will occur.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\QueryExpansionSpec|null

hasQueryExpansionSpec

clearQueryExpansionSpec

setQueryExpansionSpec

The query expansion specification that specifies the conditions under which query expansion will occur.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\QueryExpansionSpec

Returns
Type	Description
$this

getSpellCorrectionSpec

The spell correction specification that specifies the mode under which spell correction will take effect.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\SpellCorrectionSpec|null

hasSpellCorrectionSpec

clearSpellCorrectionSpec

setSpellCorrectionSpec

The spell correction specification that specifies the mode under which spell correction will take effect.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\SpellCorrectionSpec

Returns
Type	Description
$this

getUserPseudoId

A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as unknown_visitor. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type	Description
string

setUserPseudoId

A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as unknown_visitor. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getContentSearchSpec

The content search spec that configs the desired behavior of content search.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\ContentSearchSpec|null

hasContentSearchSpec

clearContentSearchSpec

setContentSearchSpec

The content search spec that configs the desired behavior of content search.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\ContentSearchSpec

Returns
Type	Description
$this

getSafeSearch

Whether to turn on safe search. This is only supported for ContentConfig.PUBLIC_WEBSITE.

Returns
Type	Description
bool

setSafeSearch

Whether to turn on safe search. This is only supported for ContentConfig.PUBLIC_WEBSITE.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getUserLabels

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.

• Each label must be a key-value pair.

• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.
• Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setUserLabels

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.

• Each label must be a key-value pair.

• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.
• Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this