google-apis-discoveryengine_v1alpha 0.59.0 → 0.61.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1665,6 +1665,87 @@ module Google
1665
1665
  end
1666
1666
  end
1667
1667
 
1668
+ # The specification for answer generation.
1669
+ class GoogleCloudDiscoveryengineV1AnswerGenerationSpec
1670
+ include Google::Apis::Core::Hashable
1671
+
1672
+ # The specification for user defined classifier.
1673
+ # Corresponds to the JSON property `userDefinedClassifierSpec`
1674
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec]
1675
+ attr_accessor :user_defined_classifier_spec
1676
+
1677
+ def initialize(**args)
1678
+ update!(**args)
1679
+ end
1680
+
1681
+ # Update properties of this object
1682
+ def update!(**args)
1683
+ @user_defined_classifier_spec = args[:user_defined_classifier_spec] if args.key?(:user_defined_classifier_spec)
1684
+ end
1685
+ end
1686
+
1687
+ # The specification for user defined classifier.
1688
+ class GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec
1689
+ include Google::Apis::Core::Hashable
1690
+
1691
+ # Optional. Whether or not to enable and include user defined classifier.
1692
+ # Corresponds to the JSON property `enableUserDefinedClassifier`
1693
+ # @return [Boolean]
1694
+ attr_accessor :enable_user_defined_classifier
1695
+ alias_method :enable_user_defined_classifier?, :enable_user_defined_classifier
1696
+
1697
+ # Optional. The model id to be used for the user defined classifier.
1698
+ # Corresponds to the JSON property `modelId`
1699
+ # @return [String]
1700
+ attr_accessor :model_id
1701
+
1702
+ # Optional. The preamble to be used for the user defined classifier.
1703
+ # Corresponds to the JSON property `preamble`
1704
+ # @return [String]
1705
+ attr_accessor :preamble
1706
+
1707
+ # Optional. The seed value to be used for the user defined classifier.
1708
+ # Corresponds to the JSON property `seed`
1709
+ # @return [Fixnum]
1710
+ attr_accessor :seed
1711
+
1712
+ # Optional. The task marker to be used for the user defined classifier.
1713
+ # Corresponds to the JSON property `taskMarker`
1714
+ # @return [String]
1715
+ attr_accessor :task_marker
1716
+
1717
+ # Optional. The temperature value to be used for the user defined classifier.
1718
+ # Corresponds to the JSON property `temperature`
1719
+ # @return [Float]
1720
+ attr_accessor :temperature
1721
+
1722
+ # Optional. The top-k value to be used for the user defined classifier.
1723
+ # Corresponds to the JSON property `topK`
1724
+ # @return [Fixnum]
1725
+ attr_accessor :top_k
1726
+
1727
+ # Optional. The top-p value to be used for the user defined classifier.
1728
+ # Corresponds to the JSON property `topP`
1729
+ # @return [Float]
1730
+ attr_accessor :top_p
1731
+
1732
+ def initialize(**args)
1733
+ update!(**args)
1734
+ end
1735
+
1736
+ # Update properties of this object
1737
+ def update!(**args)
1738
+ @enable_user_defined_classifier = args[:enable_user_defined_classifier] if args.key?(:enable_user_defined_classifier)
1739
+ @model_id = args[:model_id] if args.key?(:model_id)
1740
+ @preamble = args[:preamble] if args.key?(:preamble)
1741
+ @seed = args[:seed] if args.key?(:seed)
1742
+ @task_marker = args[:task_marker] if args.key?(:task_marker)
1743
+ @temperature = args[:temperature] if args.key?(:temperature)
1744
+ @top_k = args[:top_k] if args.key?(:top_k)
1745
+ @top_p = args[:top_p] if args.key?(:top_p)
1746
+ end
1747
+ end
1748
+
1668
1749
  # Metadata related to the progress of the SiteSearchEngineService.
1669
1750
  # BatchCreateTargetSites operation. This will be returned by the google.
1670
1751
  # longrunning.Operation.metadata field.
@@ -1789,7 +1870,8 @@ module Google
1789
1870
  attr_accessor :active_time_range
1790
1871
 
1791
1872
  # Optional. Query regex to match the whole search query. Cannot be set when
1792
- # Condition.query_terms is set. This is currently supporting promotion use case.
1873
+ # Condition.query_terms is set. Only supported for Basic Site Search promotion
1874
+ # serving controls.
1793
1875
  # Corresponds to the JSON property `queryRegex`
1794
1876
  # @return [String]
1795
1877
  attr_accessor :query_regex
@@ -2939,6 +3021,21 @@ module Google
2939
3021
  attr_accessor :enable_table_annotation
2940
3022
  alias_method :enable_table_annotation?, :enable_table_annotation
2941
3023
 
3024
+ # Optional. List of HTML classes to exclude from the parsed content.
3025
+ # Corresponds to the JSON property `excludeHtmlClasses`
3026
+ # @return [Array<String>]
3027
+ attr_accessor :exclude_html_classes
3028
+
3029
+ # Optional. List of HTML elements to exclude from the parsed content.
3030
+ # Corresponds to the JSON property `excludeHtmlElements`
3031
+ # @return [Array<String>]
3032
+ attr_accessor :exclude_html_elements
3033
+
3034
+ # Optional. List of HTML ids to exclude from the parsed content.
3035
+ # Corresponds to the JSON property `excludeHtmlIds`
3036
+ # @return [Array<String>]
3037
+ attr_accessor :exclude_html_ids
3038
+
2942
3039
  def initialize(**args)
2943
3040
  update!(**args)
2944
3041
  end
@@ -2947,6 +3044,9 @@ module Google
2947
3044
  def update!(**args)
2948
3045
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
2949
3046
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
3047
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
3048
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
3049
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
2950
3050
  end
2951
3051
  end
2952
3052
 
@@ -3073,6 +3173,11 @@ module Google
3073
3173
  # @return [String]
3074
3174
  attr_accessor :industry_vertical
3075
3175
 
3176
+ # Additional config specs for a Media Recommendation engine.
3177
+ # Corresponds to the JSON property `mediaRecommendationEngineConfig`
3178
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig]
3179
+ attr_accessor :media_recommendation_engine_config
3180
+
3076
3181
  # Immutable. The fully qualified resource name of the engine. This field must be
3077
3182
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
3078
3183
  # projects/`project`/locations/`location`/collections/`collection`/engines/`
@@ -3111,6 +3216,7 @@ module Google
3111
3216
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
3112
3217
  @display_name = args[:display_name] if args.key?(:display_name)
