Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ConversationalSearchResponse.
Response message for ConversationalSearchService.ConversationalSearch method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#conversation_id
def conversation_id() -> ::String
Returns
- (::String) — 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.
#conversation_id=
def conversation_id=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.
#conversational_filtering_result
def conversational_filtering_result() -> ::Google::Cloud::Retail::V2::ConversationalSearchResponse::ConversationalFilteringResult
Returns
- (::Google::Cloud::Retail::V2::ConversationalSearchResponse::ConversationalFilteringResult) — This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
#conversational_filtering_result=
def conversational_filtering_result=(value) -> ::Google::Cloud::Retail::V2::ConversationalSearchResponse::ConversationalFilteringResult
Parameter
- value (::Google::Cloud::Retail::V2::ConversationalSearchResponse::ConversationalFilteringResult) — This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
Returns
- (::Google::Cloud::Retail::V2::ConversationalSearchResponse::ConversationalFilteringResult) — This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
#conversational_text_response
def conversational_text_response() -> ::String
Returns
- (::String) — The conversational answer-based text response generated by the Server.
#conversational_text_response=
def conversational_text_response=(value) -> ::String
Parameter
- value (::String) — The conversational answer-based text response generated by the Server.
Returns
- (::String) — The conversational answer-based text response generated by the Server.
#followup_question
def followup_question() -> ::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion
Returns
- (::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion) — The conversational followup question generated for Intent refinement.
#followup_question=
def followup_question=(value) -> ::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion
Parameter
- value (::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion) — The conversational followup question generated for Intent refinement.
Returns
- (::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion) — The conversational followup question generated for Intent refinement.
#refined_search
def refined_search() -> ::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::RefinedSearch>
Returns
- (::Array<::Google::Cloud::Retail::V2::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.
#refined_search=
def refined_search=(value) -> ::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::RefinedSearch>
Parameter
- value (::Array<::Google::Cloud::Retail::V2::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.
Returns
- (::Array<::Google::Cloud::Retail::V2::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.
#state
def state() -> ::Google::Cloud::Retail::V2::ConversationalSearchResponse::State
Returns
- (::Google::Cloud::Retail::V2::ConversationalSearchResponse::State) — Output only. The state of the response generation.
#user_query_types
def user_query_types() -> ::Array<::String>
Returns
-
(::Array<::String>) —
The types Retail classifies the search query as.
Supported values are:
- "ORDER_SUPPORT"
- "SIMPLE_PRODUCT_SEARCH"
- "INTENT_REFINEMENT"
- "PRODUCT_DETAILS"
- "PRODUCT_COMPARISON"
- "DEALS_AND_COUPONS"
- "STORE_RELEVANT"
- "BLOCKLISTED"
- "BEST_PRODUCT"
- "RETAIL_SUPPORT"
- "DISABLED"
#user_query_types=
def user_query_types=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) —
The types Retail classifies the search query as.
Supported values are:
- "ORDER_SUPPORT"
- "SIMPLE_PRODUCT_SEARCH"
- "INTENT_REFINEMENT"
- "PRODUCT_DETAILS"
- "PRODUCT_COMPARISON"
- "DEALS_AND_COUPONS"
- "STORE_RELEVANT"
- "BLOCKLISTED"
- "BEST_PRODUCT"
- "RETAIL_SUPPORT"
- "DISABLED"
Returns
-
(::Array<::String>) —
The types Retail classifies the search query as.
Supported values are:
- "ORDER_SUPPORT"
- "SIMPLE_PRODUCT_SEARCH"
- "INTENT_REFINEMENT"
- "PRODUCT_DETAILS"
- "PRODUCT_COMPARISON"
- "DEALS_AND_COUPONS"
- "STORE_RELEVANT"
- "BLOCKLISTED"
- "BEST_PRODUCT"
- "RETAIL_SUPPORT"
- "DISABLED"