Class: Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/search_service.rb

Overview

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

Defined Under Namespace

Classes: AdditionalFilter, SuggestedAnswer

Instance Attribute Summary collapse

Instance Attribute Details

#additional_filter ⇒ ::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::AdditionalFilter

Returns 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:



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1140

class ConversationalSearchResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Suggested answers to the follow-up question.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class SuggestedAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional filter that client side need to apply.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class AdditionalFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#additional_filters ⇒ ::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::AdditionalFilter>

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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:



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1140

class ConversationalSearchResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Suggested answers to the follow-up question.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class SuggestedAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional filter that client side need to apply.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class AdditionalFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#conversation_id ⇒ ::String

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



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1140

class ConversationalSearchResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Suggested answers to the follow-up question.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class SuggestedAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional filter that client side need to apply.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class AdditionalFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#followup_question ⇒ ::String

Returns The follow-up question. e.g., What is the color?.

Returns:

  • (::String) —

    The follow-up question. e.g., What is the color?



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1140

class ConversationalSearchResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Suggested answers to the follow-up question.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class SuggestedAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional filter that client side need to apply.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class AdditionalFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#refined_query ⇒ ::String

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



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1140

class ConversationalSearchResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Suggested answers to the follow-up question.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class SuggestedAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional filter that client side need to apply.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class AdditionalFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#suggested_answers ⇒ ::Array<::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult::SuggestedAnswer>

Returns The answer options provided to client for the follow-up question.

Returns:



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1140

class ConversationalSearchResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Suggested answers to the follow-up question.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class SuggestedAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional filter that client side need to apply.
  # @!attribute [rw] product_attribute_value
  #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
  #     Product attribute value, including an attribute key and an
  #     attribute value. Other types can be added here in the future.
  class AdditionalFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end