Class: Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig

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

Overview

Possible options for the facet that corresponds to the current attribute config.

Defined Under Namespace

Classes: IgnoredFacetValues, MergedFacet, MergedFacetValue, RerankConfig

Instance Attribute Summary collapse

Instance Attribute Details

#facet_intervals ⇒ ::Array<::Google::Cloud::Retail::V2::Interval>

Returns If you don't set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.

Returns:

  • (::Array<::Google::Cloud::Retail::V2::Interval>) —

    If you don't set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 218

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

  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#values Facet values} to
  # ignore on {::Google::Cloud::Retail::V2::SearchResponse::Facet facets} during
  # the specified time range for the given
  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#key SearchResponse.Facet.key}
  # attribute.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     List of facet values to ignore for the following time range. The facet
  #     values are the same as the attribute values. There is a limit of 10
  #     values per instance of IgnoredFacetValues. Each value can have at most
  #     128 characters.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Time range for the current list of facet values to ignore.
  #     If multiple time ranges are specified for an facet value for the
  #     current attribute, consider all of them. If both are empty, ignore
  #     always. If start time and end time are set, then start time
  #     must be before end time.
  #     If start time is not empty and end time is empty, then will ignore
  #     these facet values after the start time.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     If start time is empty and end time is not empty, then ignore these
  #     facet values before end time.
  class IgnoredFacetValues
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Replaces a set of textual facet values by the same (possibly different)
  # merged facet value. Each facet value should appear at most once as a
  # value per {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}.
  # This feature is available only for textual custom attributes.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     All the facet values that are replaces by the same
  #     {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue#merged_value merged_value}
  #     that follows. The maximum number of values per MergedFacetValue is 25.
  #     Each value can have up to 128 characters.
  # @!attribute [rw] merged_value
  #   @return [::String]
  #     All the previous values are replaced by this merged facet value.
  #     This merged_value must be non-empty and can have up to 128 characters.
  class MergedFacetValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current facet key (i.e. attribute config) maps into the
  # {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet#merged_facet_key merged_facet_key}.
  # A facet key can have at most one child. The current facet key and the
  # merged facet key need both to be textual custom attributes or both
  # numerical custom attributes (same type).
  # @!attribute [rw] merged_facet_key
  #   @return [::String]
  #     The merged facet key should be a valid facet key that is different than
  #     the facet key of the current catalog attribute. We refer this is
  #     merged facet key as the child of the current catalog attribute. This
  #     merged facet key can't be a parent of another facet key (i.e. no
  #     directed path of length 2). This merged facet key needs to be either a
  #     textual custom attribute or a numerical custom attribute.
  class MergedFacet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to rerank based on facet values engaged by the user for the
  # current key. That key needs to be a custom textual key and facetable.
  # To use this control, you also need to pass all the facet keys engaged by
  # the user in the request using the field [SearchRequest.FacetSpec]. In
  # particular, if you don't pass the facet keys engaged that you want to
  # rerank on, this control won't be effective. Moreover, to obtain better
  # results, the facet values that you want to rerank on should be close to
  # English (ideally made of words, underscores, and spaces).
  # @!attribute [rw] rerank_facet
  #   @return [::Boolean]
  #     If set to true, then we also rerank the dynamic facets based on the
  #     facet values engaged by the user for the current attribute key during
  #     serving.
  # @!attribute [rw] facet_values
  #   @return [::Array<::String>]
  #     If empty, rerank on all facet values for the current key. Otherwise,
  #     will rerank on the facet values from this list only.
  class RerankConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignored_facet_values ⇒ ::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::IgnoredFacetValues>

