ConversationalSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
Attributes |
|
|---|---|
| Name | Description |
conversation_id |
str
Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server. |
refined_query |
str
The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is dress and next
SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer
is red color, which does not match any product attribute
value filters, the refined query will be
dress, red color.
|
additional_filters |
MutableSequence[google.cloud.retail_v2.types.SearchResponse.ConversationalSearchResult.AdditionalFilter]
This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.
|
followup_question |
str
The follow-up question. e.g., What is the color?
|
suggested_answers |
MutableSequence[google.cloud.retail_v2.types.SearchResponse.ConversationalSearchResult.SuggestedAnswer]
The answer options provided to client for the follow-up question. |
additional_filter |
google.cloud.retail_v2.types.SearchResponse.ConversationalSearchResult.AdditionalFilter
This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request. |
Classes
AdditionalFilter
AdditionalFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)Additional filter that client side need to apply.
SuggestedAnswer
SuggestedAnswer(mapping=None, *, ignore_unknown_fields=False, **kwargs)Suggested answers to the follow-up question.