google-apis-discoveryengine_v1alpha 0.60.0 → 0.62.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.
@@ -2420,10 +2501,10 @@ module Google
2420
2501
  # @return [String]
2421
2502
  attr_accessor :kms_key_name
2422
2503
 
2423
- # Immutable. The full resource name of the data store. Format: `projects/`
2424
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
2425
- # data_store_id``. This field must be a UTF-8 encoded string with a length limit
2426
- # of 1024 characters.
2504
+ # Immutable. Identifier. The full resource name of the data store. Format: `
2505
+ # projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
2506
+ # `data_store_id``. This field must be a UTF-8 encoded string with a length
2507
+ # limit of 1024 characters.
2427
2508
  # Corresponds to the JSON property `name`
2428
2509
  # @return [String]
2429
2510
  attr_accessor :name
@@ -2532,7 +2613,8 @@ module Google
2532
2613
  class GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore
2533
2614
  include Google::Apis::Core::Hashable
2534
2615
 
2535
- # If set true, the DataStore will not be available for serving search requests.
2616
+ # Optional. If set true, the DataStore will not be available for serving search
2617
+ # requests.
2536
2618
  # Corresponds to the JSON property `disabledForServing`
2537
2619
  # @return [Boolean]
2538
2620
  attr_accessor :disabled_for_serving
@@ -2940,6 +3022,21 @@ module Google
2940
3022
  attr_accessor :enable_table_annotation
2941
3023
  alias_method :enable_table_annotation?, :enable_table_annotation
2942
3024
 
3025
+ # Optional. List of HTML classes to exclude from the parsed content.
3026
+ # Corresponds to the JSON property `excludeHtmlClasses`
3027
+ # @return [Array<String>]
3028
+ attr_accessor :exclude_html_classes
3029
+
3030
+ # Optional. List of HTML elements to exclude from the parsed content.
3031
+ # Corresponds to the JSON property `excludeHtmlElements`
3032
+ # @return [Array<String>]
3033
+ attr_accessor :exclude_html_elements
3034
+
3035
+ # Optional. List of HTML ids to exclude from the parsed content.
3036
+ # Corresponds to the JSON property `excludeHtmlIds`
3037
+ # @return [Array<String>]
3038
+ attr_accessor :exclude_html_ids
3039
+
2943
3040
  def initialize(**args)
2944
3041
  update!(**args)
2945
3042
  end
@@ -2948,6 +3045,9 @@ module Google
2948
3045
  def update!(**args)
2949
3046
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
2950
3047
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
3048
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
3049
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
3050
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
2951
3051
  end
2952
3052
  end
2953
3053
 
@@ -3045,12 +3145,12 @@ module Google
3045
3145
  # @return [String]
3046
3146
  attr_accessor :create_time
3047
3147
 
3048
- # The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
3049
- # SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
3050
- # most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
3051
- # DataStores in the same Collection can be associated here. Note that when used
3052
- # in CreateEngineRequest, one DataStore id must be provided as the system will
3053
- # use it for necessary initializations.
3148
+ # Optional. The data stores associated with this engine. For
3149
+ # SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they
3150
+ # can only associate with at most one data store. If solution_type is
3151
+ # SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be
3152
+ # associated here. Note that when used in CreateEngineRequest, one DataStore id
3153
+ # must be provided as the system will use it for necessary initializations.
3054
3154
  # Corresponds to the JSON property `dataStoreIds`
3055
3155
  # @return [Array<String>]
3056
3156
  attr_accessor :data_store_ids
@@ -3067,18 +3167,23 @@ module Google
3067
3167
  # @return [String]
3068
3168
  attr_accessor :display_name
3069
3169
 
3070
- # The industry vertical that the engine registers. The restriction of the Engine
3071
- # industry vertical is based on DataStore: Vertical on Engine has to match
3072
- # vertical of the DataStore linked to the engine.
3170
+ # Optional. The industry vertical that the engine registers. The restriction of
3171
+ # the Engine industry vertical is based on DataStore: Vertical on Engine has to
3172
+ # match vertical of the DataStore linked to the engine.
3073
3173
  # Corresponds to the JSON property `industryVertical`
3074
3174
  # @return [String]
3075
3175
  attr_accessor :industry_vertical
3076
3176
 
3077
- # Immutable. The fully qualified resource name of the engine. This field must be
3078
- # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
3079
- # projects/`project`/locations/`location`/collections/`collection`/engines/`
3080
- # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
3081
- # Otherwise, an INVALID_ARGUMENT error is returned.
3177
+ # Additional config specs for a Media Recommendation engine.
3178
+ # Corresponds to the JSON property `mediaRecommendationEngineConfig`
3179
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig]
3180
+ attr_accessor :media_recommendation_engine_config
3181
+
3182
+ # Immutable. Identifier. The fully qualified resource name of the engine. This
3183
+ # field must be a UTF-8 encoded string with a length limit of 1024 characters.
3184
+ # Format: `projects/`project`/locations/`location`/collections/`collection`/
3185
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
3186
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
3082
3187
  # Corresponds to the JSON property `name`
3083
3188
  # @return [String]
3084
3189
  attr_accessor :name
@@ -3112,6 +3217,7 @@ module Google
3112
3217
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
3113
3218
  @display_name = args[:display_name] if args.key?(:display_name)
3114
3219
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
3220
+ @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
3115
3221
  @name = args[:name] if args.key?(:name)
3116
3222
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
3117
3223
  @solution_type = args[:solution_type] if args.key?(:solution_type)
@@ -3253,6 +3359,157 @@ module Google
3253
3359
  end
3254
3360
  end
3255
3361
 
3362
+ # Additional config specs for a Media Recommendation engine.
3363
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig
3364
+ include Google::Apis::Core::Hashable
3365
+
3366
+ # More feature configs of the selected engine type.
3367
+ # Corresponds to the JSON property `engineFeaturesConfig`
3368
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig]
3369
+ attr_accessor :engine_features_config
3370
+
3371
+ # The optimization objective. e.g., `cvr`. This field together with
3372
+ # optimization_objective describe engine metadata to use to control engine
3373
+ # training and serving. Currently supported values: `ctr`, `cvr`. If not
3374
+ # specified, we choose default based on engine type. Default depends on type of
3375
+ # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
3376
+ # Corresponds to the JSON property `optimizationObjective`
3377
+ # @return [String]
3378
+ attr_accessor :optimization_objective
3379
+
3380
+ # Custom threshold for `cvr` optimization_objective.
3381
+ # Corresponds to the JSON property `optimizationObjectiveConfig`
3382
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
3383
+ attr_accessor :optimization_objective_config
3384
+
3385
+ # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
3386
+ # part of the cost of running the service is frequency of training - this can be
3387
+ # used to determine when to train engine in order to control cost. If not
3388
+ # specified: the default value for `CreateEngine` method is `TRAINING`. The
3389
+ # default value for `UpdateEngine` method is to keep the state the same as
3390
+ # before.
3391
+ # Corresponds to the JSON property `trainingState`
3392
+ # @return [String]
3393
+ attr_accessor :training_state
3394
+
3395
+ # Required. The type of engine. e.g., `recommended-for-you`. This field together
3396
+ # with optimization_objective describe engine metadata to use to control engine
3397
+ # training and serving. Currently supported values: `recommended-for-you`, `
3398
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
3399
+ # Corresponds to the JSON property `type`
3400
+ # @return [String]
3401
+ attr_accessor :type
3402
+
3403
+ def initialize(**args)
3404
+ update!(**args)
3405
+ end
3406
+
3407
+ # Update properties of this object
3408
+ def update!(**args)
3409
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
3410
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
3411
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
3412
+ @training_state = args[:training_state] if args.key?(:training_state)
3413
+ @type = args[:type] if args.key?(:type)
3414
+ end
3415
+ end
3416
+
3417
+ # More feature configs of the selected engine type.
3418
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig
3419
+ include Google::Apis::Core::Hashable
3420
+
3421
+ # Feature configurations that are required for creating a Most Popular engine.
3422
+ # Corresponds to the JSON property `mostPopularConfig`
3423
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
3424
+ attr_accessor :most_popular_config
3425
+
3426
+ # Additional feature configurations for creating a `recommended-for-you` engine.
3427
+ # Corresponds to the JSON property `recommendedForYouConfig`
3428
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
3429
+ attr_accessor :recommended_for_you_config
3430
+
3431
+ def initialize(**args)
3432
+ update!(**args)
3433
+ end
3434
+
3435
+ # Update properties of this object
3436
+ def update!(**args)
3437
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
3438
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
3439
+ end
3440
+ end
3441
+
3442
+ # Feature configurations that are required for creating a Most Popular engine.
3443
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig
3444
+ include Google::Apis::Core::Hashable
3445
+
3446
+ # The time window of which the engine is queried at training and prediction time.
3447
+ # Positive integers only. The value translates to the last X days of events.
3448
+ # Currently required for the `most-popular-items` engine.
3449
+ # Corresponds to the JSON property `timeWindowDays`
3450
+ # @return [Fixnum]
3451
+ attr_accessor :time_window_days
3452
+
3453
+ def initialize(**args)
3454
+ update!(**args)
3455
+ end
3456
+
3457
+ # Update properties of this object
3458
+ def update!(**args)
3459
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
3460
+ end
3461
+ end
3462
+
3463
+ # Custom threshold for `cvr` optimization_objective.
3464
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
3465
+ include Google::Apis::Core::Hashable
3466
+
3467
+ # Required. The name of the field to target. Currently supported values: `watch-
3468
+ # percentage`, `watch-time`.
3469
+ # Corresponds to the JSON property `targetField`
3470
+ # @return [String]
3471
+ attr_accessor :target_field
3472
+
3473
+ # Required. The threshold to be applied to the target (e.g., 0.5).
3474
+ # Corresponds to the JSON property `targetFieldValueFloat`
3475
+ # @return [Float]
3476
+ attr_accessor :target_field_value_float
3477
+
3478
+ def initialize(**args)
3479
+ update!(**args)
3480
+ end
3481
+
3482
+ # Update properties of this object
3483
+ def update!(**args)
3484
+ @target_field = args[:target_field] if args.key?(:target_field)
3485
+ @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
3486
+ end
3487
+ end
3488
+
3489
+ # Additional feature configurations for creating a `recommended-for-you` engine.
3490
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
3491
+ include Google::Apis::Core::Hashable
3492
+
3493
+ # The type of event with which the engine is queried at prediction time. If set
3494
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
3495
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
3496
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
3497
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
3498
+ # engine. Currently supported values: `view-home-page`, `generic`.
3499
+ # Corresponds to the JSON property `contextEventType`
3500
+ # @return [String]
3501
+ attr_accessor :context_event_type
3502
+
3503
+ def initialize(**args)
3504
+ update!(**args)
3505
+ end
3506
+
3507
+ # Update properties of this object
3508
+ def update!(**args)
3509
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
3510
+ end
3511
+ end
3512
+
3256
3513
  # Configurations for a Search Engine.