Returns Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per CatalogAttribute is 25.

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 218

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

  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#values Facet values} to
  # ignore on {::Google::Cloud::Retail::V2::SearchResponse::Facet facets} during
  # the specified time range for the given
  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#key SearchResponse.Facet.key}
  # attribute.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     List of facet values to ignore for the following time range. The facet
  #     values are the same as the attribute values. There is a limit of 10
  #     values per instance of IgnoredFacetValues. Each value can have at most
  #     128 characters.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Time range for the current list of facet values to ignore.
  #     If multiple time ranges are specified for an facet value for the
  #     current attribute, consider all of them. If both are empty, ignore
  #     always. If start time and end time are set, then start time
  #     must be before end time.
  #     If start time is not empty and end time is empty, then will ignore
  #     these facet values after the start time.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     If start time is empty and end time is not empty, then ignore these
  #     facet values before end time.
  class IgnoredFacetValues
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Replaces a set of textual facet values by the same (possibly different)
  # merged facet value. Each facet value should appear at most once as a
  # value per {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}.
  # This feature is available only for textual custom attributes.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     All the facet values that are replaces by the same
  #     {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue#merged_value merged_value}
  #     that follows. The maximum number of values per MergedFacetValue is 25.
  #     Each value can have up to 128 characters.
  # @!attribute [rw] merged_value
  #   @return [::String]
  #     All the previous values are replaced by this merged facet value.
  #     This merged_value must be non-empty and can have up to 128 characters.
  class MergedFacetValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current facet key (i.e. attribute config) maps into the
  # {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet#merged_facet_key merged_facet_key}.
  # A facet key can have at most one child. The current facet key and the
  # merged facet key need both to be textual custom attributes or both
  # numerical custom attributes (same type).
  # @!attribute [rw] merged_facet_key
  #   @return [::String]
  #     The merged facet key should be a valid facet key that is different than
  #     the facet key of the current catalog attribute. We refer this is
  #     merged facet key as the child of the current catalog attribute. This
  #     merged facet key can't be a parent of another facet key (i.e. no
  #     directed path of length 2). This merged facet key needs to be either a
  #     textual custom attribute or a numerical custom attribute.
  class MergedFacet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to rerank based on facet values engaged by the user for the
  # current key. That key needs to be a custom textual key and facetable.
  # To use this control, you also need to pass all the facet keys engaged by
  # the user in the request using the field [SearchRequest.FacetSpec]. In
  # particular, if you don't pass the facet keys engaged that you want to
  # rerank on, this control won't be effective. Moreover, to obtain better
  # results, the facet values that you want to rerank on should be close to
  # English (ideally made of words, underscores, and spaces).
  # @!attribute [rw] rerank_facet
  #   @return [::Boolean]
  #     If set to true, then we also rerank the dynamic facets based on the
  #     facet values engaged by the user for the current attribute key during
  #     serving.
  # @!attribute [rw] facet_values
  #   @return [::Array<::String>]
  #     If empty, rerank on all facet values for the current key. Otherwise,
  #     will rerank on the facet values from this list only.
  class RerankConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#merged_facet ⇒ ::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet

Returns Use this field only if you want to merge a facet key into another facet key.

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 218

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

  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#values Facet values} to
  # ignore on {::Google::Cloud::Retail::V2::SearchResponse::Facet facets} during
  # the specified time range for the given
  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#key SearchResponse.Facet.key}
  # attribute.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     List of facet values to ignore for the following time range. The facet
  #     values are the same as the attribute values. There is a limit of 10
  #     values per instance of IgnoredFacetValues. Each value can have at most
  #     128 characters.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Time range for the current list of facet values to ignore.
  #     If multiple time ranges are specified for an facet value for the
  #     current attribute, consider all of them. If both are empty, ignore
  #     always. If start time and end time are set, then start time
  #     must be before end time.
  #     If start time is not empty and end time is empty, then will ignore
  #     these facet values after the start time.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     If start time is empty and end time is not empty, then ignore these
  #     facet values before end time.
  class IgnoredFacetValues
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Replaces a set of textual facet values by the same (possibly different)
  # merged facet value. Each facet value should appear at most once as a
  # value per {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}.
  # This feature is available only for textual custom attributes.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     All the facet values that are replaces by the same
  #     {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue#merged_value merged_value}
  #     that follows. The maximum number of values per MergedFacetValue is 25.
  #     Each value can have up to 128 characters.
  # @!attribute [rw] merged_value
  #   @return [::String]
  #     All the previous values are replaced by this merged facet value.
  #     This merged_value must be non-empty and can have up to 128 characters.
  class MergedFacetValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current facet key (i.e. attribute config) maps into the
  # {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet#merged_facet_key merged_facet_key}.
  # A facet key can have at most one child. The current facet key and the
  # merged facet key need both to be textual custom attributes or both
  # numerical custom attributes (same type).
  # @!attribute [rw] merged_facet_key
  #   @return [::String]
  #     The merged facet key should be a valid facet key that is different than
  #     the facet key of the current catalog attribute. We refer this is
  #     merged facet key as the child of the current catalog attribute. This
  #     merged facet key can't be a parent of another facet key (i.e. no
  #     directed path of length 2). This merged facet key needs to be either a
  #     textual custom attribute or a numerical custom attribute.
  class MergedFacet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to rerank based on facet values engaged by the user for the
  # current key. That key needs to be a custom textual key and facetable.
  # To use this control, you also need to pass all the facet keys engaged by
  # the user in the request using the field [SearchRequest.FacetSpec]. In
  # particular, if you don't pass the facet keys engaged that you want to
  # rerank on, this control won't be effective. Moreover, to obtain better
  # results, the facet values that you want to rerank on should be close to
  # English (ideally made of words, underscores, and spaces).
  # @!attribute [rw] rerank_facet
  #   @return [::Boolean]
  #     If set to true, then we also rerank the dynamic facets based on the
  #     facet values engaged by the user for the current attribute key during
  #     serving.
  # @!attribute [rw] facet_values
  #   @return [::Array<::String>]
  #     If empty, rerank on all facet values for the current key. Otherwise,
  #     will rerank on the facet values from this list only.
  class RerankConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#merged_facet_values ⇒ ::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue>

Returns Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.

Returns:

  • (::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue>) —

    Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 218

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

  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#values Facet values} to
  # ignore on {::Google::Cloud::Retail::V2::SearchResponse::Facet facets} during
  # the specified time range for the given
  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#key SearchResponse.Facet.key}
  # attribute.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     List of facet values to ignore for the following time range. The facet
  #     values are the same as the attribute values. There is a limit of 10
  #     values per instance of IgnoredFacetValues. Each value can have at most
  #     128 characters.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Time range for the current list of facet values to ignore.
  #     If multiple time ranges are specified for an facet value for the
  #     current attribute, consider all of them. If both are empty, ignore
  #     always. If start time and end time are set, then start time
  #     must be before end time.
  #     If start time is not empty and end time is empty, then will ignore
  #     these facet values after the start time.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     If start time is empty and end time is not empty, then ignore these
  #     facet values before end time.
  class IgnoredFacetValues
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Replaces a set of textual facet values by the same (possibly different)
  # merged facet value. Each facet value should appear at most once as a
  # value per {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}.
  # This feature is available only for textual custom attributes.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     All the facet values that are replaces by the same
  #     {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue#merged_value merged_value}
  #     that follows. The maximum number of values per MergedFacetValue is 25.
  #     Each value can have up to 128 characters.
  # @!attribute [rw] merged_value
  #   @return [::String]
  #     All the previous values are replaced by this merged facet value.
  #     This merged_value must be non-empty and can have up to 128 characters.
  class MergedFacetValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current facet key (i.e. attribute config) maps into the
  # {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet#merged_facet_key merged_facet_key}.
  # A facet key can have at most one child. The current facet key and the
  # merged facet key need both to be textual custom attributes or both
  # numerical custom attributes (same type).
  # @!attribute [rw] merged_facet_key
  #   @return [::String]
  #     The merged facet key should be a valid facet key that is different than
  #     the facet key of the current catalog attribute. We refer this is
  #     merged facet key as the child of the current catalog attribute. This
  #     merged facet key can't be a parent of another facet key (i.e. no
  #     directed path of length 2). This merged facet key needs to be either a
  #     textual custom attribute or a numerical custom attribute.
  class MergedFacet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to rerank based on facet values engaged by the user for the
  # current key. That key needs to be a custom textual key and facetable.
  # To use this control, you also need to pass all the facet keys engaged by
  # the user in the request using the field [SearchRequest.FacetSpec]. In
  # particular, if you don't pass the facet keys engaged that you want to
  # rerank on, this control won't be effective. Moreover, to obtain better
  # results, the facet values that you want to rerank on should be close to
  # English (ideally made of words, underscores, and spaces).
  # @!attribute [rw] rerank_facet
  #   @return [::Boolean]
  #     If set to true, then we also rerank the dynamic facets based on the
  #     facet values engaged by the user for the current attribute key during
  #     serving.
  # @!attribute [rw] facet_values
  #   @return [::Array<::String>]
  #     If empty, rerank on all facet values for the current key. Otherwise,
  #     will rerank on the facet values from this list only.
  class RerankConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#rerank_config ⇒ ::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::RerankConfig