3113
3218
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
3219
+ @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
3114
3220
  @name = args[:name] if args.key?(:name)
3115
3221
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
3116
3222
  @solution_type = args[:solution_type] if args.key?(:solution_type)
@@ -3252,6 +3358,157 @@ module Google
3252
3358
  end
3253
3359
  end
3254
3360
 
3361
+ # Additional config specs for a Media Recommendation engine.
3362
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig
3363
+ include Google::Apis::Core::Hashable
3364
+
3365
+ # More feature configs of the selected engine type.
3366
+ # Corresponds to the JSON property `engineFeaturesConfig`
3367
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig]
3368
+ attr_accessor :engine_features_config
3369
+
3370
+ # The optimization objective. e.g., `cvr`. This field together with
3371
+ # optimization_objective describe engine metadata to use to control engine
3372
+ # training and serving. Currently supported values: `ctr`, `cvr`. If not
3373
+ # specified, we choose default based on engine type. Default depends on type of
3374
+ # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
3375
+ # Corresponds to the JSON property `optimizationObjective`
3376
+ # @return [String]
3377
+ attr_accessor :optimization_objective
3378
+
3379
+ # Custom threshold for `cvr` optimization_objective.
3380
+ # Corresponds to the JSON property `optimizationObjectiveConfig`
3381
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
3382
+ attr_accessor :optimization_objective_config
3383
+
3384
+ # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
3385
+ # part of the cost of running the service is frequency of training - this can be
3386
+ # used to determine when to train engine in order to control cost. If not
3387
+ # specified: the default value for `CreateEngine` method is `TRAINING`. The
3388
+ # default value for `UpdateEngine` method is to keep the state the same as
3389
+ # before.
3390
+ # Corresponds to the JSON property `trainingState`
3391
+ # @return [String]
3392
+ attr_accessor :training_state
3393
+
3394
+ # Required. The type of engine. e.g., `recommended-for-you`. This field together
3395
+ # with optimization_objective describe engine metadata to use to control engine
3396
+ # training and serving. Currently supported values: `recommended-for-you`, `
3397
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
3398
+ # Corresponds to the JSON property `type`
3399
+ # @return [String]
3400
+ attr_accessor :type
3401
+
3402
+ def initialize(**args)
3403
+ update!(**args)
3404
+ end
3405
+
3406
+ # Update properties of this object
3407
+ def update!(**args)
3408
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
3409
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
3410
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
3411
+ @training_state = args[:training_state] if args.key?(:training_state)
3412
+ @type = args[:type] if args.key?(:type)
3413
+ end
3414
+ end
3415
+
3416
+ # More feature configs of the selected engine type.
3417
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig
3418
+ include Google::Apis::Core::Hashable
3419
+
3420
+ # Feature configurations that are required for creating a Most Popular engine.
3421
+ # Corresponds to the JSON property `mostPopularConfig`
3422
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
3423
+ attr_accessor :most_popular_config
3424
+
3425
+ # Additional feature configurations for creating a `recommended-for-you` engine.
3426
+ # Corresponds to the JSON property `recommendedForYouConfig`
3427
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
3428
+ attr_accessor :recommended_for_you_config
3429
+
3430
+ def initialize(**args)
3431
+ update!(**args)
3432
+ end
3433
+
3434
+ # Update properties of this object
3435
+ def update!(**args)
3436
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
3437
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
3438
+ end
3439
+ end
3440
+
3441
+ # Feature configurations that are required for creating a Most Popular engine.
3442
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig
3443
+ include Google::Apis::Core::Hashable
3444
+
3445
+ # The time window of which the engine is queried at training and prediction time.
3446
+ # Positive integers only. The value translates to the last X days of events.
3447
+ # Currently required for the `most-popular-items` engine.
3448
+ # Corresponds to the JSON property `timeWindowDays`
3449
+ # @return [Fixnum]
3450
+ attr_accessor :time_window_days
3451
+
3452
+ def initialize(**args)
3453
+ update!(**args)
3454
+ end
3455
+
3456
+ # Update properties of this object
3457
+ def update!(**args)
3458
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
3459
+ end
3460
+ end
3461
+
3462
+ # Custom threshold for `cvr` optimization_objective.
3463
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
3464
+ include Google::Apis::Core::Hashable
3465
+
3466
+ # Required. The name of the field to target. Currently supported values: `watch-
3467
+ # percentage`, `watch-time`.
3468
+ # Corresponds to the JSON property `targetField`
3469
+ # @return [String]
3470
+ attr_accessor :target_field
3471
+
3472
+ # Required. The threshold to be applied to the target (e.g., 0.5).
3473
+ # Corresponds to the JSON property `targetFieldValueFloat`
3474
+ # @return [Float]
3475
+ attr_accessor :target_field_value_float
3476
+
3477
+ def initialize(**args)
3478
+ update!(**args)
3479
+ end
3480
+
3481
+ # Update properties of this object
3482
+ def update!(**args)
3483
+ @target_field = args[:target_field] if args.key?(:target_field)
3484
+ @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
3485
+ end
3486
+ end
3487
+
3488
+ # Additional feature configurations for creating a `recommended-for-you` engine.
3489
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
3490
+ include Google::Apis::Core::Hashable
3491
+
3492
+ # The type of event with which the engine is queried at prediction time. If set
3493
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
3494
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
3495
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
3496
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
3497
+ # engine. Currently supported values: `view-home-page`, `generic`.
3498
+ # Corresponds to the JSON property `contextEventType`
3499
+ # @return [String]
3500
+ attr_accessor :context_event_type
3501
+
3502
+ def initialize(**args)
3503
+ update!(**args)
3504
+ end
3505
+
3506
+ # Update properties of this object
3507
+ def update!(**args)
3508
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
3509
+ end
3510
+ end
3511
+
3255
3512
  # Configurations for a Search Engine.
3256
3513
  class GoogleCloudDiscoveryengineV1EngineSearchEngineConfig
3257
3514
  include Google::Apis::Core::Hashable
@@ -3983,6 +4240,12 @@ module Google
3983
4240
  # @return [String]
3984
4241
  attr_accessor :description
3985
4242
 
4243
+ # Optional. The Document the user wants to promote. For site search, leave unset
4244
+ # and only populate uri. Can be set along with uri.
4245
+ # Corresponds to the JSON property `document`
4246
+ # @return [String]
4247
+ attr_accessor :document
4248
+
3986
4249
  # Optional. The enabled promotion will be returned for any serving configs
