ConversationalSearchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for ConversationalSearchService.ConversationalSearch method.
Attributes |
|
|---|---|
| Name | Description |
placement |
str
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 |
str
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 |
str
Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request. |
page_categories |
MutableSequence[str]
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 |
str
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 |
google.cloud.retail_v2alpha.types.ConversationalSearchRequest.SearchParams
Optional. Search parameters. |
visitor_id |
str
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 |
google.cloud.retail_v2alpha.types.UserInfo
Optional. User information. |
conversational_filtering_spec |
google.cloud.retail_v2alpha.types.ConversationalSearchRequest.ConversationalFilteringSpec
Optional. This field specifies all conversational filtering related parameters. |
Classes
ConversationalFilteringSpec
ConversationalFilteringSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)This field specifies all conversational filtering related parameters addition to conversational retail search.
SearchParams
SearchParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)Search parameters.
UserAnswer
UserAnswer(mapping=None, *, ignore_unknown_fields=False, **kwargs)This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields