Class: Google::Cloud::DiscoveryEngine::V1::Control

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/control.rb

Overview

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

Defined Under Namespace

Classes: BoostAction, FilterAction, PromoteAction, RedirectAction, SynonymsAction

Instance Attribute Summary collapse

Instance Attribute Details

#associated_serving_config_ids ⇒ ::Array<::String> (readonly)

Returns Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.

Returns:

  • (::Array<::String>) —

    Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#boost_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction

Returns Defines a boost-type control

Note: The following fields are mutually exclusive: boost_action, filter_action, redirect_action, synonyms_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction) —

    Defines a boost-type control

    Note: The following fields are mutually exclusive: boost_action, filter_action, redirect_action, synonyms_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#conditions ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Condition>

Returns Determines when the associated action will trigger.

Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.

Returns:

  • (::Array<::Google::Cloud::DiscoveryEngine::V1::Condition>) —

    Determines when the associated action will trigger.

    Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. Human readable name. The identifier used in UI views.

Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.

Returns:

  • (::String) —

    Required. Human readable name. The identifier used in UI views.

    Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filter_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction

Returns Defines a filter-type control Currently not supported by Recommendation

Note: The following fields are mutually exclusive: filter_action, boost_action, redirect_action, synonyms_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction) —

    Defines a filter-type control Currently not supported by Recommendation

    Note: The following fields are mutually exclusive: filter_action, boost_action, redirect_action, synonyms_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*.

Returns:

  • (::String) —

    Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#promote_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::PromoteAction

Returns Promote certain links based on predefined trigger queries.

This now only supports basic site search.

Note: The following fields are mutually exclusive: promote_action, boost_action, filter_action, redirect_action, synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::Control::PromoteAction) —

    Promote certain links based on predefined trigger queries.

    This now only supports basic site search.

    Note: The following fields are mutually exclusive: promote_action, boost_action, filter_action, redirect_action, synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#redirect_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction

Returns Defines a redirect-type control.

Note: The following fields are mutually exclusive: redirect_action, boost_action, filter_action, synonyms_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction) —

    Defines a redirect-type control.

    Note: The following fields are mutually exclusive: redirect_action, boost_action, filter_action, synonyms_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#solution_type ⇒ ::Google::Cloud::DiscoveryEngine::V1::SolutionType

Returns Required. Immutable. What solution the control belongs to.

Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#synonyms_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction

Returns Treats a group of terms as synonyms of one another.

Note: The following fields are mutually exclusive: synonyms_action, boost_action, filter_action, redirect_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction) —

    Treats a group of terms as synonyms of one another.

    Note: The following fields are mutually exclusive: synonyms_action, boost_action, filter_action, redirect_action, promote_action. If a field in that set is populated, all other fields in the set will automatically be cleared.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#use_cases ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchUseCase>

Returns Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 153

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

  # Adjusts order of products in returned list.
  # @!attribute [rw] fixed_boost
  #   @return [::Float]
  #     Optional. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  #
  #     Note: The following fields are mutually exclusive: `fixed_boost`, `interpolation_boost_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] interpolation_boost_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec]
  #     Optional. Complex specification for custom ranking based on customer
  #     defined attribute value.
  #
  #     Note: The following fields are mutually exclusive: `interpolation_boost_spec`, `fixed_boost`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boost
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Float]
  #     Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification for custom ranking based on customer specified attribute
    # value. It provides more controls for customized ranking than the simple
    # (condition, boost) combination above.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     Optional. The name of the field whose value will be used to determine
    #     the boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::AttributeType]
    #     Optional. The attribute type to be used to determine the boost amount.
    #     The attribute value can be derived from the field value of the
    #     specified field_name. In the case of numerical it is straightforward
    #     i.e. attribute_value = numerical_field_value. In the case of freshness
    #     however, attribute_value = (time.now() - datetime_field_value).
    # @!attribute [rw] interpolation_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::InterpolationType]
    #     Optional. The interpolation type to be applied to connect the control
    #     points listed below.
    # @!attribute [rw] control_points
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction::InterpolationBoostSpec::ControlPoint>]
    #     Optional. The control points used to define the curve. The monotonic
    #     function (defined through the interpolation_type above) passes through
    #     the control points listed here.
    class InterpolationBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The control points used to define the curve. The curve defined
      # through these control points can only be monotonically increasing
      # or decreasing(constant values are acceptable).
      # @!attribute [rw] attribute_value
      #   @return [::String]
      #     Optional. Can be one of:
      #     1. The numerical field value.
      #     2. The duration spec for freshness:
      #     The value must be formatted as an XSD `dayTimeDuration` value (a
      #     restricted subset of an ISO 8601 duration value). The pattern for
      #     this is: `[nD][T[nH][nM][nS]]`.
      # @!attribute [rw] boost_amount
      #   @return [::Float]
      #     Optional. The value between -1 to 1 by which to boost the score if
      #     the attribute_value evaluates to the value specified above.
      class ControlPoint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The attribute(or function) for which the custom ranking is to be
      # applied.
      module AttributeType
        # Unspecified AttributeType.
        ATTRIBUTE_TYPE_UNSPECIFIED = 0

        # The value of the numerical field will be used to dynamically update
        # the boost amount. In this case, the attribute_value (the x value)
        # of the control point will be the actual value of the numerical
        # field for which the boost_amount is specified.
        NUMERICAL = 1

        # For the freshness use case the attribute value will be the duration
        # between the current time and the date in the datetime field
        # specified. The value must be formatted as an XSD `dayTimeDuration`
        # value (a restricted subset of an ISO 8601 duration value). The
        # pattern for this is: `[nD][T[nH][nM][nS]]`.
        # For example, `5D`, `3DT12H30M`, `T24H`.
        FRESHNESS = 2
      end

      # The interpolation type to be applied. Default will be linear
      # (Piecewise Linear).
      module InterpolationType
        # Interpolation type is unspecified. In this case, it defaults to
        # Linear.
        INTERPOLATION_TYPE_UNSPECIFIED = 0

        # Piecewise linear interpolation will be applied.
        LINEAR = 1
      end
    end
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. A filter to apply on the matching condition results.
  #
  #     Required
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters. Otherwise an INVALID
  #     ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be filtered by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Promote certain links based on some trigger queries.
  #
  # Example: Promote shoe store link when searching for `shoe` keyword.
  # The link can be outside of associated data store.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Data store with which this promotion is attached to.
  # @!attribute [rw] search_link_promotion
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchLinkPromotion]
  #     Required. Promotion attached to this action.
  class PromoteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end