3987
4250
  # associated with the parent of the control this promotion is attached to. This
3988
4251
  # flag is used for basic site search only.
@@ -4014,6 +4277,7 @@ module Google
4014
4277
  # Update properties of this object
4015
4278
  def update!(**args)
4016
4279
  @description = args[:description] if args.key?(:description)
4280
+ @document = args[:document] if args.key?(:document)
4017
4281
  @enabled = args[:enabled] if args.key?(:enabled)
4018
4282
  @image_uri = args[:image_uri] if args.key?(:image_uri)
4019
4283
  @title = args[:title] if args.key?(:title)
@@ -4367,6 +4631,11 @@ module Google
4367
4631
  class GoogleCloudDiscoveryengineV1ServingConfig
4368
4632
  include Google::Apis::Core::Hashable
4369
4633
 
4634
+ # The specification for answer generation.
4635
+ # Corresponds to the JSON property `answerGenerationSpec`
4636
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1AnswerGenerationSpec]
4637
+ attr_accessor :answer_generation_spec
4638
+
4370
4639
  # Boost controls to use in serving path. All triggered boost controls will be
4371
4640
  # applied. Boost controls must be in the same data store as the serving config.
4372
4641
  # Maximum of 20 boost controls.
@@ -4523,6 +4792,7 @@ module Google
4523
4792
 
4524
4793
  # Update properties of this object
4525
4794
  def update!(**args)
4795
+ @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
4526
4796
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
4527
4797
  @create_time = args[:create_time] if args.key?(:create_time)
4528
4798
  @display_name = args[:display_name] if args.key?(:display_name)
@@ -5103,6 +5373,11 @@ module Google
5103
5373
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec]
5104
5374
  attr_accessor :boost_spec
5105
5375
 
5376
+ # Optional. Experiment ids for this request.
5377
+ # Corresponds to the JSON property `experimentIds`
5378
+ # @return [Array<String>]
5379
+ attr_accessor :experiment_ids
5380
+
5106
5381
  # Indicates if tail suggestions should be returned if there are no suggestions
5107
5382
  # that match the full query. Even if set to true, if there are suggestions that
5108
5383
  # match the full query, those are returned and no tail suggestions are returned.
@@ -5170,6 +5445,7 @@ module Google
5170
5445
  # Update properties of this object
5171
5446
  def update!(**args)
5172
5447
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
5448
+ @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
5173
5449
  @include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
5174
5450
  @query = args[:query] if args.key?(:query)
5175
5451
  @query_model = args[:query_model] if args.key?(:query_model)
@@ -5839,6 +6115,87 @@ module Google
5839
6115
  end
5840
6116
  end
5841
6117
 
6118
+ # The specification for answer generation.
6119
+ class GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec
6120
+ include Google::Apis::Core::Hashable
6121
+
6122
+ # The specification for user defined classifier.
6123
+ # Corresponds to the JSON property `userDefinedClassifierSpec`
6124
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec]
6125
+ attr_accessor :user_defined_classifier_spec
6126
+
6127
+ def initialize(**args)
6128
+ update!(**args)
6129
+ end
6130
+
6131
+ # Update properties of this object
6132
+ def update!(**args)
6133
+ @user_defined_classifier_spec = args[:user_defined_classifier_spec] if args.key?(:user_defined_classifier_spec)
6134
+ end
6135
+ end
6136
+
6137
+ # The specification for user defined classifier.
6138
+ class GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec
6139
+ include Google::Apis::Core::Hashable
6140
+
6141
+ # Optional. Whether or not to enable and include user defined classifier.
6142
+ # Corresponds to the JSON property `enableUserDefinedClassifier`
6143
+ # @return [Boolean]
6144
+ attr_accessor :enable_user_defined_classifier
6145
+ alias_method :enable_user_defined_classifier?, :enable_user_defined_classifier
6146
+
6147
+ # Optional. The model id to be used for the user defined classifier.
6148
+ # Corresponds to the JSON property `modelId`
6149
+ # @return [String]
6150
+ attr_accessor :model_id
6151
+
6152
+ # Optional. The preamble to be used for the user defined classifier.
6153
+ # Corresponds to the JSON property `preamble`
6154
+ # @return [String]
6155
+ attr_accessor :preamble
6156
+
6157
+ # Optional. The seed value to be used for the user defined classifier.
6158
+ # Corresponds to the JSON property `seed`
6159
+ # @return [Fixnum]
6160
+ attr_accessor :seed
6161
+
6162
+ # Optional. The task marker to be used for the user defined classifier.
6163
+ # Corresponds to the JSON property `taskMarker`
6164
+ # @return [String]
6165
+ attr_accessor :task_marker
6166
+
6167
+ # Optional. The temperature value to be used for the user defined classifier.
6168
+ # Corresponds to the JSON property `temperature`
6169
+ # @return [Float]
6170
+ attr_accessor :temperature
6171
+
6172
+ # Optional. The top-k value to be used for the user defined classifier.
6173
+ # Corresponds to the JSON property `topK`
6174
+ # @return [Fixnum]
6175
+ attr_accessor :top_k
6176
+
6177
+ # Optional. The top-p value to be used for the user defined classifier.
6178
+ # Corresponds to the JSON property `topP`
6179
+ # @return [Float]
6180
+ attr_accessor :top_p
6181
+
6182
+ def initialize(**args)
6183
+ update!(**args)
6184
+ end
6185
+
6186
+ # Update properties of this object
6187
+ def update!(**args)
6188
+ @enable_user_defined_classifier = args[:enable_user_defined_classifier] if args.key?(:enable_user_defined_classifier)
6189
+ @model_id = args[:model_id] if args.key?(:model_id)
6190
+ @preamble = args[:preamble] if args.key?(:preamble)
6191
+ @seed = args[:seed] if args.key?(:seed)
6192
+ @task_marker = args[:task_marker] if args.key?(:task_marker)
6193
+ @temperature = args[:temperature] if args.key?(:temperature)
6194
+ @top_k = args[:top_k] if args.key?(:top_k)
6195
+ @top_p = args[:top_p] if args.key?(:top_p)
6196
+ end
6197
+ end
6198
+
5842
6199
  # Grounding support for a claim in `answer_text`.
5843
6200
  class GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport
5844
6201
  include Google::Apis::Core::Hashable
@@ -7874,6 +8231,12 @@ module Google
7874
8231
  attr_accessor :grounding_check_required
7875
8232
  alias_method :grounding_check_required?, :grounding_check_required
7876
8233
 
8234
+ # Confidence score for the claim in the answer candidate, in the range of [0, 1].
8235
+ # This is set only when enable_claim_level_score is true.
8236
+ # Corresponds to the JSON property `score`
8237
+ # @return [Float]
8238
+ attr_accessor :score
8239
+
7877
8240
  # Position indicating the start of the claim in the answer candidate, measured
7878
8241
  # in bytes. Note that this is not measured in characters and, therefore, must be
7879
8242
  # rendered in the user interface keeping in mind that some characters may take
@@ -7895,6 +8258,7 @@ module Google
7895
8258
  @claim_text = args[:claim_text] if args.key?(:claim_text)
7896
8259
  @end_pos = args[:end_pos] if args.key?(:end_pos)
7897
8260
  @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
8261
+ @score = args[:score] if args.key?(:score)
7898
8262
  @start_pos = args[:start_pos] if args.key?(:start_pos)
7899
8263
  end
7900
8264
  end
@@ -7912,6 +8276,12 @@ module Google
7912
8276
  # @return [Float]
7913
8277
  attr_accessor :citation_threshold
7914
8278
 
8279
+ # The control flag that enables claim-level grounding score in the response.
8280
+ # Corresponds to the JSON property `enableClaimLevelScore`
8281
+ # @return [Boolean]
8282
+ attr_accessor :enable_claim_level_score
8283
+ alias_method :enable_claim_level_score?, :enable_claim_level_score
8284
+
7915
8285
  def initialize(**args)
7916
8286
  update!(**args)
7917
8287
  end
@@ -7919,6 +8289,7 @@ module Google
7919
8289
  # Update properties of this object
7920
8290
  def update!(**args)
7921
8291
  @citation_threshold = args[:citation_threshold] if args.key?(:citation_threshold)
8292
+ @enable_claim_level_score = args[:enable_claim_level_score] if args.key?(:enable_claim_level_score)
7922
8293
  end
7923
8294
  end
7924
8295
 
@@ -8069,6 +8440,11 @@ module Google
8069
8440
  class GoogleCloudDiscoveryengineV1alphaChunk
8070
8441
  include Google::Apis::Core::Hashable
8071
8442
 
8443
+ # Output only. Annotation contents if the current chunk contains annotations.
8444
+ # Corresponds to the JSON property `annotationContents`
8445
+ # @return [Array<String>]
8446
+ attr_accessor :annotation_contents
8447
+
8072
8448
  # Metadata of the current chunk. This field is only populated on SearchService.
8073
8449
  # Search API.
8074
8450
  # Corresponds to the JSON property `chunkMetadata`
@@ -8080,6 +8456,13 @@ module Google
8080
8456
  # @return [String]
8081
8457
  attr_accessor :content
8082
8458
 
8459
+ # Output only. Image Data URLs if the current chunk contains images. Data URLs
8460
+ # are composed of four parts: a prefix (data:), a MIME type indicating the type
8461
+ # of data, an optional base64 token if non-textual, and the data itself: data:,
8462
+ # Corresponds to the JSON property `dataUrls`
8463
+ # @return [Array<String>]
8464
+ attr_accessor :data_urls
8465
+
8083
8466
  # Output only. This field is OUTPUT_ONLY. It contains derived data that are not
8084
8467
  # in the original input document.
8085
8468
  # Corresponds to the JSON property `derivedStructData`
@@ -8123,8 +8506,10 @@ module Google
8123
8506
 
8124
8507
  # Update properties of this object
8125
8508
  def update!(**args)
8509
+ @annotation_contents = args[:annotation_contents] if args.key?(:annotation_contents)
8126
8510
  @chunk_metadata = args[:chunk_metadata] if args.key?(:chunk_metadata)
8127
8511
  @content = args[:content] if args.key?(:content)
8512
+ @data_urls = args[:data_urls] if args.key?(:data_urls)
8128
8513
  @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
8129
8514
  @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
8130
8515
  @id = args[:id] if args.key?(:id)
@@ -8546,7 +8931,8 @@ module Google
8546
8931
  attr_accessor :active_time_range
8547
8932
 
8548
8933
  # Optional. Query regex to match the whole search query. Cannot be set when
8549
- # Condition.query_terms is set. This is currently supporting promotion use case.
8934
+ # Condition.query_terms is set. Only supported for Basic Site Search promotion
8935
+ # serving controls.
8550
8936
  # Corresponds to the JSON property `queryRegex`
8551
8937
  # @return [String]
8552
8938
  attr_accessor :query_regex
@@ -9700,6 +10086,13 @@ module Google
9700
10086
  class GoogleCloudDiscoveryengineV1alphaDataConnector
9701
10087
  include Google::Apis::Core::Hashable
9702
10088
 
10089
+ # Optional. Whether the connector will be created with an ACL config. Currently
10090
+ # this field only affects Cloud Storage and BigQuery connectors.
10091
+ # Corresponds to the JSON property `aclEnabled`
10092
+ # @return [Boolean]
10093
+ attr_accessor :acl_enabled
10094
+ alias_method :acl_enabled?, :acl_enabled
10095
+
9703
10096
  # Informations to support actions on the connector.
9704
10097
  # Corresponds to the JSON property `actionConfig`
9705
10098
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaActionConfig]
@@ -9728,6 +10121,12 @@ module Google
9728
10121
  # @return [Array<String>]
9729
10122
  attr_accessor :blocking_reasons
9730
10123
 
10124
+ # Optional. The modes enabled for this connector. Default state is
10125
+ # CONNECTOR_MODE_UNSPECIFIED.
10126
+ # Corresponds to the JSON property `connectorModes`
10127
+ # @return [Array<String>]
10128
+ attr_accessor :connector_modes
10129
+
9731
10130
  # Output only. The type of connector. Each source can only map to one type. For
9732
10131
  # example, salesforce, confluence and jira have THIRD_PARTY connector type. It
9733
10132
  # is notmutable once set by system.
@@ -9751,6 +10150,11 @@ module Google
9751
10150
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDestinationConfig>]
9752
10151
  attr_accessor :destination_configs
9753
10152
 
10153
+ # Any params and credentials used specifically for EUA connectors.
10154
+ # Corresponds to the JSON property `endUserConfig`
10155
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig]
10156
+ attr_accessor :end_user_config
10157
+
9754
10158
  # List of entities from the connected data source to ingest.
9755
10159
  # Corresponds to the JSON property `entities`
9756
10160
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>]
@@ -9904,15 +10308,18 @@ module Google
9904
10308
 
9905
10309
  # Update properties of this object
