Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SearchRequest.
Request message for SearchService.Search method.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__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 |
↳ branch |
string
The branch resource name, such as |
↳ query |
string
Raw search query. |
↳ image_query |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ImageQuery
Raw image query. |
↳ page_size |
int
Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default |
↳ 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 |
↳ 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 |
↳ one_box_page_size |
int
The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. |
↳ 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. |
↳ 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 |
↳ canonical_filter |
string
The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. |
↳ 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. |
↳ user_info |
Google\Cloud\DiscoveryEngine\V1\UserInfo
Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce |
↳ language_code |
string
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. |
↳ facet_specs |
array<Google\Cloud\DiscoveryEngine\V1\SearchRequest\FacetSpec>
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an |
↳ boost_spec |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec
Boost specification to boost certain documents. For more information on boosting, see Boosting |
↳ params |
array|Google\Protobuf\Internal\MapField
Additional search parameters. For public website search only, supported values are: * |
↳ query_expansion_spec |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\QueryExpansionSpec
The query expansion specification that specifies the conditions under which query expansion occurs. |
↳ spell_correction_spec |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SpellCorrectionSpec
The spell correction specification that specifies the mode under which spell correction takes 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 |
↳ content_search_spec |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec
A specification for configuring the behavior of content search. |
↳ safe_search |
bool
Whether to turn on safe search. This is only supported for website search. |
↳ 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. |
↳ search_as_you_type_spec |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SearchAsYouTypeSpec
Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. |
↳ session |
string
The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when |
↳ session_spec |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SessionSpec
Session specification. Can be used only when |
getServingConfig
Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config
,
or
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/engines/*/servingConfigs/default_serving_config
,
or
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 |
getImageQuery
Raw image query.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ImageQuery|null |
hasImageQuery
clearImageQuery
setImageQuery
Raw image query.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ImageQuery
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.
- Websites with basic indexing: Default
10
, Maximum25
. - Websites with advanced indexing: Default
25
, Maximum50
. - Other: Default
50
, Maximum100
. If this field is negative, anINVALID_ARGUMENT
is returned.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.
- Websites with basic indexing: Default
10
, Maximum25
. - Websites with advanced indexing: Default
25
, Maximum50
. - Other: Default
50
, Maximum100
. If this field is negative, anINVALID_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 |
getOneBoxPageSize
The maximum number of results to return for OneBox.
This applies to each OneBox type individually. Default number is 10.
Returns | |
---|---|
Type | Description |
int |
setOneBoxPageSize
The maximum number of results to return for OneBox.
This applies to each OneBox type individually. Default number is 10.
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 |
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.
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 customer 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.
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 customer 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 |
getCanonicalFilter
The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
Returns | |
---|---|
Type | Description |
string |
setCanonicalFilter
The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
Parameter | |
---|---|
Name | Description |
var |
string
|
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 the website search results, see
Order web search
results.
For more information on ordering the healthcare search results, see
Order healthcare search
results.
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 the website search results, see
Order web search
results.
For more information on ordering the healthcare search results, see
Order healthcare search
results.
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.
UserInfo.user_agent
is used to deduce device_type
for analytics.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\UserInfo|null |
hasUserInfo
clearUserInfo
setUserInfo
Information about the end user.
Highly recommended for analytics.
UserInfo.user_agent
is used to deduce device_type
for analytics.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\UserInfo
|
Returns | |
---|---|
Type | Description |
$this |
getLanguageCode
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
Returns | |
---|---|
Type | Description |
string |
setLanguageCode
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
Parameter | |
---|---|
Name | Description |
var |
string
|
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\V1\SearchRequest\FacetSpec>
|
Returns | |
---|---|
Type | Description |
$this |
getBoostSpec
Boost specification to boost certain documents.
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.
For more information on boosting, see Boosting
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\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. For example,user_country_code: "au"
For available codes see Country Codessearch_type
: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example,search_type: 1
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. For example,user_country_code: "au"
For available codes see Country Codessearch_type
: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example,search_type: 1
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 occurs.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\QueryExpansionSpec|null |
hasQueryExpansionSpec
clearQueryExpansionSpec
setQueryExpansionSpec
The query expansion specification that specifies the conditions under which query expansion occurs.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\QueryExpansionSpec
|
Returns | |
---|---|
Type | Description |
$this |
getSpellCorrectionSpec
The spell correction specification that specifies the mode under which spell correction takes effect.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SpellCorrectionSpec|null |
hasSpellCorrectionSpec
clearSpellCorrectionSpec
setSpellCorrectionSpec
The spell correction specification that specifies the mode under which spell correction takes effect.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\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
A specification for configuring the behavior of content search.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec|null |
hasContentSearchSpec
clearContentSearchSpec
setContentSearchSpec
A specification for configuring the behavior of content search.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec
|
Returns | |
---|---|
Type | Description |
$this |
getSafeSearch
Whether to turn on safe search. This is only supported for website search.
Returns | |
---|---|
Type | Description |
bool |
setSafeSearch
Whether to turn on safe search. This is only supported for website search.
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 |
getSearchAsYouTypeSpec
Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SearchAsYouTypeSpec|null |
hasSearchAsYouTypeSpec
clearSearchAsYouTypeSpec
setSearchAsYouTypeSpec
Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SearchAsYouTypeSpec
|
Returns | |
---|---|
Type | Description |
$this |
getSession
The session resource name. Optional.
Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls):
- Call /search API with the auto-session mode (see below).
- Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls):
- Call /search API with the auto-session mode (see below).
- Call /answer API with the session ID generated in the first call.
Here, the answer generation happens in the context of the search
results from the first search call.
Auto-session mode: when
projects/.../sessions/-
is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
Returns | |
---|---|
Type | Description |
string |
setSession
The session resource name. Optional.
Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls):
- Call /search API with the auto-session mode (see below).
- Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls):
- Call /search API with the auto-session mode (see below).
- Call /answer API with the session ID generated in the first call.
Here, the answer generation happens in the context of the search
results from the first search call.
Auto-session mode: when
projects/.../sessions/-
is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSessionSpec
Session specification.
Can be used only when session
is set.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SessionSpec|null |
hasSessionSpec
clearSessionSpec
setSessionSpec
Session specification.
Can be used only when session
is set.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\SessionSpec
|
Returns | |
---|---|
Type | Description |
$this |