3257
3514
  class GoogleCloudDiscoveryengineV1EngineSearchEngineConfig
3258
3515
  include Google::Apis::Core::Hashable
@@ -4375,6 +4632,11 @@ module Google
4375
4632
  class GoogleCloudDiscoveryengineV1ServingConfig
4376
4633
  include Google::Apis::Core::Hashable
4377
4634
 
4635
+ # The specification for answer generation.
4636
+ # Corresponds to the JSON property `answerGenerationSpec`
4637
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1AnswerGenerationSpec]
4638
+ attr_accessor :answer_generation_spec
4639
+
4378
4640
  # Boost controls to use in serving path. All triggered boost controls will be
4379
4641
  # applied. Boost controls must be in the same data store as the serving config.
4380
4642
  # Maximum of 20 boost controls.
@@ -4531,6 +4793,7 @@ module Google
4531
4793
 
4532
4794
  # Update properties of this object
4533
4795
  def update!(**args)
4796
+ @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
4534
4797
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
4535
4798
  @create_time = args[:create_time] if args.key?(:create_time)
4536
4799
  @display_name = args[:display_name] if args.key?(:display_name)
@@ -5111,6 +5374,11 @@ module Google
5111
5374
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec]
5112
5375
  attr_accessor :boost_spec
5113
5376
 
5377
+ # Optional. Experiment ids for this request.
5378
+ # Corresponds to the JSON property `experimentIds`
5379
+ # @return [Array<String>]
5380
+ attr_accessor :experiment_ids
5381
+
5114
5382
  # Indicates if tail suggestions should be returned if there are no suggestions
5115
5383
  # that match the full query. Even if set to true, if there are suggestions that
5116
5384
  # match the full query, those are returned and no tail suggestions are returned.
@@ -5178,6 +5446,7 @@ module Google
5178
5446
  # Update properties of this object
5179
5447
  def update!(**args)
5180
5448
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
5449
+ @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
5181
5450
  @include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
5182
5451
  @query = args[:query] if args.key?(:query)
5183
5452
  @query_model = args[:query_model] if args.key?(:query_model)
@@ -5847,6 +6116,87 @@ module Google
5847
6116
  end
5848
6117
  end
5849
6118
 
6119
+ # The specification for answer generation.
6120
+ class GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec
6121
+ include Google::Apis::Core::Hashable
6122
+
6123
+ # The specification for user defined classifier.
6124
+ # Corresponds to the JSON property `userDefinedClassifierSpec`
6125
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec]
6126
+ attr_accessor :user_defined_classifier_spec
6127
+
6128
+ def initialize(**args)
6129
+ update!(**args)
6130
+ end
6131
+
6132
+ # Update properties of this object
6133
+ def update!(**args)
6134
+ @user_defined_classifier_spec = args[:user_defined_classifier_spec] if args.key?(:user_defined_classifier_spec)
6135
+ end
6136
+ end
6137
+
6138
+ # The specification for user defined classifier.
6139
+ class GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec
6140
+ include Google::Apis::Core::Hashable
6141
+
6142
+ # Optional. Whether or not to enable and include user defined classifier.
6143
+ # Corresponds to the JSON property `enableUserDefinedClassifier`
6144
+ # @return [Boolean]
6145
+ attr_accessor :enable_user_defined_classifier
6146
+ alias_method :enable_user_defined_classifier?, :enable_user_defined_classifier
6147
+
6148
+ # Optional. The model id to be used for the user defined classifier.
6149
+ # Corresponds to the JSON property `modelId`
6150
+ # @return [String]
6151
+ attr_accessor :model_id
6152
+
6153
+ # Optional. The preamble to be used for the user defined classifier.
6154
+ # Corresponds to the JSON property `preamble`
6155
+ # @return [String]
6156
+ attr_accessor :preamble
6157
+
6158
+ # Optional. The seed value to be used for the user defined classifier.
6159
+ # Corresponds to the JSON property `seed`
6160
+ # @return [Fixnum]
6161
+ attr_accessor :seed
6162
+
6163
+ # Optional. The task marker to be used for the user defined classifier.
6164
+ # Corresponds to the JSON property `taskMarker`
6165
+ # @return [String]
6166
+ attr_accessor :task_marker
6167
+
6168
+ # Optional. The temperature value to be used for the user defined classifier.
6169
+ # Corresponds to the JSON property `temperature`
6170
+ # @return [Float]
6171
+ attr_accessor :temperature
6172
+
6173
+ # Optional. The top-k value to be used for the user defined classifier.
6174
+ # Corresponds to the JSON property `topK`
6175
+ # @return [Fixnum]
6176
+ attr_accessor :top_k
6177
+
6178
+ # Optional. The top-p value to be used for the user defined classifier.
6179
+ # Corresponds to the JSON property `topP`
6180
+ # @return [Float]
6181
+ attr_accessor :top_p
6182
+
6183
+ def initialize(**args)
6184
+ update!(**args)
6185
+ end
6186
+
6187
+ # Update properties of this object
6188
+ def update!(**args)
6189
+ @enable_user_defined_classifier = args[:enable_user_defined_classifier] if args.key?(:enable_user_defined_classifier)
6190
+ @model_id = args[:model_id] if args.key?(:model_id)
6191
+ @preamble = args[:preamble] if args.key?(:preamble)
6192
+ @seed = args[:seed] if args.key?(:seed)
6193
+ @task_marker = args[:task_marker] if args.key?(:task_marker)
6194
+ @temperature = args[:temperature] if args.key?(:temperature)
6195
+ @top_k = args[:top_k] if args.key?(:top_k)
6196
+ @top_p = args[:top_p] if args.key?(:top_p)
6197
+ end
6198
+ end
6199
+
5850
6200
  # Grounding support for a claim in `answer_text`.
5851
6201
  class GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport
5852
6202
  include Google::Apis::Core::Hashable
@@ -7496,6 +7846,131 @@ module Google
7496
7846
  end
7497
7847
  end
7498
7848
 
