Class: Google::Cloud::DiscoveryEngine::V1beta::ServingConfig

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

Overview

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

Defined Under Namespace

Classes: GenericConfig, MediaConfig

Instance Attribute Summary collapse

Instance Attribute Details

#boost_control_ids ⇒ ::Array<::String>

Returns Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.

Returns:

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

    Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. ServingConfig created timestamp.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human readable serving config display name. Used in Discovery UI.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::String) —

    Required. The human readable serving config display name. Used in Discovery UI.

    This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dissociate_control_ids ⇒ ::Array<::String>

Returns Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100.

Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Returns:

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

    Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100.

    Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#diversity_level ⇒ ::String

Returns How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values:

  • no-diversity
  • low-diversity
  • medium-diversity
  • high-diversity
  • auto-diversity

If not specified, we choose default based on recommendation model type. Default value: no-diversity.

Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Returns:

  • (::String) —

    How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values:

    • no-diversity
    • low-diversity
    • medium-diversity
    • high-diversity
    • auto-diversity

    If not specified, we choose default based on recommendation model type. Default value: no-diversity.

    Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#embedding_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::EmbeddingConfig

Returns Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filter_control_ids ⇒ ::Array<::String>

Returns Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.

Returns:

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

    Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#generic_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig::GenericConfig

Returns The GenericConfig of the serving configuration.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore_control_ids ⇒ ::Array<::String>

Returns Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.

Returns:

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

    Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#media_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig::MediaConfig

Returns The MediaConfig of the serving configuration.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_id ⇒ ::String

Returns The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR).

Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Returns:

  • (::String) —

    The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR).

    Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}.

Returns:

  • (::String) —

    Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#oneway_synonyms_control_ids ⇒ ::Array<::String>

Returns Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100.

Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Returns:

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

    Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100.

    Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ranking_expression ⇒ ::String

Returns The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression.

The ranking expression is a single function or multiple functions that are joined by "+".

  • ranking_expression = function, { " + ", function }; Supported functions:
  • double * relevance_score
  • double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

Returns:

  • (::String) —

    The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression.

    The ranking expression is a single function or multiple functions that are joined by "+".

    • ranking_expression = function, { " + ", function }; Supported functions:
    • double * relevance_score
    • double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

    Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#redirect_control_ids ⇒ ::Array<::String>

Returns IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100.

Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Returns:

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

    IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100.

    Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#replacement_control_ids ⇒ ::Array<::String>

Returns Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100.

Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Returns:

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

    Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100.

    Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Required. Immutable. Specifies the solution type that a serving config can be associated with.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#synonyms_control_ids ⇒ ::Array<::String>

Returns Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100.

Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Returns:

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

    Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100.

    Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. ServingConfig updated timestamp.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb', line 184

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

  # Specifies the configurations needed for Media Discovery. Currently we
  # support:
  #
  # * `demote_content_watched`: Threshold for watched content demotion.
  # Customers can specify if using watched content demotion or use viewed
  # detail page. Using the content watched demotion, customers need to specify
  # the watched minutes or percentage exceeds the threshold, the content will
  # be demoted in the recommendation result.
  # * `promote_fresh_content`: cutoff days for fresh content promotion.
  # Customers can specify if using content freshness promotion. If the content
  # was published within the cutoff days, the content will be promoted in the
  # recommendation result.
  # Can only be set if
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
  # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
  # @!attribute [rw] content_watched_percentage_threshold
  #   @return [::Float]
  #     Specifies the content watched percentage threshold for demotion.
  #     Threshold value must be between [0, 1.0] inclusive.
  # @!attribute [rw] content_watched_seconds_threshold
  #   @return [::Float]
  #     Specifies the content watched minutes threshold for demotion.
  # @!attribute [rw] demotion_event_type
  #   @return [::String]
  #     Specifies the event type used for demoting recommendation result.
  #     Currently supported values:
  #
  #     * `view-item`: Item viewed.
  #     * `media-play`: Start/resume watching a video, playing a song, etc.
  #     * `media-complete`: Finished or stopped midway through a video, song,
  #     etc.
  #
  #     If unset, watch history demotion will not be applied. Content freshness
  #     demotion will still be applied.
  # @!attribute [rw] content_freshness_cutoff_days
  #   @return [::Integer]
  #     Specifies the content freshness used for recommendation result.
  #     Contents will be demoted if contents were published for more than content
  #     freshness cutoff days.
  class MediaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the configurations needed for Generic Discovery.Currently we
  # support:
  #
  # * `content_search_spec`: configuration for generic content search.
  # @!attribute [rw] content_search_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
  #     Specifies the expected behavior of content search.
  #     Only valid for content-search enabled data store.
  class GenericConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end