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.
| Parameter | |
|---|---|
| Name | Description |
data |
mixed
|
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuery
Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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"].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
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"].
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchParams
Optional. Search parameters.
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest\SearchParams|null |
|
hasSearchParams
clearSearchParams
setSearchParams
Optional. Search parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
ConversationalSearchRequest\SearchParams
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserInfo
Optional. User information.
| Returns | |
|---|---|
| Type | Description |
UserInfo|null |
|
hasUserInfo
clearUserInfo
setUserInfo
Optional. User information.
| Parameter | |
|---|---|
| Name | Description |
var |
UserInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConversationalFilteringSpec
Optional. This field specifies all conversational filtering related parameters.
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest\ConversationalFilteringSpec|null |
|
hasConversationalFilteringSpec
clearConversationalFilteringSpec
setConversationalFilteringSpec
Optional. This field specifies all conversational filtering related parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
ConversationalSearchRequest\ConversationalFilteringSpec
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSafetySettings
Optional. The safety settings to be applied to the generated content.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<SafetySetting> |
|
setSafetySettings
Optional. The safety settings to be applied to the generated content.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SafetySetting>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|