7849
+ # Metadata related to the progress of the UserLicenseService.
7850
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
7851
+ # longrunning.Operation.metadata field.
7852
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata
7853
+ include Google::Apis::Core::Hashable
7854
+
7855
+ # Operation create time.
7856
+ # Corresponds to the JSON property `createTime`
7857
+ # @return [String]
7858
+ attr_accessor :create_time
7859
+
7860
+ # Count of user licenses that failed to be updated.
7861
+ # Corresponds to the JSON property `failureCount`
7862
+ # @return [Fixnum]
7863
+ attr_accessor :failure_count
7864
+
7865
+ # Count of user licenses successfully updated.
7866
+ # Corresponds to the JSON property `successCount`
7867
+ # @return [Fixnum]
7868
+ attr_accessor :success_count
7869
+
7870
+ # Operation last update time. If the operation is done, this is also the finish
7871
+ # time.
7872
+ # Corresponds to the JSON property `updateTime`
7873
+ # @return [String]
7874
+ attr_accessor :update_time
7875
+
7876
+ def initialize(**args)
7877
+ update!(**args)
7878
+ end
7879
+
7880
+ # Update properties of this object
7881
+ def update!(**args)
7882
+ @create_time = args[:create_time] if args.key?(:create_time)
7883
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
7884
+ @success_count = args[:success_count] if args.key?(:success_count)
7885
+ @update_time = args[:update_time] if args.key?(:update_time)
7886
+ end
7887
+ end
7888
+
7889
+ # Request message for UserLicenseService.BatchUpdateUserLicenses method.
7890
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest
7891
+ include Google::Apis::Core::Hashable
7892
+
7893
+ # Optional. If true, if user licenses removed associated license config, the
7894
+ # user license will be deleted. By default which is false, the user license will
7895
+ # be updated to unassigned state.
7896
+ # Corresponds to the JSON property `deleteUnassignedUserLicenses`
7897
+ # @return [Boolean]
7898
+ attr_accessor :delete_unassigned_user_licenses
7899
+ alias_method :delete_unassigned_user_licenses?, :delete_unassigned_user_licenses
7900
+
7901
+ # Cloud Storage location for input content.
7902
+ # Corresponds to the JSON property `gcsSource`
7903
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource]
7904
+ attr_accessor :gcs_source
7905
+
7906
+ # The inline source for the input config for BatchUpdateUserLicenses method.
7907
+ # Corresponds to the JSON property `inlineSource`
7908
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource]
7909
+ attr_accessor :inline_source
7910
+
7911
+ def initialize(**args)
7912
+ update!(**args)
7913
+ end
7914
+
7915
+ # Update properties of this object
7916
+ def update!(**args)
7917
+ @delete_unassigned_user_licenses = args[:delete_unassigned_user_licenses] if args.key?(:delete_unassigned_user_licenses)
7918
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
7919
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
7920
+ end
7921
+ end
7922
+
7923
+ # The inline source for the input config for BatchUpdateUserLicenses method.
7924
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource
7925
+ include Google::Apis::Core::Hashable
7926
+
7927
+ # Optional. The list of fields to update.
7928
+ # Corresponds to the JSON property `updateMask`
7929
+ # @return [String]
7930
+ attr_accessor :update_mask
7931
+
7932
+ # Required. A list of user licenses to update. Each user license must have a
7933
+ # valid UserLicense.user_principal.
7934
+ # Corresponds to the JSON property `userLicenses`
7935
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserLicense>]
7936
+ attr_accessor :user_licenses
7937
+
7938
+ def initialize(**args)
7939
+ update!(**args)
7940
+ end
7941
+
7942
+ # Update properties of this object
7943
+ def update!(**args)
7944
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
7945
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
7946
+ end
7947
+ end
7948
+
7949
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
7950
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse
7951
+ include Google::Apis::Core::Hashable
7952
+
7953
+ # A sample of errors encountered while processing the request.
7954
+ # Corresponds to the JSON property `errorSamples`
7955
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
7956
+ attr_accessor :error_samples
7957
+
7958
+ # UserLicenses successfully updated.
7959
+ # Corresponds to the JSON property `userLicenses`
7960
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserLicense>]
7961
+ attr_accessor :user_licenses
7962
+
7963
+ def initialize(**args)
7964
+ update!(**args)
7965
+ end
7966
+
7967
+ # Update properties of this object
7968
+ def update!(**args)
7969
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
7970
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
7971
+ end
7972
+ end
7973
+
7499
7974
  # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
7500
7975
  class GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest
7501
7976
  include Google::Apis::Core::Hashable
@@ -7882,6 +8357,13 @@ module Google
7882
8357
  attr_accessor :grounding_check_required
7883
8358
  alias_method :grounding_check_required?, :grounding_check_required
7884
8359
 
8360
+ # Confidence score for the claim in the answer candidate, in the range of [0, 1].
8361
+ # This is set only when `CheckGroundingRequest.grounding_spec.
8362
+ # enable_claim_level_score` is true.
8363
+ # Corresponds to the JSON property `score`
8364
+ # @return [Float]
8365
+ attr_accessor :score
8366
+
7885
8367
  # Position indicating the start of the claim in the answer candidate, measured
7886
8368
  # in bytes. Note that this is not measured in characters and, therefore, must be
7887
8369
  # rendered in the user interface keeping in mind that some characters may take
@@ -7903,6 +8385,7 @@ module Google
7903
8385
  @claim_text = args[:claim_text] if args.key?(:claim_text)
7904
8386
  @end_pos = args[:end_pos] if args.key?(:end_pos)
7905
8387
  @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
8388
+ @score = args[:score] if args.key?(:score)
7906
8389
  @start_pos = args[:start_pos] if args.key?(:start_pos)
7907
8390
  end
7908
8391
  end
@@ -7920,6 +8403,12 @@ module Google
7920
8403
  # @return [Float]
7921
8404
  attr_accessor :citation_threshold
7922
8405
 
8406
+ # The control flag that enables claim-level grounding score in the response.
8407
+ # Corresponds to the JSON property `enableClaimLevelScore`
8408
+ # @return [Boolean]
8409
+ attr_accessor :enable_claim_level_score
8410
+ alias_method :enable_claim_level_score?, :enable_claim_level_score
8411
+
7923
8412
  def initialize(**args)
7924
8413
  update!(**args)
7925
8414
  end
@@ -7927,6 +8416,7 @@ module Google
7927
8416
  # Update properties of this object
7928
8417
  def update!(**args)
7929
8418
  @citation_threshold = args[:citation_threshold] if args.key?(:citation_threshold)
8419
+ @enable_claim_level_score = args[:enable_claim_level_score] if args.key?(:enable_claim_level_score)
7930
8420
  end
7931
8421
  end
7932
8422
 
@@ -9723,6 +10213,13 @@ module Google
9723
10213
  class GoogleCloudDiscoveryengineV1alphaDataConnector
9724
10214
  include Google::Apis::Core::Hashable
9725
10215
 
10216
+ # Optional. Whether the connector will be created with an ACL config. Currently
10217
+ # this field only affects Cloud Storage and BigQuery connectors.
10218
+ # Corresponds to the JSON property `aclEnabled`
10219
+ # @return [Boolean]
10220
+ attr_accessor :acl_enabled
10221
+ alias_method :acl_enabled?, :acl_enabled
10222
+
9726
10223
  # Informations to support actions on the connector.
9727
10224
  # Corresponds to the JSON property `actionConfig`
9728
10225
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaActionConfig]
@@ -9733,8 +10230,10 @@ module Google
9733
10230
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig>]
9734
10231
  attr_accessor :alert_policy_configs
9735
10232
 
9736
- # Indicates whether the connector is disabled for auto run. It can be used to
9737
- # pause periodical and real time sync.
10233
+ # Optional. Indicates whether the connector is disabled for auto run. It can be
10234
+ # used to pause periodical and real time sync. Update: with the introduction of
10235
+ # incremental_sync_disabled, auto_run_disabled is used to pause/disable only
10236
+ # full syncs
9738
10237
  # Corresponds to the JSON property `autoRunDisabled`
9739
10238
  # @return [Boolean]
9740
10239
  attr_accessor :auto_run_disabled
@@ -9751,13 +10250,25 @@ module Google
9751
10250
  # @return [Array<String>]
9752
10251
  attr_accessor :blocking_reasons
9753
10252
 
10253
+ # Optional. The modes enabled for this connector. Default state is
10254
+ # CONNECTOR_MODE_UNSPECIFIED.
10255
+ # Corresponds to the JSON property `connectorModes`
10256
+ # @return [Array<String>]
10257
+ attr_accessor :connector_modes
10258
+
9754
10259
  # Output only. The type of connector. Each source can only map to one type. For
9755
10260
  # example, salesforce, confluence and jira have THIRD_PARTY connector type. It
9756
- # is notmutable once set by system.
10261
+ # is not mutable once set by system.
9757
10262
  # Corresponds to the JSON property `connectorType`
9758
10263
  # @return [String]
9759
10264
  attr_accessor :connector_type