9906
10310
  def update!(**args)
10311
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
9907
10312
  @action_config = args[:action_config] if args.key?(:action_config)
9908
10313
  @alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
9909
10314
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
9910
10315
  @bap_config = args[:bap_config] if args.key?(:bap_config)
9911
10316
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
10317
+ @connector_modes = args[:connector_modes] if args.key?(:connector_modes)
9912
10318
  @connector_type = args[:connector_type] if args.key?(:connector_type)
9913
10319
  @create_time = args[:create_time] if args.key?(:create_time)
9914
10320
  @data_source = args[:data_source] if args.key?(:data_source)
9915
10321
  @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
10322
+ @end_user_config = args[:end_user_config] if args.key?(:end_user_config)
9916
10323
  @entities = args[:entities] if args.key?(:entities)
9917
10324
  @errors = args[:errors] if args.key?(:errors)
9918
10325
  @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
@@ -9935,6 +10342,31 @@ module Google
9935
10342
  end
9936
10343
  end
9937
10344
 
10345
+ # Any params and credentials used specifically for EUA connectors.
10346
+ class GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig
10347
+ include Google::Apis::Core::Hashable
10348
+
10349
+ # Optional. Any additional parameters needed for EUA.
10350
+ # Corresponds to the JSON property `additionalParams`
10351
+ # @return [Hash<String,Object>]
10352
+ attr_accessor :additional_params
10353
+
10354
+ # Optional. Any authentication parameters specific to EUA connectors.
10355
+ # Corresponds to the JSON property `authParams`
10356
+ # @return [Hash<String,Object>]
10357
+ attr_accessor :auth_params
10358
+
10359
+ def initialize(**args)
10360
+ update!(**args)
10361
+ end
10362
+
10363
+ # Update properties of this object
10364
+ def update!(**args)
10365
+ @additional_params = args[:additional_params] if args.key?(:additional_params)
10366
+ @auth_params = args[:auth_params] if args.key?(:auth_params)
10367
+ end
10368
+ end
10369
+
9938
10370
  # The configuration for realtime sync to store additional params for realtime
9939
10371
  # sync.
9940
10372
  class GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig
@@ -10803,11 +11235,16 @@ module Google
10803
11235
  include Google::Apis::Core::Hashable
10804
11236
 
10805
11237
  # The MIME type of the content. Supported types: * `application/pdf` (PDF, only
10806
- # native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.
10807
- # openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/
10808
- # vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/
10809
- # plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.
10810
- # xhtml.
11238
+ # native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) *
11239
+ # `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `
11240
+ # application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
11241
+ # * `application/vnd.openxmlformats-officedocument.presentationml.presentation`
11242
+ # (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (
11243
+ # XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following
11244
+ # types are supported only if layout parser is enabled in the data store: * `
11245
+ # image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG)
11246
+ # * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-
11247
+ # types.xhtml.
10811
11248
  # Corresponds to the JSON property `mimeType`
10812
11249
  # @return [String]
10813
11250
  attr_accessor :mime_type
@@ -11099,6 +11536,21 @@ module Google
11099
11536
  attr_accessor :enable_table_annotation
11100
11537
  alias_method :enable_table_annotation?, :enable_table_annotation
11101
11538
 
11539
+ # Optional. List of HTML classes to exclude from the parsed content.
11540
+ # Corresponds to the JSON property `excludeHtmlClasses`
11541
+ # @return [Array<String>]
11542
+ attr_accessor :exclude_html_classes
11543
+
11544
+ # Optional. List of HTML elements to exclude from the parsed content.
11545
+ # Corresponds to the JSON property `excludeHtmlElements`
11546
+ # @return [Array<String>]
11547
+ attr_accessor :exclude_html_elements
11548
+
11549
+ # Optional. List of HTML ids to exclude from the parsed content.
11550
+ # Corresponds to the JSON property `excludeHtmlIds`
11551
+ # @return [Array<String>]
11552
+ attr_accessor :exclude_html_ids
11553
+
11102
11554
  def initialize(**args)
11103
11555
  update!(**args)
11104
11556
  end
@@ -11107,6 +11559,9 @@ module Google
11107
11559
  def update!(**args)
11108
11560
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
11109
11561
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
11562
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
11563
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
11564
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
11110
11565
  end
11111
11566
  end
11112
11567
 
@@ -11485,6 +11940,11 @@ module Google
11485
11940
  class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
11486
11941
  include Google::Apis::Core::Hashable
11487
11942
 
11943
+ # More feature configs of the selected engine type.
11944
+ # Corresponds to the JSON property `engineFeaturesConfig`
11945
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
11946
+ attr_accessor :engine_features_config
11947
+
11488
11948
  # The optimization objective. e.g., `cvr`. This field together with
11489
11949
  # optimization_objective describe engine metadata to use to control engine
11490
11950
  # training and serving. Currently supported values: `ctr`, `cvr`. If not
@@ -11523,6 +11983,7 @@ module Google
11523
11983
 
11524
11984
  # Update properties of this object
11525
11985
  def update!(**args)
11986
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
11526
11987
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
11527
11988
  @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
11528
11989
  @training_state = args[:training_state] if args.key?(:training_state)
@@ -11530,6 +11991,52 @@ module Google
11530
11991
  end
11531
11992
  end
11532
11993
 
11994
+ # More feature configs of the selected engine type.
11995
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
11996
+ include Google::Apis::Core::Hashable
11997
+
11998
+ # Feature configurations that are required for creating a Most Popular engine.
11999
+ # Corresponds to the JSON property `mostPopularConfig`
12000
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
12001
+ attr_accessor :most_popular_config
12002
+
12003
+ # Additional feature configurations for creating a `recommended-for-you` engine.
12004
+ # Corresponds to the JSON property `recommendedForYouConfig`
12005
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
12006
+ attr_accessor :recommended_for_you_config
12007
+
12008
+ def initialize(**args)
12009
+ update!(**args)
12010
+ end
12011
+
12012
+ # Update properties of this object
12013
+ def update!(**args)
12014
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
12015
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
12016
+ end
12017
+ end
12018
+
12019
+ # Feature configurations that are required for creating a Most Popular engine.
12020
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
12021
+ include Google::Apis::Core::Hashable
12022
+
12023
+ # The time window of which the engine is queried at training and prediction time.
12024
+ # Positive integers only. The value translates to the last X days of events.
12025
+ # Currently required for the `most-popular-items` engine.
12026
+ # Corresponds to the JSON property `timeWindowDays`
12027
+ # @return [Fixnum]
12028
+ attr_accessor :time_window_days
12029
+
12030
+ def initialize(**args)
12031
+ update!(**args)
12032
+ end
12033
+
12034
+ # Update properties of this object
12035
+ def update!(**args)
12036
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
12037
+ end
12038
+ end
12039
+
11533
12040
  # Custom threshold for `cvr` optimization_objective.
