Reference documentation and code samples for the Google Cloud Retail V2 Client class ConversationalSearchRequest.
Request message for ConversationalSearchService.ConversationalSearch method.
Generated from protobuf message google.cloud.retail.v2.ConversationalSearchRequest
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ placement
string
Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search
or projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set of models that will be used to make the search.
↳ branch
string
Required. The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0
. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
↳ query
string
Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.
↳ page_categories
array
Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories ; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
↳ conversation_id
string
Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id . For the initial request, this should be empty.
↳ search_params
↳ visitor_id
string
Required. 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 should be the same identifier as UserEvent.visitor_id . The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
↳ user_info
↳ conversational_filtering_spec
ConversationalSearchRequest\ConversationalFilteringSpec
Optional. This field specifies all conversational filtering related parameters.
↳ user_labels
array| Google\Protobuf\Internal\MapField
Optional. 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.
↳ safety_settings
getPlacement
Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search
or projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set
of models that will be used to make the search.
string
setPlacement
Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search
or projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set
of models that will be used to make the search.
var
string
$this
getBranch
Required. The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0
.
Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
string
setBranch
Required. The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0
.
Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
var
string
$this
getQuery
Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
string
setQuery
Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
var
string
$this
getPageCategories
Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories ; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
setPageCategories
Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories ; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
var
string[]
$this
getConversationId
Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id .
For the initial request, this should be empty.
string
setConversationId
Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id .
For the initial request, this should be empty.
var
string
$this
getSearchParams
Optional. Search parameters.
hasSearchParams
clearSearchParams
setSearchParams
Optional. Search parameters.
$this
getVisitorId
Required. 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 should be the same identifier as UserEvent.visitor_id . The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string
setVisitorId
Required. 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 should be the same identifier as UserEvent.visitor_id . The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
var
string
$this
getUserInfo
Optional. User information.
hasUserInfo
clearUserInfo
setUserInfo
Optional. User information.
$this
getConversationalFilteringSpec
Optional. This field specifies all conversational filtering related parameters.
hasConversationalFilteringSpec
clearConversationalFilteringSpec
setConversationalFilteringSpec
Optional. This field specifies all conversational filtering related parameters.
$this
getUserLabels
Optional. 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.
setUserLabels
Optional. 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.
$this
getSafetySettings
Optional. The safety settings to be applied to the generated content.
setSafetySettings
Optional. The safety settings to be applied to the generated content.
$this