9760
10265
 
10266
+ # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
10267
+ # Corresponds to the JSON property `createEuaSaas`
10268
+ # @return [Boolean]
10269
+ attr_accessor :create_eua_saas
10270
+ alias_method :create_eua_saas?, :create_eua_saas
10271
+
9761
10272
  # Output only. Timestamp the DataConnector was created at.
9762
10273
  # Corresponds to the JSON property `createTime`
9763
10274
  # @return [String]
@@ -9774,6 +10285,11 @@ module Google
9774
10285
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDestinationConfig>]
9775
10286
  attr_accessor :destination_configs
9776
10287
 
10288
+ # Any params and credentials used specifically for EUA connectors.
10289
+ # Corresponds to the JSON property `endUserConfig`
10290
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig]
10291
+ attr_accessor :end_user_config
10292
+
9777
10293
  # List of entities from the connected data source to ingest.
9778
10294
  # Corresponds to the JSON property `entities`
9779
10295
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>]
@@ -9797,6 +10313,20 @@ module Google
9797
10313
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig]
9798
10314
  attr_accessor :identity_schedule_config
9799
10315
 
10316
+ # Optional. The refresh interval specifically for incremental data syncs. If
10317
+ # unset, incremental syncs will use the default from env, set to 3hrs. The
10318
+ # minimum is 30 minutes and maximum is 7 days.
10319
+ # Corresponds to the JSON property `incrementalRefreshInterval`
10320
+ # @return [String]
10321
+ attr_accessor :incremental_refresh_interval
10322
+
10323
+ # Optional. Indicates whether incremental syncs are paused for this connector.
10324
+ # This is independent of auto_run_disabled.
10325
+ # Corresponds to the JSON property `incrementalSyncDisabled`
10326
+ # @return [Boolean]
10327
+ attr_accessor :incremental_sync_disabled
10328
+ alias_method :incremental_sync_disabled?, :incremental_sync_disabled
10329
+
9800
10330
  # Input only. The KMS key to be used to protect the DataStores managed by this
9801
10331
  # connector. Must be set for requests that need to comply with CMEK Org Policy
9802
10332
  # protections. If this field is set and processed successfully, the DataStores
@@ -9927,19 +10457,25 @@ module Google
9927
10457
 
9928
10458
  # Update properties of this object
9929
10459
  def update!(**args)
10460
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
9930
10461
  @action_config = args[:action_config] if args.key?(:action_config)
9931
10462
  @alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
9932
10463
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
9933
10464
  @bap_config = args[:bap_config] if args.key?(:bap_config)
9934
10465
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
10466
+ @connector_modes = args[:connector_modes] if args.key?(:connector_modes)
9935
10467
  @connector_type = args[:connector_type] if args.key?(:connector_type)
10468
+ @create_eua_saas = args[:create_eua_saas] if args.key?(:create_eua_saas)
9936
10469
  @create_time = args[:create_time] if args.key?(:create_time)
9937
10470
  @data_source = args[:data_source] if args.key?(:data_source)
9938
10471
  @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
10472
+ @end_user_config = args[:end_user_config] if args.key?(:end_user_config)
9939
10473
  @entities = args[:entities] if args.key?(:entities)
9940
10474
  @errors = args[:errors] if args.key?(:errors)
9941
10475
  @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
9942
10476
  @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
10477
+ @incremental_refresh_interval = args[:incremental_refresh_interval] if args.key?(:incremental_refresh_interval)
10478
+ @incremental_sync_disabled = args[:incremental_sync_disabled] if args.key?(:incremental_sync_disabled)
9943
10479
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
9944
10480
  @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time)
9945
10481
  @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
@@ -9958,6 +10494,31 @@ module Google
9958
10494
  end
9959
10495
  end
9960
10496
 
10497
+ # Any params and credentials used specifically for EUA connectors.
10498
+ class GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig
10499
+ include Google::Apis::Core::Hashable
10500
+
10501
+ # Optional. Any additional parameters needed for EUA.
10502
+ # Corresponds to the JSON property `additionalParams`
10503
+ # @return [Hash<String,Object>]
10504
+ attr_accessor :additional_params
10505
+
10506
+ # Optional. Any authentication parameters specific to EUA connectors.
10507
+ # Corresponds to the JSON property `authParams`
10508
+ # @return [Hash<String,Object>]
10509
+ attr_accessor :auth_params
10510
+
10511
+ def initialize(**args)
10512
+ update!(**args)
10513
+ end
10514
+
10515
+ # Update properties of this object
10516
+ def update!(**args)
10517
+ @additional_params = args[:additional_params] if args.key?(:additional_params)
10518
+ @auth_params = args[:auth_params] if args.key?(:auth_params)
10519
+ end
10520
+ end
10521
+
9961
10522
  # The configuration for realtime sync to store additional params for realtime
9962
10523
  # sync.
9963
10524
  class GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig
@@ -10149,10 +10710,10 @@ module Google
10149
10710
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLanguageInfo]
10150
10711
  attr_accessor :language_info
10151
10712
 
10152
- # Immutable. The full resource name of the data store. Format: `projects/`
10153
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
10154
- # data_store_id``. This field must be a UTF-8 encoded string with a length limit
10155
- # of 1024 characters.
10713
+ # Immutable. Identifier. The full resource name of the data store. Format: `
10714
+ # projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
10715
+ # `data_store_id``. This field must be a UTF-8 encoded string with a length
10716
+ # limit of 1024 characters.
10156
10717
  # Corresponds to the JSON property `name`
10157
10718
  # @return [String]
10158
10719
  attr_accessor :name
@@ -10269,7 +10830,8 @@ module Google
10269
10830
  class GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore
10270
10831
  include Google::Apis::Core::Hashable
10271
10832
 
10272
- # If set true, the DataStore will not be available for serving search requests.
10833
+ # Optional. If set true, the DataStore will not be available for serving search
10834
+ # requests.
10273
10835
  # Corresponds to the JSON property `disabledForServing`
10274
10836
  # @return [Boolean]
10275
10837
  attr_accessor :disabled_for_serving
@@ -10827,15 +11389,15 @@ module Google
10827
11389
 
10828
11390
  # The MIME type of the content. Supported types: * `application/pdf` (PDF, only
10829
11391
  # native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) *
10830
- # `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-
10831
- # officedocument.wordprocessingml.document` (DOCX) * `application/vnd.
10832
- # openxmlformats-officedocument.presentationml.presentation` (PPTX) * `
10833
- # application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `
10834
- # application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are
10835
- # supported only if layout parser is enabled in the data store: * `image/bmp` (
10836
- # BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/
10837
- # tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.
10838
- # xhtml.
11392
+ # `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `
11393
+ # application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
11394
+ # * `application/vnd.openxmlformats-officedocument.presentationml.presentation`
11395
+ # (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (
11396
+ # XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following
11397
+ # types are supported only if layout parser is enabled in the data store: * `
11398
+ # image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG)
11399
+ # * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-
11400
+ # types.xhtml.
10839
11401
  # Corresponds to the JSON property `mimeType`
10840
11402
  # @return [String]
10841
11403
  attr_accessor :mime_type
@@ -11127,6 +11689,21 @@ module Google
11127
11689
  attr_accessor :enable_table_annotation
11128
11690
  alias_method :enable_table_annotation?, :enable_table_annotation
11129
11691
 
11692
+ # Optional. List of HTML classes to exclude from the parsed content.
11693
+ # Corresponds to the JSON property `excludeHtmlClasses`
11694
+ # @return [Array<String>]
11695
+ attr_accessor :exclude_html_classes
11696
+
11697
+ # Optional. List of HTML elements to exclude from the parsed content.
11698
+ # Corresponds to the JSON property `excludeHtmlElements`
11699
+ # @return [Array<String>]
11700
+ attr_accessor :exclude_html_elements
11701
+
11702
+ # Optional. List of HTML ids to exclude from the parsed content.
11703
+ # Corresponds to the JSON property `excludeHtmlIds`
11704
+ # @return [Array<String>]
11705
+ attr_accessor :exclude_html_ids
11706
+
11130
11707
  def initialize(**args)
11131
11708
  update!(**args)
11132
11709
  end
@@ -11135,6 +11712,9 @@ module Google
11135
11712
  def update!(**args)
11136
11713
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
11137
11714
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
11715
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
11716
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
11717
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
11138
11718
  end
11139
11719
  end
11140
11720
 
@@ -11283,12 +11863,12 @@ module Google
11283
11863
  # @return [String]
11284
11864
  attr_accessor :create_time
11285
11865
 