11534
12041
  class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
11535
12042
  include Google::Apis::Core::Hashable
@@ -11556,6 +12063,30 @@ module Google
11556
12063
  end
11557
12064
  end
11558
12065
 
12066
+ # Additional feature configurations for creating a `recommended-for-you` engine.
12067
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
12068
+ include Google::Apis::Core::Hashable
12069
+
12070
+ # The type of event with which the engine is queried at prediction time. If set
12071
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
12072
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
12073
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
12074
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
12075
+ # engine. Currently supported values: `view-home-page`, `generic`.
12076
+ # Corresponds to the JSON property `contextEventType`
12077
+ # @return [String]
12078
+ attr_accessor :context_event_type
12079
+
12080
+ def initialize(**args)
12081
+ update!(**args)
12082
+ end
12083
+
12084
+ # Update properties of this object
12085
+ def update!(**args)
12086
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
12087
+ end
12088
+ end
12089
+
11559
12090
  # Additional information of a recommendation engine.
11560
12091
  class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
11561
12092
  include Google::Apis::Core::Hashable
@@ -11921,6 +12452,11 @@ module Google
11921
12452
  # @return [String]
11922
12453
  attr_accessor :chunk_text
11923
12454
 
12455
+ # The domain of the source.
12456
+ # Corresponds to the JSON property `domain`
12457
+ # @return [String]
12458
+ attr_accessor :domain
12459
+
11924
12460
  # The index of this chunk. Currently, only used for the streaming mode.
11925
12461
  # Corresponds to the JSON property `index`
11926
12462
  # @return [Fixnum]
@@ -11938,6 +12474,16 @@ module Google
11938
12474
  # @return [Hash<String,String>]
11939
12475
  attr_accessor :source_metadata
11940
12476
 
12477
+ # The title of the source.
12478
+ # Corresponds to the JSON property `title`
12479
+ # @return [String]
12480
+ attr_accessor :title
12481
+
12482
+ # The URI of the source.
12483
+ # Corresponds to the JSON property `uri`
12484
+ # @return [String]
12485
+ attr_accessor :uri
12486
+
11941
12487
  def initialize(**args)
11942
12488
  update!(**args)
11943
12489
  end
@@ -11945,9 +12491,12 @@ module Google
11945
12491
  # Update properties of this object
11946
12492
  def update!(**args)
11947
12493
  @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
12494
+ @domain = args[:domain] if args.key?(:domain)
11948
12495
  @index = args[:index] if args.key?(:index)
11949
12496
  @source = args[:source] if args.key?(:source)
11950
12497
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
12498
+ @title = args[:title] if args.key?(:title)
12499
+ @uri = args[:uri] if args.key?(:uri)
11951
12500
  end
11952
12501
  end
11953
12502
 
@@ -12305,6 +12854,55 @@ module Google
12305
12854
  end
12306
12855
  end
12307
12856
 
12857
+ # Response message for DataConnectorService.GetConnectorSecret.
12858
+ class GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse
12859
+ include Google::Apis::Core::Hashable
12860
+
12861
+ # The app name of the associated Connector.
12862
+ # Corresponds to the JSON property `app`
12863
+ # @return [String]
12864
+ attr_accessor :app
12865
+
12866
+ # The authorization uri for the data connector.
12867
+ # Corresponds to the JSON property `authorizationUri`
12868
+ # @return [String]
12869
+ attr_accessor :authorization_uri
12870
+
12871
+ # The client id of the associated Connector.
12872
+ # Corresponds to the JSON property `clientId`
12873
+ # @return [String]
12874
+ attr_accessor :client_id
12875
+
12876
+ # The instance name of the associated Connector.
12877
+ # Corresponds to the JSON property `instance`
12878
+ # @return [String]
12879
+ attr_accessor :instance
12880
+
12881
+ # The redirect url of the associated Connector.
12882
+ # Corresponds to the JSON property `redirectUri`
12883
+ # @return [String]
12884
+ attr_accessor :redirect_uri
12885
+
12886
+ # The tenant id of the associated Connector.
12887
+ # Corresponds to the JSON property `tenantId`
12888
+ # @return [String]
12889
+ attr_accessor :tenant_id
12890
+
12891
+ def initialize(**args)
12892
+ update!(**args)
12893
+ end
12894
+
12895
+ # Update properties of this object
12896
+ def update!(**args)
12897
+ @app = args[:app] if args.key?(:app)
12898
+ @authorization_uri = args[:authorization_uri] if args.key?(:authorization_uri)
12899
+ @client_id = args[:client_id] if args.key?(:client_id)
12900
+ @instance = args[:instance] if args.key?(:instance)
12901
+ @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
12902
+ @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
12903
+ end
12904
+ end
12905
+
12308
12906
  # Request for GetSession method.
12309
12907
  class GoogleCloudDiscoveryengineV1alphaGetSessionRequest
12310
12908
  include Google::Apis::Core::Hashable
@@ -16367,6 +16965,12 @@ module Google
16367
16965
  # @return [String]
16368
16966
  attr_accessor :description
16369
16967
 
16968
+ # Optional. The Document the user wants to promote. For site search, leave unset
16969
+ # and only populate uri. Can be set along with uri.
16970
+ # Corresponds to the JSON property `document`
16971
+ # @return [String]
16972
+ attr_accessor :document
16973
+
16370
16974
  # Optional. The enabled promotion will be returned for any serving configs
16371
16975
  # associated with the parent of the control this promotion is attached to. This
16372
16976
  # flag is used for basic site search only.
@@ -16398,6 +17002,7 @@ module Google
16398
17002
  # Update properties of this object
16399
17003
  def update!(**args)
16400
17004
  @description = args[:description] if args.key?(:description)
17005
+ @document = args[:document] if args.key?(:document)
16401
17006
  @enabled = args[:enabled] if args.key?(:enabled)
16402
17007
  @image_uri = args[:image_uri] if args.key?(:image_uri)
16403
17008
  @title = args[:title] if args.key?(:title)
@@ -18707,6 +19312,11 @@ module Google
18707
19312
  class GoogleCloudDiscoveryengineV1alphaServingConfig
