Class ConversationalSearchResponse (2.5.0) 

ConversationalSearchResponse(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Response message for ConversationalSearchService.ConversationalSearch method.

Attributes
Name Description
user_query_types MutableSequence[str]
The types Retail classifies the search query as. Supported values are: - "ADVERSARIAL" - "CHITCHAT" - "JAILBREAK" - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" clang-format off clang-format on
conversational_text_response str
The conversational answer-based text response generated by the Server.
followup_question google.cloud.retail_v2alpha.types.ConversationalSearchResponse.FollowupQuestion
The conversational followup question generated for Intent refinement.
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 ConversationalSearchRequest.conversation_id to restore conversation state in server.
refined_search MutableSequence[google.cloud.retail_v2alpha.types.ConversationalSearchResponse.RefinedSearch]
The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
conversational_filtering_result google.cloud.retail_v2alpha.types.ConversationalSearchResponse.ConversationalFilteringResult
This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
state google.cloud.retail_v2alpha.types.ConversationalSearchResponse.State
Output only. The state of the response generation.

Classes

ConversationalFilteringResult

ConversationalFilteringResult(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

FollowupQuestion

FollowupQuestion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The conversational followup question generated for Intent refinement.

RefinedSearch

RefinedSearch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

State

State(value)

The state of the response generation.