11286
- # The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
11287
- # SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
11288
- # most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
11289
- # DataStores in the same Collection can be associated here. Note that when used
11290
- # in CreateEngineRequest, one DataStore id must be provided as the system will
11291
- # use it for necessary initializations.
11866
+ # Optional. The data stores associated with this engine. For
11867
+ # SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they
11868
+ # can only associate with at most one data store. If solution_type is
11869
+ # SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be
11870
+ # associated here. Note that when used in CreateEngineRequest, one DataStore id
11871
+ # must be provided as the system will use it for necessary initializations.
11292
11872
  # Corresponds to the JSON property `dataStoreIds`
11293
11873
  # @return [Array<String>]
11294
11874
  attr_accessor :data_store_ids
@@ -11305,9 +11885,9 @@ module Google
11305
11885
  # @return [String]
11306
11886
  attr_accessor :display_name
11307
11887
 
11308
- # The industry vertical that the engine registers. The restriction of the Engine
11309
- # industry vertical is based on DataStore: Vertical on Engine has to match
11310
- # vertical of the DataStore linked to the engine.
11888
+ # Optional. The industry vertical that the engine registers. The restriction of
11889
+ # the Engine industry vertical is based on DataStore: Vertical on Engine has to
11890
+ # match vertical of the DataStore linked to the engine.
11311
11891
  # Corresponds to the JSON property `industryVertical`
11312
11892
  # @return [String]
11313
11893
  attr_accessor :industry_vertical
@@ -11317,11 +11897,11 @@ module Google
11317
11897
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
11318
11898
  attr_accessor :media_recommendation_engine_config
11319
11899
 
11320
- # Immutable. The fully qualified resource name of the engine. This field must be
11321
- # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
11322
- # projects/`project`/locations/`location`/collections/`collection`/engines/`
11323
- # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
11324
- # Otherwise, an INVALID_ARGUMENT error is returned.
11900
+ # Immutable. Identifier. The fully qualified resource name of the engine. This
11901
+ # field must be a UTF-8 encoded string with a length limit of 1024 characters.
11902
+ # Format: `projects/`project`/locations/`location`/collections/`collection`/
11903
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
11904
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
11325
11905
  # Corresponds to the JSON property `name`
11326
11906
  # @return [String]
11327
11907
  attr_accessor :name
@@ -11513,6 +12093,11 @@ module Google
11513
12093
  class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
11514
12094
  include Google::Apis::Core::Hashable
11515
12095
 
12096
+ # More feature configs of the selected engine type.
12097
+ # Corresponds to the JSON property `engineFeaturesConfig`
12098
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
12099
+ attr_accessor :engine_features_config
12100
+
11516
12101
  # The optimization objective. e.g., `cvr`. This field together with
11517
12102
  # optimization_objective describe engine metadata to use to control engine
11518
12103
  # training and serving. Currently supported values: `ctr`, `cvr`. If not
@@ -11537,13 +12122,63 @@ module Google
11537
12122
  # @return [String]
11538
12123
  attr_accessor :training_state
11539
12124
 
11540
- # Required. The type of engine. e.g., `recommended-for-you`. This field together
11541
- # with optimization_objective describe engine metadata to use to control engine
11542
- # training and serving. Currently supported values: `recommended-for-you`, `
11543
- # others-you-may-like`, `more-like-this`, `most-popular-items`.
11544
- # Corresponds to the JSON property `type`
11545
- # @return [String]
11546
- attr_accessor :type
12125
+ # Required. The type of engine. e.g., `recommended-for-you`. This field together
12126
+ # with optimization_objective describe engine metadata to use to control engine
12127
+ # training and serving. Currently supported values: `recommended-for-you`, `
12128
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
12129
+ # Corresponds to the JSON property `type`
12130
+ # @return [String]
12131
+ attr_accessor :type
12132
+
12133
+ def initialize(**args)
12134
+ update!(**args)
12135
+ end
12136
+
12137
+ # Update properties of this object
12138
+ def update!(**args)
12139
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
12140
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
12141
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
12142
+ @training_state = args[:training_state] if args.key?(:training_state)
12143
+ @type = args[:type] if args.key?(:type)
12144
+ end
12145
+ end
12146
+
12147
+ # More feature configs of the selected engine type.
12148
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
12149
+ include Google::Apis::Core::Hashable
12150
+
12151
+ # Feature configurations that are required for creating a Most Popular engine.
12152
+ # Corresponds to the JSON property `mostPopularConfig`
12153
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
12154
+ attr_accessor :most_popular_config
12155
+
12156
+ # Additional feature configurations for creating a `recommended-for-you` engine.
12157
+ # Corresponds to the JSON property `recommendedForYouConfig`
12158
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
12159
+ attr_accessor :recommended_for_you_config
12160
+
12161
+ def initialize(**args)
12162
+ update!(**args)
12163
+ end
12164
+
12165
+ # Update properties of this object
12166
+ def update!(**args)
12167
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
12168
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
12169
+ end
12170
+ end
12171
+
12172
+ # Feature configurations that are required for creating a Most Popular engine.
12173
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
12174
+ include Google::Apis::Core::Hashable
12175
+
12176
+ # The time window of which the engine is queried at training and prediction time.
12177
+ # Positive integers only. The value translates to the last X days of events.
12178
+ # Currently required for the `most-popular-items` engine.
12179
+ # Corresponds to the JSON property `timeWindowDays`
12180
+ # @return [Fixnum]
12181
+ attr_accessor :time_window_days
11547
12182
 
11548
12183
  def initialize(**args)
11549
12184
  update!(**args)
@@ -11551,10 +12186,7 @@ module Google
11551
12186
 
11552
12187
  # Update properties of this object
11553
12188
  def update!(**args)
11554
- @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
11555
- @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
11556
- @training_state = args[:training_state] if args.key?(:training_state)
11557
- @type = args[:type] if args.key?(:type)
12189
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
11558
12190
  end
11559
12191
  end
11560
12192
 
@@ -11584,6 +12216,30 @@ module Google
11584
12216
  end
11585
12217
  end
11586
12218
 
12219
+ # Additional feature configurations for creating a `recommended-for-you` engine.
12220
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
12221
+ include Google::Apis::Core::Hashable
12222
+
12223
+ # The type of event with which the engine is queried at prediction time. If set
12224
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
12225
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
12226
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
12227
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
12228
+ # engine. Currently supported values: `view-home-page`, `generic`.
12229
+ # Corresponds to the JSON property `contextEventType`
12230
+ # @return [String]
12231
+ attr_accessor :context_event_type
12232
+
12233
+ def initialize(**args)
12234
+ update!(**args)
12235
+ end
12236
+
12237
+ # Update properties of this object
12238
+ def update!(**args)
12239
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
12240
+ end
12241
+ end
12242
+
11587
12243
  # Additional information of a recommendation engine.
11588
12244
  class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
11589
12245
  include Google::Apis::Core::Hashable
@@ -11949,6 +12605,11 @@ module Google
11949
12605
  # @return [String]
11950
12606
  attr_accessor :chunk_text
11951
12607
 
12608
+ # The domain of the source.
12609
+ # Corresponds to the JSON property `domain`
12610
+ # @return [String]
12611
+ attr_accessor :domain
12612
+
11952
12613
  # The index of this chunk. Currently, only used for the streaming mode.
11953
12614
  # Corresponds to the JSON property `index`
11954
12615
  # @return [Fixnum]
@@ -11966,6 +12627,16 @@ module Google
11966
12627
  # @return [Hash<String,String>]
11967
12628
  attr_accessor :source_metadata
11968
12629
 
12630
+ # The title of the source.
12631
+ # Corresponds to the JSON property `title`
12632
+ # @return [String]
12633
+ attr_accessor :title
12634
+
12635
+ # The URI of the source.
12636
+ # Corresponds to the JSON property `uri`
12637
+ # @return [String]
12638
+ attr_accessor :uri
12639
+
11969
12640
  def initialize(**args)
11970
12641
  update!(**args)
11971
12642
  end
@@ -11973,9 +12644,12 @@ module Google
11973
12644
  # Update properties of this object
11974
12645
  def update!(**args)
11975
12646
  @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
12647
+ @domain = args[:domain] if args.key?(:domain)
11976
12648
  @index = args[:index] if args.key?(:index)
11977
12649
  @source = args[:source] if args.key?(:source)
11978
12650
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
12651
+ @title = args[:title] if args.key?(:title)
12652
+ @uri = args[:uri] if args.key?(:uri)
11979
12653
  end
11980
12654
  end
11981
12655
 
@@ -12342,6 +13016,11 @@ module Google
12342
13016
  # @return [String]
12343
13017
  attr_accessor :app
12344
13018
 
