Retail V2 API - Class Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult (v1.2.0)

Version latest

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.4

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

def additional_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=

def additional_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

def additional_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=

def additional_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

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

def followup_question() -> ::String

Returns

• (::String) — The follow-up question. e.g., What is the color?

#followup_question=

def followup_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

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

#refined_query=

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

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

#suggested_answers

def suggested_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=

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