Class ConversationalSearchResponse (2.1.0)

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

Response message for ConversationalSearchService.ConversationalSearch method.

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 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.

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.