13019
+ # The authorization uri for the data connector.
13020
+ # Corresponds to the JSON property `authorizationUri`
13021
+ # @return [String]
13022
+ attr_accessor :authorization_uri
13023
+
12345
13024
  # The client id of the associated Connector.
12346
13025
  # Corresponds to the JSON property `clientId`
12347
13026
  # @return [String]
@@ -12369,6 +13048,7 @@ module Google
12369
13048
  # Update properties of this object
12370
13049
  def update!(**args)
12371
13050
  @app = args[:app] if args.key?(:app)
13051
+ @authorization_uri = args[:authorization_uri] if args.key?(:authorization_uri)
12372
13052
  @client_id = args[:client_id] if args.key?(:client_id)
12373
13053
  @instance = args[:instance] if args.key?(:instance)
12374
13054
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
@@ -14169,6 +14849,32 @@ module Google
14169
14849
  end
14170
14850
  end
14171
14851
 
14852
+ # Response message for UserLicenseService.ListUserLicenses.
14853
+ class GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse
14854
+ include Google::Apis::Core::Hashable
14855
+
14856
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
14857
+ # field is omitted, there are no subsequent pages.
14858
+ # Corresponds to the JSON property `nextPageToken`
14859
+ # @return [String]
14860
+ attr_accessor :next_page_token
14861
+
14862
+ # All the customer's UserLicenses.
14863
+ # Corresponds to the JSON property `userLicenses`
14864
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserLicense>]
14865
+ attr_accessor :user_licenses
14866
+
14867
+ def initialize(**args)
14868
+ update!(**args)
14869
+ end
14870
+
14871
+ # Update properties of this object
14872
+ def update!(**args)
14873
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
14874
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
14875
+ end
14876
+ end
14877
+
14172
14878
  # Media-specific user event information.
14173
14879
  class GoogleCloudDiscoveryengineV1alphaMediaInfo
14174
14880
  include Google::Apis::Core::Hashable
@@ -17367,6 +18073,14 @@ module Google
17367
18073
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec]
17368
18074
  attr_accessor :boost_spec
17369
18075
 
18076
+ # Optional. Custom search operators which if specified will be used to filter
18077
+ # results from workspace data stores. For more information on custom search
18078
+ # operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/
18079
+ # 6172299).
18080
+ # Corresponds to the JSON property `customSearchOperators`
18081
+ # @return [String]
18082
+ attr_accessor :custom_search_operators
18083
+
17370
18084
  # Required. Full resource name of DataStore, such as `projects/`project`/
17371
18085
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
17372
18086
  # Corresponds to the JSON property `dataStore`
@@ -17387,6 +18101,7 @@ module Google
17387
18101
  # Update properties of this object
17388
18102
  def update!(**args)
17389
18103
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
18104
+ @custom_search_operators = args[:custom_search_operators] if args.key?(:custom_search_operators)
17390
18105
  @data_store = args[:data_store] if args.key?(:data_store)
17391
18106
  @filter = args[:filter] if args.key?(:filter)
17392
18107
  end
@@ -18099,12 +18814,6 @@ module Google
18099
18814
  # @return [String]
18100
18815
  attr_accessor :rewritten_query
18101
18816
 
18102
- # The SQL request that was generated from the natural language query
18103
- # understanding phase.
18104
- # Corresponds to the JSON property `sqlRequest`
18105
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest]
18106
- attr_accessor :sql_request
18107
-
18108
18817
  # The filters that were extracted from the input query represented in a
18109
18818
  # structured form.
18110
18819
  # Corresponds to the JSON property `structuredExtractedFilter`
@@ -18120,31 +18829,10 @@ module Google
18120
18829
  @classified_intents = args[:classified_intents] if args.key?(:classified_intents)
18121
18830
  @extracted_filters = args[:extracted_filters] if args.key?(:extracted_filters)
18122
18831
  @rewritten_query = args[:rewritten_query] if args.key?(:rewritten_query)
18123
- @sql_request = args[:sql_request] if args.key?(:sql_request)
18124
18832
  @structured_extracted_filter = args[:structured_extracted_filter] if args.key?(:structured_extracted_filter)
18125
18833
  end
18126
18834
  end
18127
18835
 
18128
- # The SQL request that was generated from the natural language query
18129
- # understanding phase.
18130
- class GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest
18131
- include Google::Apis::Core::Hashable
18132
-
18133
- # Optional. The SQL query in text format.
18134
- # Corresponds to the JSON property `sqlQuery`
18135
- # @return [String]
18136
- attr_accessor :sql_query
18137
-
18138
- def initialize(**args)
18139
- update!(**args)
18140
- end
18141
-
18142
- # Update properties of this object
18143
- def update!(**args)
18144
- @sql_query = args[:sql_query] if args.key?(:sql_query)
18145
- end
18146
- end
18147
-
18148
18836
  # The filters that were extracted from the input query represented in a
18149
18837
  # structured form.
18150
18838
  class GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter
@@ -18785,6 +19473,11 @@ module Google
18785
19473
  class GoogleCloudDiscoveryengineV1alphaServingConfig
18786
19474
  include Google::Apis::Core::Hashable
18787
19475
 
19476
+ # The specification for answer generation.
19477
+ # Corresponds to the JSON property `answerGenerationSpec`
19478
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec]
19479
+ attr_accessor :answer_generation_spec
19480
+
18788
19481
  # Boost controls to use in serving path. All triggered boost controls will be
18789
19482
  # applied. Boost controls must be in the same data store as the serving config.
18790
19483
  # Maximum of 20 boost controls.
@@ -18961,6 +19654,7 @@ module Google
18961
19654
 
18962
19655
  # Update properties of this object
18963
19656
  def update!(**args)
19657
+ @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
18964
19658
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
18965
19659
  @create_time = args[:create_time] if args.key?(:create_time)
18966
19660
  @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
@@ -20463,6 +21157,79 @@ module Google
20463
21157
  end
20464
21158
  end
20465
21159
 
21160
+ # User License information assigned by the admin.
21161
+ class GoogleCloudDiscoveryengineV1alphaUserLicense
21162
+ include Google::Apis::Core::Hashable
21163
+
21164
+ # Output only. User created timestamp.
21165
+ # Corresponds to the JSON property `createTime`
21166
+ # @return [String]
21167
+ attr_accessor :create_time
21168
+
21169
+ # Output only. User last logged in time. If the user has not logged in yet, this
21170
+ # field will be empty.
21171
+ # Corresponds to the JSON property `lastLoginTime`
21172
+ # @return [String]
21173
+ attr_accessor :last_login_time
21174
+
21175
+ # Output only. License assignment state of the user. If the user is assigned
21176
+ # with a license config, the user loggin will be assigned with the license; If
21177
+ # the user's license assignment state is unassigned or unspecified, no license
21178
+ # config will be associated to the user;
21179
+ # Corresponds to the JSON property `licenseAssignmentState`
21180
+ # @return [String]
21181
+ attr_accessor :license_assignment_state
21182
+
21183
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
21184
+ # to the user.
21185
+ # Corresponds to the JSON property `licenseConfig`
21186
+ # @return [String]
21187
+ attr_accessor :license_config
21188
+
21189
+ # Output only. User update timestamp.
21190
+ # Corresponds to the JSON property `updateTime`
21191
+ # @return [String]
21192
+ attr_accessor :update_time
21193
+
21194
+ # Optional. The full resource name of the User, in the format of `projects/`
21195
+ # project`/locations/`location`/userStores/`user_store`/users/`user_id``. This
21196
+ # field must be a UTF-8 encoded string with a length limit of 2048 characters.
21197
+ # If the user field is empty, it's indicating the user has not logged in yet and
21198
+ # no User entity is created.
21199
+ # Corresponds to the JSON property `user`
21200
+ # @return [String]
21201
+ attr_accessor :user
21202
+
21203
+ # Required. Immutable. The user principal of the User, could be email address or
21204
+ # other prinical identifier. This field is immutable. Admin assign licenses
21205
+ # based on the user principal.
21206
+ # Corresponds to the JSON property `userPrincipal`
21207
+ # @return [String]
21208
+ attr_accessor :user_principal
21209
+
21210
+ # Optional. The user profile. We user user full name(First name + Last name) as
21211
+ # user profile.
21212
+ # Corresponds to the JSON property `userProfile`
21213
+ # @return [String]
21214
+ attr_accessor :user_profile
21215
+
21216
+ def initialize(**args)
21217
+ update!(**args)
21218
+ end
21219
+
21220
+ # Update properties of this object
21221
+ def update!(**args)
21222
+ @create_time = args[:create_time] if args.key?(:create_time)
21223
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
21224
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
21225
+ @license_config = args[:license_config] if args.key?(:license_config)
21226
+ @update_time = args[:update_time] if args.key?(:update_time)
21227
+ @user = args[:user] if args.key?(:user)
21228
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
21229
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
21230
+ end
21231
+ end
21232
+
20466
21233
  # WidgetConfig captures configs at the Widget level.