Returns Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 218

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

  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#values Facet values} to
  # ignore on {::Google::Cloud::Retail::V2::SearchResponse::Facet facets} during
  # the specified time range for the given
  # {::Google::Cloud::Retail::V2::SearchResponse::Facet#key SearchResponse.Facet.key}
  # attribute.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     List of facet values to ignore for the following time range. The facet
  #     values are the same as the attribute values. There is a limit of 10
  #     values per instance of IgnoredFacetValues. Each value can have at most
  #     128 characters.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Time range for the current list of facet values to ignore.
  #     If multiple time ranges are specified for an facet value for the
  #     current attribute, consider all of them. If both are empty, ignore
  #     always. If start time and end time are set, then start time
  #     must be before end time.
  #     If start time is not empty and end time is empty, then will ignore
  #     these facet values after the start time.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     If start time is empty and end time is not empty, then ignore these
  #     facet values before end time.
  class IgnoredFacetValues
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Replaces a set of textual facet values by the same (possibly different)
  # merged facet value. Each facet value should appear at most once as a
  # value per {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}.
  # This feature is available only for textual custom attributes.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     All the facet values that are replaces by the same
  #     {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue#merged_value merged_value}
  #     that follows. The maximum number of values per MergedFacetValue is 25.
  #     Each value can have up to 128 characters.
  # @!attribute [rw] merged_value
  #   @return [::String]
  #     All the previous values are replaced by this merged facet value.
  #     This merged_value must be non-empty and can have up to 128 characters.
  class MergedFacetValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current facet key (i.e. attribute config) maps into the
  # {::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet#merged_facet_key merged_facet_key}.
  # A facet key can have at most one child. The current facet key and the
  # merged facet key need both to be textual custom attributes or both
  # numerical custom attributes (same type).
  # @!attribute [rw] merged_facet_key
  #   @return [::String]
  #     The merged facet key should be a valid facet key that is different than
  #     the facet key of the current catalog attribute. We refer this is
  #     merged facet key as the child of the current catalog attribute. This
  #     merged facet key can't be a parent of another facet key (i.e. no
  #     directed path of length 2). This merged facet key needs to be either a
  #     textual custom attribute or a numerical custom attribute.
  class MergedFacet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to rerank based on facet values engaged by the user for the
  # current key. That key needs to be a custom textual key and facetable.
  # To use this control, you also need to pass all the facet keys engaged by
  # the user in the request using the field [SearchRequest.FacetSpec]. In
  # particular, if you don't pass the facet keys engaged that you want to
  # rerank on, this control won't be effective. Moreover, to obtain better
  # results, the facet values that you want to rerank on should be close to
  # English (ideally made of words, underscores, and spaces).
  # @!attribute [rw] rerank_facet
  #   @return [::Boolean]
  #     If set to true, then we also rerank the dynamic facets based on the
  #     facet values engaged by the user for the current attribute key during
  #     serving.
  # @!attribute [rw] facet_values
  #   @return [::Array<::String>]
  #     If empty, rerank on all facet values for the current key. Otherwise,
  #     will rerank on the facet values from this list only.
  class RerankConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end