18708
19313
  include Google::Apis::Core::Hashable
18709
19314
 
19315
+ # The specification for answer generation.
19316
+ # Corresponds to the JSON property `answerGenerationSpec`
19317
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec]
19318
+ attr_accessor :answer_generation_spec
19319
+
18710
19320
  # Boost controls to use in serving path. All triggered boost controls will be
18711
19321
  # applied. Boost controls must be in the same data store as the serving config.
18712
19322
  # Maximum of 20 boost controls.
@@ -18883,6 +19493,7 @@ module Google
18883
19493
 
18884
19494
  # Update properties of this object
18885
19495
  def update!(**args)
19496
+ @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
18886
19497
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
18887
19498
  @create_time = args[:create_time] if args.key?(:create_time)
18888
19499
  @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
@@ -20695,12 +21306,18 @@ module Google
20695
21306
  class GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings
20696
21307
  include Google::Apis::Core::Hashable
20697
21308
 
20698
- # Whether or not the Google search grounding toggle is shown.
21309
+ # Whether or not the Google search grounding toggle is shown. Deprecated. Use
21310
+ # web_grounding_type instead.
20699
21311
  # Corresponds to the JSON property `googleSearchGroundingEnabled`
20700
21312
  # @return [Boolean]
20701
21313
  attr_accessor :google_search_grounding_enabled
20702
21314
  alias_method :google_search_grounding_enabled?, :google_search_grounding_enabled
20703
21315
 
21316
+ # Optional. The type of web grounding to use.
21317
+ # Corresponds to the JSON property `webGroundingType`
21318
+ # @return [String]
21319
+ attr_accessor :web_grounding_type
21320
+
20704
21321
  def initialize(**args)
20705
21322
  update!(**args)
20706
21323
  end
@@ -20708,6 +21325,7 @@ module Google
20708
21325
  # Update properties of this object
20709
21326
  def update!(**args)
20710
21327
  @google_search_grounding_enabled = args[:google_search_grounding_enabled] if args.key?(:google_search_grounding_enabled)
21328
+ @web_grounding_type = args[:web_grounding_type] if args.key?(:web_grounding_type)
20711
21329
  end
20712
21330
  end
20713
21331
 
@@ -21073,6 +21691,12 @@ module Google
21073
21691
  attr_accessor :enable_autocomplete
21074
21692
  alias_method :enable_autocomplete?, :enable_autocomplete
21075
21693
 
21694
+ # Optional. If set to true, the widget will enable people search.
21695
+ # Corresponds to the JSON property `enablePeopleSearch`
21696
+ # @return [Boolean]
21697
+ attr_accessor :enable_people_search
21698
+ alias_method :enable_people_search?, :enable_people_search
21699
+
21076
21700
  # Turn on or off collecting the search result quality feedback from end users.
21077
21701
  # Corresponds to the JSON property `enableQualityFeedback`
21078
21702
  # @return [Boolean]
@@ -21124,6 +21748,7 @@ module Google
21124
21748
  @default_search_request_order_by = args[:default_search_request_order_by] if args.key?(:default_search_request_order_by)
21125
21749
  @disable_user_events_collection = args[:disable_user_events_collection] if args.key?(:disable_user_events_collection)
21126
21750
  @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
21751
+ @enable_people_search = args[:enable_people_search] if args.key?(:enable_people_search)
21127
21752
  @enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
21128
21753
  @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
21129
21754
  @enable_search_as_you_type = args[:enable_search_as_you_type] if args.key?(:enable_search_as_you_type)
@@ -21411,7 +22036,8 @@ module Google
21411
22036
  attr_accessor :active_time_range
21412
22037
 
21413
22038
  # Optional. Query regex to match the whole search query. Cannot be set when
21414
- # Condition.query_terms is set. This is currently supporting promotion use case.
22039
+ # Condition.query_terms is set. Only supported for Basic Site Search promotion
22040
+ # serving controls.
21415
22041
  # Corresponds to the JSON property `queryRegex`
21416
22042
  # @return [String]
21417
22043
  attr_accessor :query_regex
@@ -22619,6 +23245,21 @@ module Google
22619
23245
  attr_accessor :enable_table_annotation
22620
23246
  alias_method :enable_table_annotation?, :enable_table_annotation
22621
23247
 
23248
+ # Optional. List of HTML classes to exclude from the parsed content.
23249
+ # Corresponds to the JSON property `excludeHtmlClasses`
23250
+ # @return [Array<String>]
23251
+ attr_accessor :exclude_html_classes
23252
+
23253
+ # Optional. List of HTML elements to exclude from the parsed content.
23254
+ # Corresponds to the JSON property `excludeHtmlElements`
23255
+ # @return [Array<String>]
23256
+ attr_accessor :exclude_html_elements
23257
+
23258
+ # Optional. List of HTML ids to exclude from the parsed content.
23259
+ # Corresponds to the JSON property `excludeHtmlIds`
23260
+ # @return [Array<String>]
23261
+ attr_accessor :exclude_html_ids
23262
+
22622
23263
  def initialize(**args)
22623
23264
  update!(**args)
22624
23265
  end
@@ -22627,6 +23268,9 @@ module Google
22627
23268
  def update!(**args)
22628
23269
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
22629
23270
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
23271
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
23272
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
23273
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
22630
23274
  end
22631
23275
  end
22632
23276
 
@@ -22753,6 +23397,11 @@ module Google
22753
23397
  # @return [String]
22754
23398
  attr_accessor :industry_vertical
22755
23399
 
23400
+ # Additional config specs for a Media Recommendation engine.
23401
+ # Corresponds to the JSON property `mediaRecommendationEngineConfig`
23402
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig]
23403
+ attr_accessor :media_recommendation_engine_config
23404
+
22756
23405
  # Immutable. The fully qualified resource name of the engine. This field must be
22757
23406
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
22758
23407
  # projects/`project`/locations/`location`/collections/`collection`/engines/`
@@ -22791,6 +23440,7 @@ module Google
22791
23440
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
22792
23441
  @display_name = args[:display_name] if args.key?(:display_name)
22793
23442
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
23443
+ @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
22794
23444
  @name = args[:name] if args.key?(:name)
22795
23445
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
22796
23446
  @solution_type = args[:solution_type] if args.key?(:solution_type)
@@ -22932,6 +23582,157 @@ module Google
22932
23582
  end
22933
23583
  end
22934
23584
 