20467
21234
  class GoogleCloudDiscoveryengineV1alphaWidgetConfig
20468
21235
  include Google::Apis::Core::Hashable
@@ -20556,6 +21323,12 @@ module Google
20556
21323
  attr_accessor :enable_conversational_search
20557
21324
  alias_method :enable_conversational_search?, :enable_conversational_search
20558
21325
 
21326
+ # Optional. Output only. Whether to enable private knowledge graph.
21327
+ # Corresponds to the JSON property `enablePrivateKnowledgeGraph`
21328
+ # @return [Boolean]
21329
+ attr_accessor :enable_private_knowledge_graph
21330
+ alias_method :enable_private_knowledge_graph?, :enable_private_knowledge_graph
21331
+
20559
21332
  # Turn on or off collecting the search result quality feedback from end users.
20560
21333
  # Corresponds to the JSON property `enableQualityFeedback`
20561
21334
  # @return [Boolean]
@@ -20699,6 +21472,7 @@ module Google
20699
21472
  @display_name = args[:display_name] if args.key?(:display_name)
20700
21473
  @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
20701
21474
  @enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
21475
+ @enable_private_knowledge_graph = args[:enable_private_knowledge_graph] if args.key?(:enable_private_knowledge_graph)
20702
21476
  @enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
20703
21477
  @enable_result_score = args[:enable_result_score] if args.key?(:enable_result_score)
20704
21478
  @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
@@ -20773,12 +21547,18 @@ module Google
20773
21547
  class GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings
20774
21548
  include Google::Apis::Core::Hashable
20775
21549
 
20776
- # Whether or not the Google search grounding toggle is shown.
21550
+ # Whether or not the Google search grounding toggle is shown. Deprecated. Use
21551
+ # web_grounding_type instead.
20777
21552
  # Corresponds to the JSON property `googleSearchGroundingEnabled`
20778
21553
  # @return [Boolean]
20779
21554
  attr_accessor :google_search_grounding_enabled
20780
21555
  alias_method :google_search_grounding_enabled?, :google_search_grounding_enabled
20781
21556
 
21557
+ # Optional. The type of web grounding to use.
21558
+ # Corresponds to the JSON property `webGroundingType`
21559
+ # @return [String]
21560
+ attr_accessor :web_grounding_type
21561
+
20782
21562
  def initialize(**args)
20783
21563
  update!(**args)
20784
21564
  end
@@ -20786,6 +21566,7 @@ module Google
20786
21566
  # Update properties of this object
20787
21567
  def update!(**args)
20788
21568
  @google_search_grounding_enabled = args[:google_search_grounding_enabled] if args.key?(:google_search_grounding_enabled)
21569
+ @web_grounding_type = args[:web_grounding_type] if args.key?(:web_grounding_type)
20789
21570
  end
20790
21571
  end
20791
21572
 
@@ -21151,6 +21932,12 @@ module Google
21151
21932
  attr_accessor :enable_autocomplete
21152
21933
  alias_method :enable_autocomplete?, :enable_autocomplete
21153
21934
 
21935
+ # Optional. If set to true, the widget will enable people search.
21936
+ # Corresponds to the JSON property `enablePeopleSearch`
21937
+ # @return [Boolean]
21938
+ attr_accessor :enable_people_search
21939
+ alias_method :enable_people_search?, :enable_people_search
21940
+
21154
21941
  # Turn on or off collecting the search result quality feedback from end users.
21155
21942
  # Corresponds to the JSON property `enableQualityFeedback`
21156
21943
  # @return [Boolean]
@@ -21202,6 +21989,7 @@ module Google
21202
21989
  @default_search_request_order_by = args[:default_search_request_order_by] if args.key?(:default_search_request_order_by)
21203
21990
  @disable_user_events_collection = args[:disable_user_events_collection] if args.key?(:disable_user_events_collection)
21204
21991
  @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
21992
+ @enable_people_search = args[:enable_people_search] if args.key?(:enable_people_search)
21205
21993
  @enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
21206
21994
  @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
21207
21995
  @enable_search_as_you_type = args[:enable_search_as_you_type] if args.key?(:enable_search_as_you_type)
@@ -22160,10 +22948,10 @@ module Google
22160
22948
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaLanguageInfo]
22161
22949
  attr_accessor :language_info
22162
22950
 
22163
- # Immutable. The full resource name of the data store. Format: `projects/`
22164
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
22165
- # data_store_id``. This field must be a UTF-8 encoded string with a length limit
22166
- # of 1024 characters.
22951
+ # Immutable. Identifier. The full resource name of the data store. Format: `
22952
+ # projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
22953
+ # `data_store_id``. This field must be a UTF-8 encoded string with a length
22954
+ # limit of 1024 characters.
22167
22955
  # Corresponds to the JSON property `name`
22168
22956
  # @return [String]
22169
22957
  attr_accessor :name
@@ -22279,7 +23067,8 @@ module Google
22279
23067
  class GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore
22280
23068
  include Google::Apis::Core::Hashable
22281
23069
 
22282
- # If set true, the DataStore will not be available for serving search requests.
23070
+ # Optional. If set true, the DataStore will not be available for serving search
23071
+ # requests.
22283
23072
  # Corresponds to the JSON property `disabledForServing`
22284
23073
  # @return [Boolean]
22285
23074
  attr_accessor :disabled_for_serving
@@ -22698,6 +23487,21 @@ module Google
22698
23487
  attr_accessor :enable_table_annotation
22699
23488
  alias_method :enable_table_annotation?, :enable_table_annotation
22700
23489
 
23490
+ # Optional. List of HTML classes to exclude from the parsed content.
23491
+ # Corresponds to the JSON property `excludeHtmlClasses`
23492
+ # @return [Array<String>]
23493
+ attr_accessor :exclude_html_classes
23494
+
23495
+ # Optional. List of HTML elements to exclude from the parsed content.
23496
+ # Corresponds to the JSON property `excludeHtmlElements`
23497
+ # @return [Array<String>]
23498
+ attr_accessor :exclude_html_elements
23499
+
23500
+ # Optional. List of HTML ids to exclude from the parsed content.
23501
+ # Corresponds to the JSON property `excludeHtmlIds`
23502
+ # @return [Array<String>]
23503
+ attr_accessor :exclude_html_ids
23504
+
22701
23505
  def initialize(**args)
22702
23506
  update!(**args)
22703
23507
  end
@@ -22706,6 +23510,9 @@ module Google
22706
23510
  def update!(**args)
22707
23511
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
22708
23512
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
23513
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
23514
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
23515
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
22709
23516
  end
22710
23517
  end
22711
23518
 
@@ -22803,12 +23610,12 @@ module Google
22803
23610
  # @return [String]
22804
23611
  attr_accessor :create_time
22805
23612
 
22806
- # The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
22807
- # SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
22808
- # most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
22809
- # DataStores in the same Collection can be associated here. Note that when used
22810
- # in CreateEngineRequest, one DataStore id must be provided as the system will
22811
- # use it for necessary initializations.
23613
+ # Optional. The data stores associated with this engine. For
23614
+ # SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they
23615
+ # can only associate with at most one data store. If solution_type is
23616
+ # SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be
23617
+ # associated here. Note that when used in CreateEngineRequest, one DataStore id
23618
+ # must be provided as the system will use it for necessary initializations.
22812
23619
  # Corresponds to the JSON property `dataStoreIds`
22813
23620
  # @return [Array<String>]
22814
23621
  attr_accessor :data_store_ids
@@ -22825,18 +23632,23 @@ module Google
22825
23632
  # @return [String]
22826
23633
  attr_accessor :display_name
22827
23634
 
22828
- # The industry vertical that the engine registers. The restriction of the Engine
22829
- # industry vertical is based on DataStore: Vertical on Engine has to match
22830
- # vertical of the DataStore linked to the engine.
23635
+ # Optional. The industry vertical that the engine registers. The restriction of
23636
+ # the Engine industry vertical is based on DataStore: Vertical on Engine has to
23637
+ # match vertical of the DataStore linked to the engine.
22831
23638
  # Corresponds to the JSON property `industryVertical`
22832
23639
  # @return [String]
22833
23640
  attr_accessor :industry_vertical
22834
23641
 
