Class: Google::Cloud::DiscoveryEngine::V1::Engine

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

Overview

Metadata that describes the training and serving parameters of an Engine.

Defined Under Namespace

Classes: ChatEngineConfig, ChatEngineMetadata, CommonConfig, MediaRecommendationEngineConfig, SearchEngineConfig

Instance Attribute Summary collapse

Instance Attribute Details

#chat_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig

Returns Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Note: The following fields are mutually exclusive: chat_engine_config, search_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#chat_engine_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata (readonly)

Returns Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#common_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig

Returns Common config spec that specifies the metadata of the engine.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. Timestamp the Recommendation Engine was created at.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_store_ids ⇒ ::Array<::String>

Returns Optional. The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same [Collection][google.cloud.discoveryengine.v1.Collection] can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disable_analytics ⇒ ::Boolean

Returns Optional. Whether to disable analytics for searches performed on this engine.

Returns:

  • (::Boolean) —

    Optional. Whether to disable analytics for searches performed on this engine.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

Returns:

  • (::String) —

    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#industry_vertical ⇒ ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical

Returns Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#media_recommendation_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig

Returns Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

Note: The following fields are mutually exclusive: media_recommendation_engine_config, chat_engine_config, search_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. Identifier. The fully qualified resource name of the engine.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::String) —

    Immutable. Identifier. The fully qualified resource name of the engine.

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.

    Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#search_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::SearchEngineConfig

Returns Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

Note: The following fields are mutually exclusive: search_engine_config, chat_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Required. The solutions of the engine.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. Timestamp the Recommendation Engine was last updated.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 114

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

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end