Retail V2 API - Class Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult (v2.6.1)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult.
This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#additional_filter
defadditional_filter()->::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::AdditionalFilter
Returns
- (::Google::Cloud::Retail::V2::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.
#additional_filter=
defadditional_filter=(value)->::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::AdditionalFilter
Parameter
- value (::Google::Cloud::Retail::V2::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.
Returns
- (::Google::Cloud::Retail::V2::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.
#additional_filters
defadditional_filters()->::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::AdditionalFilter>
Returns
-
(::Array<::Google::Cloud::Retail::V2::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.
#additional_filters=
defadditional_filters=(value)->::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::AdditionalFilter>
Parameter
-
value (::Array<::Google::Cloud::Retail::V2::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.
Returns
-
(::Array<::Google::Cloud::Retail::V2::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.
#conversation_id
defconversation_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 SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.
#conversation_id=
defconversation_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 SearchRequest.ConversationalSearchSpec.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 SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.
#followup_question
deffollowup_question()->::String
Returns
-
(::String) — The follow-up question. e.g.,
What is the color?
#followup_question=
deffollowup_question=(value)->::String
Parameter
-
value (::String) — The follow-up question. e.g.,
What is the color?
Returns
-
(::String) — The follow-up question. e.g.,
What is the color?
#refined_query
defrefined_query()->::String
Returns
-
(::String) — 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
dressand next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer isred color, which does not match any product attribute value filters, the refined query will bedress, red color.
#refined_query=
defrefined_query=(value)->::String
Parameter
-
value (::String) — 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
dressand next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer isred color, which does not match any product attribute value filters, the refined query will bedress, red color.
Returns
-
(::String) — 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
dressand next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer isred color, which does not match any product attribute value filters, the refined query will bedress, red color.
#suggested_answers
defsuggested_answers()->::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::SuggestedAnswer>
Returns
- (::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::SuggestedAnswer>) — The answer options provided to client for the follow-up question.
#suggested_answers=
defsuggested_answers=(value)->::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::SuggestedAnswer>
Parameter
- value (::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::SuggestedAnswer>) — The answer options provided to client for the follow-up question.
Returns
- (::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::SuggestedAnswer>) — The answer options provided to client for the follow-up question.