22835
- # Immutable. The fully qualified resource name of the engine. This field must be
22836
- # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
22837
- # projects/`project`/locations/`location`/collections/`collection`/engines/`
22838
- # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
22839
- # Otherwise, an INVALID_ARGUMENT error is returned.
23642
+ # Additional config specs for a Media Recommendation engine.
23643
+ # Corresponds to the JSON property `mediaRecommendationEngineConfig`
23644
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig]
23645
+ attr_accessor :media_recommendation_engine_config
23646
+
23647
+ # Immutable. Identifier. The fully qualified resource name of the engine. This
23648
+ # field must be a UTF-8 encoded string with a length limit of 1024 characters.
23649
+ # Format: `projects/`project`/locations/`location`/collections/`collection`/
23650
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
23651
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
22840
23652
  # Corresponds to the JSON property `name`
22841
23653
  # @return [String]
22842
23654
  attr_accessor :name
@@ -22870,6 +23682,7 @@ module Google
22870
23682
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
22871
23683
  @display_name = args[:display_name] if args.key?(:display_name)
22872
23684
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
23685
+ @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
22873
23686
  @name = args[:name] if args.key?(:name)
22874
23687
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
22875
23688
  @solution_type = args[:solution_type] if args.key?(:solution_type)
@@ -23011,6 +23824,157 @@ module Google
23011
23824
  end
23012
23825
  end
23013
23826
 
23827
+ # Additional config specs for a Media Recommendation engine.
23828
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig
23829
+ include Google::Apis::Core::Hashable
23830
+
23831
+ # More feature configs of the selected engine type.
23832
+ # Corresponds to the JSON property `engineFeaturesConfig`
23833
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
23834
+ attr_accessor :engine_features_config
23835
+
23836
+ # The optimization objective. e.g., `cvr`. This field together with
23837
+ # optimization_objective describe engine metadata to use to control engine
23838
+ # training and serving. Currently supported values: `ctr`, `cvr`. If not
23839
+ # specified, we choose default based on engine type. Default depends on type of
23840
+ # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
23841
+ # Corresponds to the JSON property `optimizationObjective`
23842
+ # @return [String]
23843
+ attr_accessor :optimization_objective
23844
+
23845
+ # Custom threshold for `cvr` optimization_objective.
23846
+ # Corresponds to the JSON property `optimizationObjectiveConfig`
23847
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
23848
+ attr_accessor :optimization_objective_config
23849
+
23850
+ # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
23851
+ # part of the cost of running the service is frequency of training - this can be
23852
+ # used to determine when to train engine in order to control cost. If not
23853
+ # specified: the default value for `CreateEngine` method is `TRAINING`. The
23854
+ # default value for `UpdateEngine` method is to keep the state the same as
23855
+ # before.
23856
+ # Corresponds to the JSON property `trainingState`
23857
+ # @return [String]
23858
+ attr_accessor :training_state
23859
+
23860
+ # Required. The type of engine. e.g., `recommended-for-you`. This field together
23861
+ # with optimization_objective describe engine metadata to use to control engine
23862
+ # training and serving. Currently supported values: `recommended-for-you`, `
23863
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
23864
+ # Corresponds to the JSON property `type`
23865
+ # @return [String]
23866
+ attr_accessor :type
23867
+
23868
+ def initialize(**args)
23869
+ update!(**args)
23870
+ end
23871
+
23872
+ # Update properties of this object
23873
+ def update!(**args)
23874
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
23875
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
23876
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
23877
+ @training_state = args[:training_state] if args.key?(:training_state)
23878
+ @type = args[:type] if args.key?(:type)
23879
+ end
23880
+ end
23881
+
23882
+ # More feature configs of the selected engine type.
23883
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
23884
+ include Google::Apis::Core::Hashable
23885
+
23886
+ # Feature configurations that are required for creating a Most Popular engine.
23887
+ # Corresponds to the JSON property `mostPopularConfig`
23888
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
23889
+ attr_accessor :most_popular_config
23890
+
23891
+ # Additional feature configurations for creating a `recommended-for-you` engine.
23892
+ # Corresponds to the JSON property `recommendedForYouConfig`
23893
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
23894
+ attr_accessor :recommended_for_you_config
23895
+
23896
+ def initialize(**args)
23897
+ update!(**args)
23898
+ end
23899
+
23900
+ # Update properties of this object
23901
+ def update!(**args)
23902
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
23903
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
23904
+ end
23905
+ end
23906
+
23907
+ # Feature configurations that are required for creating a Most Popular engine.
23908
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
23909
+ include Google::Apis::Core::Hashable
23910
+
23911
+ # The time window of which the engine is queried at training and prediction time.
23912
+ # Positive integers only. The value translates to the last X days of events.
23913
+ # Currently required for the `most-popular-items` engine.
23914
+ # Corresponds to the JSON property `timeWindowDays`
23915
+ # @return [Fixnum]
23916
+ attr_accessor :time_window_days
23917
+
23918
+ def initialize(**args)
23919
+ update!(**args)
23920
+ end
23921
+
23922
+ # Update properties of this object
23923
+ def update!(**args)
23924
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
23925
+ end
23926
+ end
23927
+
23928
+ # Custom threshold for `cvr` optimization_objective.
23929
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
23930
+ include Google::Apis::Core::Hashable
23931
+
23932
+ # Required. The name of the field to target. Currently supported values: `watch-
23933
+ # percentage`, `watch-time`.
23934
+ # Corresponds to the JSON property `targetField`
23935
+ # @return [String]
23936
+ attr_accessor :target_field
23937
+
23938
+ # Required. The threshold to be applied to the target (e.g., 0.5).
23939
+ # Corresponds to the JSON property `targetFieldValueFloat`
23940
+ # @return [Float]
23941
+ attr_accessor :target_field_value_float
23942
+
23943
+ def initialize(**args)
23944
+ update!(**args)
23945
+ end
23946
+
23947
+ # Update properties of this object
23948
+ def update!(**args)
23949
+ @target_field = args[:target_field] if args.key?(:target_field)
23950
+ @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
23951
+ end
23952
+ end
23953
+
23954
+ # Additional feature configurations for creating a `recommended-for-you` engine.
23955
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
23956
+ include Google::Apis::Core::Hashable
23957
+
23958
+ # The type of event with which the engine is queried at prediction time. If set
23959
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
23960
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
23961
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
23962
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
23963
+ # engine. Currently supported values: `view-home-page`, `generic`.
23964
+ # Corresponds to the JSON property `contextEventType`
23965
+ # @return [String]
23966
+ attr_accessor :context_event_type
23967
+
23968
+ def initialize(**args)
23969
+ update!(**args)
23970
+ end
23971
+
23972
+ # Update properties of this object
23973
+ def update!(**args)
23974
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
23975
+ end
23976
+ end
23977
+
23014
23978
  # Configurations for a Search Engine.
23015
23979
  class GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
23016
23980
  include Google::Apis::Core::Hashable
@@ -25114,6 +26078,14 @@ module Google
25114
26078
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec]
25115
26079
  attr_accessor :boost_spec
25116
26080
 
26081
+ # Optional. Custom search operators which if specified will be used to filter
26082
+ # results from workspace data stores. For more information on custom search
26083
+ # operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/
26084
+ # 6172299).
26085
+ # Corresponds to the JSON property `customSearchOperators`
26086
+ # @return [String]
26087
+ attr_accessor :custom_search_operators
26088
+
25117
26089
  # Required. Full resource name of DataStore, such as `projects/`project`/
25118
26090
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
25119
26091
  # Corresponds to the JSON property `dataStore`
@@ -25134,6 +26106,7 @@ module Google
25134
26106
  # Update properties of this object
25135
26107
  def update!(**args)
25136
26108
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
26109
+ @custom_search_operators = args[:custom_search_operators] if args.key?(:custom_search_operators)
25137
26110
  @data_store = args[:data_store] if args.key?(:data_store)
25138
26111
  @filter = args[:filter] if args.key?(:filter)
25139
26112
  end
@@ -26092,6 +27065,12 @@ module Google
26092
27065
  # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaRequestInfo]
26093
27066
  attr_accessor :media_request_info
26094
27067
 
27068
+ # The source id of the associated file. If not set, a source id will be
27069
+ # generated and a new tentative source will be created.
27070
+ # Corresponds to the JSON property `sourceId`
27071
+ # @return [String]
27072
+ attr_accessor :source_id
27073
+
26095
27074
  def initialize(**args)
26096
27075
  update!(**args)
26097
27076
  end
@@ -26100,6 +27079,7 @@ module Google
26100
27079
  def update!(**args)
26101
27080
  @blob = args[:blob] if args.key?(:blob)
26102
27081
  @media_request_info = args[:media_request_info] if args.key?(:media_request_info)
27082
+ @source_id = args[:source_id] if args.key?(:source_id)
26103
27083
  end
26104
27084
  end
26105
27085