23585
+ # Additional config specs for a Media Recommendation engine.
23586
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig
23587
+ include Google::Apis::Core::Hashable
23588
+
23589
+ # More feature configs of the selected engine type.
23590
+ # Corresponds to the JSON property `engineFeaturesConfig`
23591
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
23592
+ attr_accessor :engine_features_config
23593
+
23594
+ # The optimization objective. e.g., `cvr`. This field together with
23595
+ # optimization_objective describe engine metadata to use to control engine
23596
+ # training and serving. Currently supported values: `ctr`, `cvr`. If not
23597
+ # specified, we choose default based on engine type. Default depends on type of
23598
+ # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
23599
+ # Corresponds to the JSON property `optimizationObjective`
23600
+ # @return [String]
23601
+ attr_accessor :optimization_objective
23602
+
23603
+ # Custom threshold for `cvr` optimization_objective.
23604
+ # Corresponds to the JSON property `optimizationObjectiveConfig`
23605
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
23606
+ attr_accessor :optimization_objective_config
23607
+
23608
+ # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
23609
+ # part of the cost of running the service is frequency of training - this can be
23610
+ # used to determine when to train engine in order to control cost. If not
23611
+ # specified: the default value for `CreateEngine` method is `TRAINING`. The
23612
+ # default value for `UpdateEngine` method is to keep the state the same as
23613
+ # before.
23614
+ # Corresponds to the JSON property `trainingState`
23615
+ # @return [String]
23616
+ attr_accessor :training_state
23617
+
23618
+ # Required. The type of engine. e.g., `recommended-for-you`. This field together
23619
+ # with optimization_objective describe engine metadata to use to control engine
23620
+ # training and serving. Currently supported values: `recommended-for-you`, `
23621
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
23622
+ # Corresponds to the JSON property `type`
23623
+ # @return [String]
23624
+ attr_accessor :type
23625
+
23626
+ def initialize(**args)
23627
+ update!(**args)
23628
+ end
23629
+
23630
+ # Update properties of this object
23631
+ def update!(**args)
23632
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
23633
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
23634
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
23635
+ @training_state = args[:training_state] if args.key?(:training_state)
23636
+ @type = args[:type] if args.key?(:type)
23637
+ end
23638
+ end
23639
+
23640
+ # More feature configs of the selected engine type.
23641
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
23642
+ include Google::Apis::Core::Hashable
23643
+
23644
+ # Feature configurations that are required for creating a Most Popular engine.
23645
+ # Corresponds to the JSON property `mostPopularConfig`
23646
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
23647
+ attr_accessor :most_popular_config
23648
+
23649
+ # Additional feature configurations for creating a `recommended-for-you` engine.
23650
+ # Corresponds to the JSON property `recommendedForYouConfig`
23651
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
23652
+ attr_accessor :recommended_for_you_config
23653
+
23654
+ def initialize(**args)
23655
+ update!(**args)
23656
+ end
23657
+
23658
+ # Update properties of this object
23659
+ def update!(**args)
23660
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
23661
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
23662
+ end
23663
+ end
23664
+
23665
+ # Feature configurations that are required for creating a Most Popular engine.
23666
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
23667
+ include Google::Apis::Core::Hashable
23668
+
23669
+ # The time window of which the engine is queried at training and prediction time.
23670
+ # Positive integers only. The value translates to the last X days of events.
23671
+ # Currently required for the `most-popular-items` engine.
23672
+ # Corresponds to the JSON property `timeWindowDays`
23673
+ # @return [Fixnum]
23674
+ attr_accessor :time_window_days
23675
+
23676
+ def initialize(**args)
23677
+ update!(**args)
23678
+ end
23679
+
23680
+ # Update properties of this object
23681
+ def update!(**args)
23682
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
23683
+ end
23684
+ end
23685
+
23686
+ # Custom threshold for `cvr` optimization_objective.
23687
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
23688
+ include Google::Apis::Core::Hashable
23689
+
23690
+ # Required. The name of the field to target. Currently supported values: `watch-
23691
+ # percentage`, `watch-time`.
23692
+ # Corresponds to the JSON property `targetField`
23693
+ # @return [String]
23694
+ attr_accessor :target_field
23695
+
23696
+ # Required. The threshold to be applied to the target (e.g., 0.5).
23697
+ # Corresponds to the JSON property `targetFieldValueFloat`
23698
+ # @return [Float]
23699
+ attr_accessor :target_field_value_float
23700
+
23701
+ def initialize(**args)
23702
+ update!(**args)
23703
+ end
23704
+
23705
+ # Update properties of this object
23706
+ def update!(**args)
23707
+ @target_field = args[:target_field] if args.key?(:target_field)
23708
+ @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
23709
+ end
23710
+ end
23711
+
23712
+ # Additional feature configurations for creating a `recommended-for-you` engine.
23713
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
23714
+ include Google::Apis::Core::Hashable
23715
+
23716
+ # The type of event with which the engine is queried at prediction time. If set
23717
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
23718
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
23719
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
23720
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
23721
+ # engine. Currently supported values: `view-home-page`, `generic`.
23722
+ # Corresponds to the JSON property `contextEventType`
23723
+ # @return [String]
23724
+ attr_accessor :context_event_type
23725
+
23726
+ def initialize(**args)
23727
+ update!(**args)
23728
+ end
23729
+
23730
+ # Update properties of this object
23731
+ def update!(**args)
23732
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
23733
+ end
23734
+ end
23735
+
22935
23736
  # Configurations for a Search Engine.
22936
23737
  class GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
22937
23738
  include Google::Apis::Core::Hashable
@@ -24112,6 +24913,12 @@ module Google
24112
24913
  # @return [String]
24113
24914
  attr_accessor :description
24114
24915
 
24916
+ # Optional. The Document the user wants to promote. For site search, leave unset
24917
+ # and only populate uri. Can be set along with uri.
24918
+ # Corresponds to the JSON property `document`
24919
+ # @return [String]
24920
+ attr_accessor :document
24921
+
24115
24922
  # Optional. The enabled promotion will be returned for any serving configs
24116
24923
  # associated with the parent of the control this promotion is attached to. This
24117
24924
  # flag is used for basic site search only.
@@ -24143,6 +24950,7 @@ module Google
24143
24950
  # Update properties of this object
24144
24951
  def update!(**args)
24145
24952
  @description = args[:description] if args.key?(:description)
24953
+ @document = args[:document] if args.key?(:document)
24146
24954
  @enabled = args[:enabled] if args.key?(:enabled)
24147
24955
  @image_uri = args[:image_uri] if args.key?(:image_uri)
24148
24956
  @title = args[:title] if args.key?(:title)