google-apis-discoveryengine_v1beta 0.62.0 → 0.64.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.
@@ -786,6 +786,87 @@ module Google
786
786
  end
787
787
  end
788
788
 
789
+ # The specification for answer generation.
790
+ class GoogleCloudDiscoveryengineV1AnswerGenerationSpec
791
+ include Google::Apis::Core::Hashable
792
+
793
+ # The specification for user defined classifier.
794
+ # Corresponds to the JSON property `userDefinedClassifierSpec`
795
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec]
796
+ attr_accessor :user_defined_classifier_spec
797
+
798
+ def initialize(**args)
799
+ update!(**args)
800
+ end
801
+
802
+ # Update properties of this object
803
+ def update!(**args)
804
+ @user_defined_classifier_spec = args[:user_defined_classifier_spec] if args.key?(:user_defined_classifier_spec)
805
+ end
806
+ end
807
+
808
+ # The specification for user defined classifier.
809
+ class GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec
810
+ include Google::Apis::Core::Hashable
811
+
812
+ # Optional. Whether or not to enable and include user defined classifier.
813
+ # Corresponds to the JSON property `enableUserDefinedClassifier`
814
+ # @return [Boolean]
815
+ attr_accessor :enable_user_defined_classifier
816
+ alias_method :enable_user_defined_classifier?, :enable_user_defined_classifier
817
+
818
+ # Optional. The model id to be used for the user defined classifier.
819
+ # Corresponds to the JSON property `modelId`
820
+ # @return [String]
821
+ attr_accessor :model_id
822
+
823
+ # Optional. The preamble to be used for the user defined classifier.
824
+ # Corresponds to the JSON property `preamble`
825
+ # @return [String]
826
+ attr_accessor :preamble
827
+
828
+ # Optional. The seed value to be used for the user defined classifier.
829
+ # Corresponds to the JSON property `seed`
830
+ # @return [Fixnum]
831
+ attr_accessor :seed
832
+
833
+ # Optional. The task marker to be used for the user defined classifier.
834
+ # Corresponds to the JSON property `taskMarker`
835
+ # @return [String]
836
+ attr_accessor :task_marker
837
+
838
+ # Optional. The temperature value to be used for the user defined classifier.
839
+ # Corresponds to the JSON property `temperature`
840
+ # @return [Float]
841
+ attr_accessor :temperature
842
+
843
+ # Optional. The top-k value to be used for the user defined classifier.
844
+ # Corresponds to the JSON property `topK`
845
+ # @return [Fixnum]
846
+ attr_accessor :top_k
847
+
848
+ # Optional. The top-p value to be used for the user defined classifier.
849
+ # Corresponds to the JSON property `topP`
850
+ # @return [Float]
851
+ attr_accessor :top_p
852
+
853
+ def initialize(**args)
854
+ update!(**args)
855
+ end
856
+
857
+ # Update properties of this object
858
+ def update!(**args)
859
+ @enable_user_defined_classifier = args[:enable_user_defined_classifier] if args.key?(:enable_user_defined_classifier)
860
+ @model_id = args[:model_id] if args.key?(:model_id)
861
+ @preamble = args[:preamble] if args.key?(:preamble)
862
+ @seed = args[:seed] if args.key?(:seed)
863
+ @task_marker = args[:task_marker] if args.key?(:task_marker)
864
+ @temperature = args[:temperature] if args.key?(:temperature)
865
+ @top_k = args[:top_k] if args.key?(:top_k)
866
+ @top_p = args[:top_p] if args.key?(:top_p)
867
+ end
868
+ end
869
+
789
870
  # Metadata related to the progress of the SiteSearchEngineService.
790
871
  # BatchCreateTargetSites operation. This will be returned by the google.
791
872
  # longrunning.Operation.metadata field.
@@ -2061,6 +2142,21 @@ module Google
2061
2142
  attr_accessor :enable_table_annotation
2062
2143
  alias_method :enable_table_annotation?, :enable_table_annotation
2063
2144
 
2145
+ # Optional. List of HTML classes to exclude from the parsed content.
2146
+ # Corresponds to the JSON property `excludeHtmlClasses`
2147
+ # @return [Array<String>]
2148
+ attr_accessor :exclude_html_classes
2149
+
2150
+ # Optional. List of HTML elements to exclude from the parsed content.
2151
+ # Corresponds to the JSON property `excludeHtmlElements`
2152
+ # @return [Array<String>]
2153
+ attr_accessor :exclude_html_elements
2154
+
2155
+ # Optional. List of HTML ids to exclude from the parsed content.
2156
+ # Corresponds to the JSON property `excludeHtmlIds`
2157
+ # @return [Array<String>]
2158
+ attr_accessor :exclude_html_ids
2159
+
2064
2160
  def initialize(**args)
2065
2161
  update!(**args)
2066
2162
  end
@@ -2069,6 +2165,9 @@ module Google
2069
2165
  def update!(**args)
2070
2166
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
2071
2167
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
2168
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
2169
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
2170
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
2072
2171
  end
2073
2172
  end
2074
2173
 
@@ -2195,6 +2294,11 @@ module Google
2195
2294
  # @return [String]
2196
2295
  attr_accessor :industry_vertical
2197
2296
 
2297
+ # Additional config specs for a Media Recommendation engine.
2298
+ # Corresponds to the JSON property `mediaRecommendationEngineConfig`
2299
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig]
2300
+ attr_accessor :media_recommendation_engine_config
2301
+
2198
2302
  # Immutable. The fully qualified resource name of the engine. This field must be
2199
2303
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
2200
2304
  # projects/`project`/locations/`location`/collections/`collection`/engines/`
@@ -2233,6 +2337,7 @@ module Google
2233
2337
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
2234
2338
  @display_name = args[:display_name] if args.key?(:display_name)
2235
2339
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
2340
+ @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
2236
2341
  @name = args[:name] if args.key?(:name)
2237
2342
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
2238
2343
  @solution_type = args[:solution_type] if args.key?(:solution_type)
@@ -2374,6 +2479,157 @@ module Google
2374
2479
  end
2375
2480
  end
2376
2481
 
2482
+ # Additional config specs for a Media Recommendation engine.
2483
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig
2484
+ include Google::Apis::Core::Hashable
2485
+
2486
+ # More feature configs of the selected engine type.
2487
+ # Corresponds to the JSON property `engineFeaturesConfig`
2488
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig]
2489
+ attr_accessor :engine_features_config
2490
+
2491
+ # The optimization objective. e.g., `cvr`. This field together with
2492
+ # optimization_objective describe engine metadata to use to control engine
2493
+ # training and serving. Currently supported values: `ctr`, `cvr`. If not
2494
+ # specified, we choose default based on engine type. Default depends on type of
2495
+ # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
2496
+ # Corresponds to the JSON property `optimizationObjective`
2497
+ # @return [String]
2498
+ attr_accessor :optimization_objective
2499
+
2500
+ # Custom threshold for `cvr` optimization_objective.
2501
+ # Corresponds to the JSON property `optimizationObjectiveConfig`
2502
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
2503
+ attr_accessor :optimization_objective_config
2504
+
2505
+ # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
2506
+ # part of the cost of running the service is frequency of training - this can be
2507
+ # used to determine when to train engine in order to control cost. If not
2508
+ # specified: the default value for `CreateEngine` method is `TRAINING`. The
2509
+ # default value for `UpdateEngine` method is to keep the state the same as
2510
+ # before.
2511
+ # Corresponds to the JSON property `trainingState`
2512
+ # @return [String]
2513
+ attr_accessor :training_state
2514
+
2515
+ # Required. The type of engine. e.g., `recommended-for-you`. This field together
2516
+ # with optimization_objective describe engine metadata to use to control engine
2517
+ # training and serving. Currently supported values: `recommended-for-you`, `
2518
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
2519
+ # Corresponds to the JSON property `type`
2520
+ # @return [String]
2521
+ attr_accessor :type
2522
+
2523
+ def initialize(**args)
2524
+ update!(**args)
2525
+ end
2526
+
2527
+ # Update properties of this object
2528
+ def update!(**args)
2529
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
2530
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
2531
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
2532
+ @training_state = args[:training_state] if args.key?(:training_state)
2533
+ @type = args[:type] if args.key?(:type)
2534
+ end
2535
+ end
2536
+
2537
+ # More feature configs of the selected engine type.
2538
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig
2539
+ include Google::Apis::Core::Hashable
2540
+
2541
+ # Feature configurations that are required for creating a Most Popular engine.
2542
+ # Corresponds to the JSON property `mostPopularConfig`
2543
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
2544
+ attr_accessor :most_popular_config
2545
+
2546
+ # Additional feature configurations for creating a `recommended-for-you` engine.
2547
+ # Corresponds to the JSON property `recommendedForYouConfig`
2548
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
2549
+ attr_accessor :recommended_for_you_config
2550
+
2551
+ def initialize(**args)
2552
+ update!(**args)
2553
+ end
2554
+
2555
+ # Update properties of this object
2556
+ def update!(**args)
2557
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
2558
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
2559
+ end
2560
+ end
2561
+
2562
+ # Feature configurations that are required for creating a Most Popular engine.
2563
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig
2564
+ include Google::Apis::Core::Hashable
2565
+
2566
+ # The time window of which the engine is queried at training and prediction time.
2567
+ # Positive integers only. The value translates to the last X days of events.
2568
+ # Currently required for the `most-popular-items` engine.
2569
+ # Corresponds to the JSON property `timeWindowDays`
2570
+ # @return [Fixnum]
2571
+ attr_accessor :time_window_days
2572
+
2573
+ def initialize(**args)
2574
+ update!(**args)
2575
+ end
2576
+
2577
+ # Update properties of this object
2578
+ def update!(**args)
2579
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
2580
+ end
2581
+ end
2582
+
2583
+ # Custom threshold for `cvr` optimization_objective.
2584
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
2585
+ include Google::Apis::Core::Hashable
2586
+
2587
+ # Required. The name of the field to target. Currently supported values: `watch-
2588
+ # percentage`, `watch-time`.
2589
+ # Corresponds to the JSON property `targetField`
2590
+ # @return [String]
2591
+ attr_accessor :target_field
2592
+
2593
+ # Required. The threshold to be applied to the target (e.g., 0.5).
2594
+ # Corresponds to the JSON property `targetFieldValueFloat`
2595
+ # @return [Float]
2596
+ attr_accessor :target_field_value_float
2597
+
2598
+ def initialize(**args)
2599
+ update!(**args)
2600
+ end
2601
+
2602
+ # Update properties of this object
2603
+ def update!(**args)
2604
+ @target_field = args[:target_field] if args.key?(:target_field)
2605
+ @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
2606
+ end
2607
+ end
2608
+
2609
+ # Additional feature configurations for creating a `recommended-for-you` engine.
2610
+ class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
2611
+ include Google::Apis::Core::Hashable
2612
+
2613
+ # The type of event with which the engine is queried at prediction time. If set
2614
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
2615
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
2616
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
2617
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
2618
+ # engine. Currently supported values: `view-home-page`, `generic`.
2619
+ # Corresponds to the JSON property `contextEventType`
2620
+ # @return [String]
2621
+ attr_accessor :context_event_type
2622
+
2623
+ def initialize(**args)
2624
+ update!(**args)
2625
+ end
2626
+
2627
+ # Update properties of this object
2628
+ def update!(**args)
2629
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
2630
+ end
2631
+ end
2632
+
2377
2633
  # Configurations for a Search Engine.
2378
2634
  class GoogleCloudDiscoveryengineV1EngineSearchEngineConfig
2379
2635
  include Google::Apis::Core::Hashable
@@ -3496,6 +3752,11 @@ module Google
3496
3752
  class GoogleCloudDiscoveryengineV1ServingConfig
3497
3753
  include Google::Apis::Core::Hashable
3498
3754
 
3755
+ # The specification for answer generation.
3756
+ # Corresponds to the JSON property `answerGenerationSpec`
3757
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AnswerGenerationSpec]
3758
+ attr_accessor :answer_generation_spec
3759
+
3499
3760
  # Boost controls to use in serving path. All triggered boost controls will be
3500
3761
  # applied. Boost controls must be in the same data store as the serving config.
3501
3762
  # Maximum of 20 boost controls.
@@ -3652,6 +3913,7 @@ module Google
3652
3913
 
3653
3914
  # Update properties of this object
3654
3915
  def update!(**args)
3916
+ @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
3655
3917
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
3656
3918
  @create_time = args[:create_time] if args.key?(:create_time)
3657
3919
  @display_name = args[:display_name] if args.key?(:display_name)
@@ -5125,6 +5387,71 @@ module Google
5125
5387
  end
5126
5388
  end
5127
5389
 
5390
+ # Metadata related to the progress of the UserLicenseService.
5391
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
5392
+ # longrunning.Operation.metadata field.
5393
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata
5394
+ include Google::Apis::Core::Hashable
5395
+
5396
+ # Operation create time.
5397
+ # Corresponds to the JSON property `createTime`
5398
+ # @return [String]
5399
+ attr_accessor :create_time
5400
+
5401
+ # Count of user licenses that failed to be updated.
5402
+ # Corresponds to the JSON property `failureCount`
5403
+ # @return [Fixnum]
5404
+ attr_accessor :failure_count
5405
+
5406
+ # Count of user licenses successfully updated.
5407
+ # Corresponds to the JSON property `successCount`
5408
+ # @return [Fixnum]
5409
+ attr_accessor :success_count
5410
+
5411
+ # Operation last update time. If the operation is done, this is also the finish
5412
+ # time.
5413
+ # Corresponds to the JSON property `updateTime`
5414
+ # @return [String]
5415
+ attr_accessor :update_time
5416
+
5417
+ def initialize(**args)
5418
+ update!(**args)
5419
+ end
5420
+
5421
+ # Update properties of this object
5422
+ def update!(**args)
5423
+ @create_time = args[:create_time] if args.key?(:create_time)
5424
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
5425
+ @success_count = args[:success_count] if args.key?(:success_count)
5426
+ @update_time = args[:update_time] if args.key?(:update_time)
5427
+ end
5428
+ end
5429
+
5430
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
5431
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse
5432
+ include Google::Apis::Core::Hashable
5433
+
5434
+ # A sample of errors encountered while processing the request.
5435
+ # Corresponds to the JSON property `errorSamples`
5436
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
5437
+ attr_accessor :error_samples
5438
+
5439
+ # UserLicenses successfully updated.
5440
+ # Corresponds to the JSON property `userLicenses`
5441
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaUserLicense>]
5442
+ attr_accessor :user_licenses
5443
+
5444
+ def initialize(**args)
5445
+ update!(**args)
5446
+ end
5447
+
5448
+ # Update properties of this object
5449
+ def update!(**args)
5450
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
5451
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
5452
+ end
5453
+ end
5454
+
5128
5455
  # Configurations used to enable CMEK data encryption with Cloud KMS keys.
5129
5456
  class GoogleCloudDiscoveryengineV1alphaCmekConfig
5130
5457
  include Google::Apis::Core::Hashable
@@ -6046,6 +6373,13 @@ module Google
6046
6373
  class GoogleCloudDiscoveryengineV1alphaDataConnector
6047
6374
  include Google::Apis::Core::Hashable
6048
6375
 
6376
+ # Optional. Whether the connector will be created with an ACL config. Currently
6377
+ # this field only affects Cloud Storage and BigQuery connectors.
6378
+ # Corresponds to the JSON property `aclEnabled`
6379
+ # @return [Boolean]
6380
+ attr_accessor :acl_enabled
6381
+ alias_method :acl_enabled?, :acl_enabled
6382
+
6049
6383
  # Informations to support actions on the connector.
6050
6384
  # Corresponds to the JSON property `actionConfig`
6051
6385
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaActionConfig]
@@ -6074,13 +6408,25 @@ module Google
6074
6408
  # @return [Array<String>]
6075
6409
  attr_accessor :blocking_reasons
6076
6410
 
6411
+ # Optional. The modes enabled for this connector. Default state is
6412
+ # CONNECTOR_MODE_UNSPECIFIED.
6413
+ # Corresponds to the JSON property `connectorModes`
6414
+ # @return [Array<String>]
6415
+ attr_accessor :connector_modes
6416
+
6077
6417
  # Output only. The type of connector. Each source can only map to one type. For
6078
6418
  # example, salesforce, confluence and jira have THIRD_PARTY connector type. It
6079
- # is notmutable once set by system.
6419
+ # is not mutable once set by system.
6080
6420
  # Corresponds to the JSON property `connectorType`
6081
6421
  # @return [String]
6082
6422
  attr_accessor :connector_type
6083
6423
 
6424
+ # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
6425
+ # Corresponds to the JSON property `createEuaSaas`
6426
+ # @return [Boolean]
6427
+ attr_accessor :create_eua_saas
6428
+ alias_method :create_eua_saas?, :create_eua_saas
6429
+
6084
6430
  # Output only. Timestamp the DataConnector was created at.
6085
6431
  # Corresponds to the JSON property `createTime`
6086
6432
  # @return [String]
@@ -6097,6 +6443,11 @@ module Google
6097
6443
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDestinationConfig>]
6098
6444
  attr_accessor :destination_configs
6099
6445
 
6446
+ # Any params and credentials used specifically for EUA connectors.
6447
+ # Corresponds to the JSON property `endUserConfig`
6448
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig]
6449
+ attr_accessor :end_user_config
6450
+
6100
6451
  # List of entities from the connected data source to ingest.
6101
6452
  # Corresponds to the JSON property `entities`
6102
6453
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>]
@@ -6250,15 +6601,19 @@ module Google
6250
6601
 
6251
6602
  # Update properties of this object
6252
6603
  def update!(**args)
6604
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
6253
6605
  @action_config = args[:action_config] if args.key?(:action_config)
6254
6606
  @alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
6255
6607
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
6256
6608
  @bap_config = args[:bap_config] if args.key?(:bap_config)
6257
6609
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
6610
+ @connector_modes = args[:connector_modes] if args.key?(:connector_modes)
6258
6611
  @connector_type = args[:connector_type] if args.key?(:connector_type)
6612
+ @create_eua_saas = args[:create_eua_saas] if args.key?(:create_eua_saas)
6259
6613
  @create_time = args[:create_time] if args.key?(:create_time)
6260
6614
  @data_source = args[:data_source] if args.key?(:data_source)
6261
6615
  @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
6616
+ @end_user_config = args[:end_user_config] if args.key?(:end_user_config)
6262
6617
  @entities = args[:entities] if args.key?(:entities)
6263
6618
  @errors = args[:errors] if args.key?(:errors)
6264
6619
  @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
@@ -6281,6 +6636,31 @@ module Google
6281
6636
  end
6282
6637
  end
6283
6638
 
6639
+ # Any params and credentials used specifically for EUA connectors.
6640
+ class GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig
6641
+ include Google::Apis::Core::Hashable
6642
+
6643
+ # Optional. Any additional parameters needed for EUA.
6644
+ # Corresponds to the JSON property `additionalParams`
6645
+ # @return [Hash<String,Object>]
6646
+ attr_accessor :additional_params
6647
+
6648
+ # Optional. Any authentication parameters specific to EUA connectors.
6649
+ # Corresponds to the JSON property `authParams`
6650
+ # @return [Hash<String,Object>]
6651
+ attr_accessor :auth_params
6652
+
6653
+ def initialize(**args)
6654
+ update!(**args)
6655
+ end
6656
+
6657
+ # Update properties of this object
6658
+ def update!(**args)
6659
+ @additional_params = args[:additional_params] if args.key?(:additional_params)
6660
+ @auth_params = args[:auth_params] if args.key?(:auth_params)
6661
+ end
6662
+ end
6663
+
6284
6664
  # The configuration for realtime sync to store additional params for realtime
6285
6665
  # sync.
6286
6666
  class GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig
@@ -7144,6 +7524,21 @@ module Google
7144
7524
  attr_accessor :enable_table_annotation
7145
7525
  alias_method :enable_table_annotation?, :enable_table_annotation
7146
7526
 
7527
+ # Optional. List of HTML classes to exclude from the parsed content.
7528
+ # Corresponds to the JSON property `excludeHtmlClasses`
7529
+ # @return [Array<String>]
7530
+ attr_accessor :exclude_html_classes
7531
+
7532
+ # Optional. List of HTML elements to exclude from the parsed content.
7533
+ # Corresponds to the JSON property `excludeHtmlElements`
7534
+ # @return [Array<String>]
7535
+ attr_accessor :exclude_html_elements
7536
+
7537
+ # Optional. List of HTML ids to exclude from the parsed content.
7538
+ # Corresponds to the JSON property `excludeHtmlIds`
7539
+ # @return [Array<String>]
7540
+ attr_accessor :exclude_html_ids
7541
+
7147
7542
  def initialize(**args)
7148
7543
  update!(**args)
7149
7544
  end
@@ -7152,6 +7547,9 @@ module Google
7152
7547
  def update!(**args)
7153
7548
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
7154
7549
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
7550
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
7551
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
7552
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
7155
7553
  end
7156
7554
  end
7157
7555
 
@@ -7479,6 +7877,11 @@ module Google
7479
7877
  class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
7480
7878
  include Google::Apis::Core::Hashable
7481
7879
 
7880
+ # More feature configs of the selected engine type.
7881
+ # Corresponds to the JSON property `engineFeaturesConfig`
7882
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
7883
+ attr_accessor :engine_features_config
7884
+
7482
7885
  # The optimization objective. e.g., `cvr`. This field together with
7483
7886
  # optimization_objective describe engine metadata to use to control engine
7484
7887
  # training and serving. Currently supported values: `ctr`, `cvr`. If not
@@ -7517,6 +7920,7 @@ module Google
7517
7920
 
7518
7921
  # Update properties of this object
7519
7922
  def update!(**args)
7923
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
7520
7924
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
7521
7925
  @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
7522
7926
  @training_state = args[:training_state] if args.key?(:training_state)
@@ -7524,6 +7928,52 @@ module Google
7524
7928
  end
7525
7929
  end
7526
7930
 
7931
+ # More feature configs of the selected engine type.
7932
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
7933
+ include Google::Apis::Core::Hashable
7934
+
7935
+ # Feature configurations that are required for creating a Most Popular engine.
7936
+ # Corresponds to the JSON property `mostPopularConfig`
7937
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
7938
+ attr_accessor :most_popular_config
7939
+
7940
+ # Additional feature configurations for creating a `recommended-for-you` engine.
7941
+ # Corresponds to the JSON property `recommendedForYouConfig`
7942
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
7943
+ attr_accessor :recommended_for_you_config
7944
+
7945
+ def initialize(**args)
7946
+ update!(**args)
7947
+ end
7948
+
7949
+ # Update properties of this object
7950
+ def update!(**args)
7951
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
7952
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
7953
+ end
7954
+ end
7955
+
7956
+ # Feature configurations that are required for creating a Most Popular engine.
7957
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
7958
+ include Google::Apis::Core::Hashable
7959
+
7960
+ # The time window of which the engine is queried at training and prediction time.
7961
+ # Positive integers only. The value translates to the last X days of events.
7962
+ # Currently required for the `most-popular-items` engine.
7963
+ # Corresponds to the JSON property `timeWindowDays`
7964
+ # @return [Fixnum]
7965
+ attr_accessor :time_window_days
7966
+
7967
+ def initialize(**args)
7968
+ update!(**args)
7969
+ end
7970
+
7971
+ # Update properties of this object
7972
+ def update!(**args)
7973
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
7974
+ end
7975
+ end
7976
+
7527
7977
  # Custom threshold for `cvr` optimization_objective.
7528
7978
  class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
7529
7979
  include Google::Apis::Core::Hashable
@@ -7550,6 +8000,30 @@ module Google
7550
8000
  end
7551
8001
  end
7552
8002
 
8003
+ # Additional feature configurations for creating a `recommended-for-you` engine.
8004
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
8005
+ include Google::Apis::Core::Hashable
8006
+
8007
+ # The type of event with which the engine is queried at prediction time. If set
8008
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
8009
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
8010
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
8011
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
8012
+ # engine. Currently supported values: `view-home-page`, `generic`.
8013
+ # Corresponds to the JSON property `contextEventType`
8014
+ # @return [String]
8015
+ attr_accessor :context_event_type
8016
+
8017
+ def initialize(**args)
8018
+ update!(**args)
8019
+ end
8020
+
8021
+ # Update properties of this object
8022
+ def update!(**args)
8023
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
8024
+ end
8025
+ end
8026
+
7553
8027
  # Additional information of a recommendation engine.
7554
8028
  class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
7555
8029
  include Google::Apis::Core::Hashable
@@ -10487,6 +10961,14 @@ module Google
10487
10961
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec]
10488
10962
  attr_accessor :boost_spec
10489
10963
 
10964
+ # Optional. Custom search operators which if specified will be used to filter
10965
+ # results from workspace data stores. For more information on custom search
10966
+ # operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/
10967
+ # 6172299).
10968
+ # Corresponds to the JSON property `customSearchOperators`
10969
+ # @return [String]
10970
+ attr_accessor :custom_search_operators
10971
+
10490
10972
  # Required. Full resource name of DataStore, such as `projects/`project`/
10491
10973
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
10492
10974
  # Corresponds to the JSON property `dataStore`
@@ -10507,6 +10989,7 @@ module Google
10507
10989
  # Update properties of this object
10508
10990
  def update!(**args)
10509
10991
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
10992
+ @custom_search_operators = args[:custom_search_operators] if args.key?(:custom_search_operators)
10510
10993
  @data_store = args[:data_store] if args.key?(:data_store)
10511
10994
  @filter = args[:filter] if args.key?(:filter)
10512
10995
  end
@@ -11626,6 +12109,79 @@ module Google
11626
12109
  end
11627
12110
  end
11628
12111
 
12112
+ # User License information assigned by the admin.
12113
+ class GoogleCloudDiscoveryengineV1alphaUserLicense
12114
+ include Google::Apis::Core::Hashable
12115
+
12116
+ # Output only. User created timestamp.
12117
+ # Corresponds to the JSON property `createTime`
12118
+ # @return [String]
12119
+ attr_accessor :create_time
12120
+
12121
+ # Output only. User last logged in time. If the user has not logged in yet, this
12122
+ # field will be empty.
12123
+ # Corresponds to the JSON property `lastLoginTime`
12124
+ # @return [String]
12125
+ attr_accessor :last_login_time
12126
+
12127
+ # Output only. License assignment state of the user. If the user is assigned
12128
+ # with a license config, the user loggin will be assigned with the license; If
12129
+ # the user's license assignment state is unassigned or unspecified, no license
12130
+ # config will be associated to the user;
12131
+ # Corresponds to the JSON property `licenseAssignmentState`
12132
+ # @return [String]
12133
+ attr_accessor :license_assignment_state
12134
+
12135
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
12136
+ # to the user.
12137
+ # Corresponds to the JSON property `licenseConfig`
12138
+ # @return [String]
12139
+ attr_accessor :license_config
12140
+
12141
+ # Output only. User update timestamp.
12142
+ # Corresponds to the JSON property `updateTime`
12143
+ # @return [String]
12144
+ attr_accessor :update_time
12145
+
12146
+ # Optional. The full resource name of the User, in the format of `projects/`
12147
+ # project`/locations/`location`/userStores/`user_store`/users/`user_id``. This
12148
+ # field must be a UTF-8 encoded string with a length limit of 2048 characters.
12149
+ # If the user field is empty, it's indicating the user has not logged in yet and
12150
+ # no User entity is created.
12151
+ # Corresponds to the JSON property `user`
12152
+ # @return [String]
12153
+ attr_accessor :user
12154
+
12155
+ # Required. Immutable. The user principal of the User, could be email address or
12156
+ # other prinical identifier. This field is immutable. Admin assign licenses
12157
+ # based on the user principal.
12158
+ # Corresponds to the JSON property `userPrincipal`
12159
+ # @return [String]
12160
+ attr_accessor :user_principal
12161
+
12162
+ # Optional. The user profile. We user user full name(First name + Last name) as
12163
+ # user profile.
12164
+ # Corresponds to the JSON property `userProfile`
12165
+ # @return [String]
12166
+ attr_accessor :user_profile
12167
+
12168
+ def initialize(**args)
12169
+ update!(**args)
12170
+ end
12171
+
12172
+ # Update properties of this object
12173
+ def update!(**args)
12174
+ @create_time = args[:create_time] if args.key?(:create_time)
12175
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
12176
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
12177
+ @license_config = args[:license_config] if args.key?(:license_config)
12178
+ @update_time = args[:update_time] if args.key?(:update_time)
12179
+ @user = args[:user] if args.key?(:user)
12180
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
12181
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
12182
+ end
12183
+ end
12184
+
11629
12185
  # Config to store data store type configuration for workspace data
11630
12186
  class GoogleCloudDiscoveryengineV1alphaWorkspaceConfig
11631
12187
  include Google::Apis::Core::Hashable
@@ -11676,6 +12232,11 @@ module Google
11676
12232
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec]
11677
12233
  attr_accessor :boost_spec
11678
12234
 
12235
+ # Optional. Experiment ids for this request.
12236
+ # Corresponds to the JSON property `experimentIds`
12237
+ # @return [Array<String>]
12238
+ attr_accessor :experiment_ids
12239
+
11679
12240
  # Indicates if tail suggestions should be returned if there are no suggestions
11680
12241
  # that match the full query. Even if set to true, if there are suggestions that
11681
12242
  # match the full query, those are returned and no tail suggestions are returned.
@@ -11743,6 +12304,7 @@ module Google
11743
12304
  # Update properties of this object
11744
12305
  def update!(**args)
11745
12306
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
12307
+ @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
11746
12308
  @include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
11747
12309
  @query = args[:query] if args.key?(:query)
11748
12310
  @query_model = args[:query_model] if args.key?(:query_model)
@@ -12358,7 +12920,88 @@ module Google
12358
12920
 
12359
12921
  # Update properties of this object
12360
12922
  def update!(**args)
12361
- @reference_id = args[:reference_id] if args.key?(:reference_id)
12923
+ @reference_id = args[:reference_id] if args.key?(:reference_id)
12924
+ end
12925
+ end
12926
+
12927
+ # The specification for answer generation.
12928
+ class GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec
12929
+ include Google::Apis::Core::Hashable
12930
+
12931
+ # The specification for user defined classifier.
12932
+ # Corresponds to the JSON property `userDefinedClassifierSpec`
12933
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec]
12934
+ attr_accessor :user_defined_classifier_spec
12935
+
12936
+ def initialize(**args)
12937
+ update!(**args)
12938
+ end
12939
+
12940
+ # Update properties of this object
12941
+ def update!(**args)
12942
+ @user_defined_classifier_spec = args[:user_defined_classifier_spec] if args.key?(:user_defined_classifier_spec)
12943
+ end
12944
+ end
12945
+
12946
+ # The specification for user defined classifier.
12947
+ class GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec
12948
+ include Google::Apis::Core::Hashable
12949
+
12950
+ # Optional. Whether or not to enable and include user defined classifier.
12951
+ # Corresponds to the JSON property `enableUserDefinedClassifier`
12952
+ # @return [Boolean]
12953
+ attr_accessor :enable_user_defined_classifier
12954
+ alias_method :enable_user_defined_classifier?, :enable_user_defined_classifier
12955
+
12956
+ # Optional. The model id to be used for the user defined classifier.
12957
+ # Corresponds to the JSON property `modelId`
12958
+ # @return [String]
12959
+ attr_accessor :model_id
12960
+
12961
+ # Optional. The preamble to be used for the user defined classifier.
12962
+ # Corresponds to the JSON property `preamble`
12963
+ # @return [String]
12964
+ attr_accessor :preamble
12965
+
12966
+ # Optional. The seed value to be used for the user defined classifier.
12967
+ # Corresponds to the JSON property `seed`
12968
+ # @return [Fixnum]
12969
+ attr_accessor :seed
12970
+
12971
+ # Optional. The task marker to be used for the user defined classifier.
12972
+ # Corresponds to the JSON property `taskMarker`
12973
+ # @return [String]
12974
+ attr_accessor :task_marker
12975
+
12976
+ # Optional. The temperature value to be used for the user defined classifier.
12977
+ # Corresponds to the JSON property `temperature`
12978
+ # @return [Float]
12979
+ attr_accessor :temperature
12980
+
12981
+ # Optional. The top-k value to be used for the user defined classifier.
12982
+ # Corresponds to the JSON property `topK`
12983
+ # @return [Fixnum]
12984
+ attr_accessor :top_k
12985
+
12986
+ # Optional. The top-p value to be used for the user defined classifier.
12987
+ # Corresponds to the JSON property `topP`
12988
+ # @return [Float]
12989
+ attr_accessor :top_p
12990
+
12991
+ def initialize(**args)
12992
+ update!(**args)
12993
+ end
12994
+
12995
+ # Update properties of this object
12996
+ def update!(**args)
12997
+ @enable_user_defined_classifier = args[:enable_user_defined_classifier] if args.key?(:enable_user_defined_classifier)
12998
+ @model_id = args[:model_id] if args.key?(:model_id)
12999
+ @preamble = args[:preamble] if args.key?(:preamble)
13000
+ @seed = args[:seed] if args.key?(:seed)
13001
+ @task_marker = args[:task_marker] if args.key?(:task_marker)
13002
+ @temperature = args[:temperature] if args.key?(:temperature)
13003
+ @top_k = args[:top_k] if args.key?(:top_k)
13004
+ @top_p = args[:top_p] if args.key?(:top_p)
12362
13005
  end
12363
13006
  end
12364
13007
 
@@ -13986,6 +14629,66 @@ module Google
13986
14629
  end
13987
14630
  end
13988
14631
 
14632
+ # Request message for UserLicenseService.BatchUpdateUserLicenses method.
14633
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest
14634
+ include Google::Apis::Core::Hashable
14635
+
14636
+ # Optional. If true, if user licenses removed associated license config, the
14637
+ # user license will be deleted. By default which is false, the user license will
14638
+ # be updated to unassigned state.
14639
+ # Corresponds to the JSON property `deleteUnassignedUserLicenses`
14640
+ # @return [Boolean]
14641
+ attr_accessor :delete_unassigned_user_licenses
14642
+ alias_method :delete_unassigned_user_licenses?, :delete_unassigned_user_licenses
14643
+
14644
+ # Cloud Storage location for input content.
14645
+ # Corresponds to the JSON property `gcsSource`
14646
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource]
14647
+ attr_accessor :gcs_source
14648
+
14649
+ # The inline source for the input config for BatchUpdateUserLicenses method.
14650
+ # Corresponds to the JSON property `inlineSource`
14651
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource]
14652
+ attr_accessor :inline_source
14653
+
14654
+ def initialize(**args)
14655
+ update!(**args)
14656
+ end
14657
+
14658
+ # Update properties of this object
14659
+ def update!(**args)
14660
+ @delete_unassigned_user_licenses = args[:delete_unassigned_user_licenses] if args.key?(:delete_unassigned_user_licenses)
14661
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
14662
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
14663
+ end
14664
+ end
14665
+
14666
+ # The inline source for the input config for BatchUpdateUserLicenses method.
14667
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource
14668
+ include Google::Apis::Core::Hashable
14669
+
14670
+ # Optional. The list of fields to update.
14671
+ # Corresponds to the JSON property `updateMask`
14672
+ # @return [String]
14673
+ attr_accessor :update_mask
14674
+
14675
+ # Required. A list of user licenses to update. Each user license must have a
14676
+ # valid UserLicense.user_principal.
14677
+ # Corresponds to the JSON property `userLicenses`
14678
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserLicense>]
14679
+ attr_accessor :user_licenses
14680
+
14681
+ def initialize(**args)
14682
+ update!(**args)
14683
+ end
14684
+
14685
+ # Update properties of this object
14686
+ def update!(**args)
14687
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
14688
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
14689
+ end
14690
+ end
14691
+
13989
14692
  # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
13990
14693
  class GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest
13991
14694
  include Google::Apis::Core::Hashable
@@ -14372,6 +15075,13 @@ module Google
14372
15075
  attr_accessor :grounding_check_required
14373
15076
  alias_method :grounding_check_required?, :grounding_check_required
14374
15077
 
15078
+ # Confidence score for the claim in the answer candidate, in the range of [0, 1].
15079
+ # This is set only when `CheckGroundingRequest.grounding_spec.
15080
+ # enable_claim_level_score` is true.
15081
+ # Corresponds to the JSON property `score`
15082
+ # @return [Float]
15083
+ attr_accessor :score
15084
+
14375
15085
  # Position indicating the start of the claim in the answer candidate, measured
14376
15086
  # in bytes. Note that this is not measured in characters and, therefore, must be
14377
15087
  # rendered in the user interface keeping in mind that some characters may take
@@ -14393,6 +15103,7 @@ module Google
14393
15103
  @claim_text = args[:claim_text] if args.key?(:claim_text)
14394
15104
  @end_pos = args[:end_pos] if args.key?(:end_pos)
14395
15105
  @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
15106
+ @score = args[:score] if args.key?(:score)
14396
15107
  @start_pos = args[:start_pos] if args.key?(:start_pos)
14397
15108
  end
14398
15109
  end
@@ -14410,6 +15121,12 @@ module Google
14410
15121
  # @return [Float]
14411
15122
  attr_accessor :citation_threshold
14412
15123
 
15124
+ # The control flag that enables claim-level grounding score in the response.
15125
+ # Corresponds to the JSON property `enableClaimLevelScore`
15126
+ # @return [Boolean]
15127
+ attr_accessor :enable_claim_level_score
15128
+ alias_method :enable_claim_level_score?, :enable_claim_level_score
15129
+
14413
15130
  def initialize(**args)
14414
15131
  update!(**args)
14415
15132
  end
@@ -14417,6 +15134,7 @@ module Google
14417
15134
  # Update properties of this object
14418
15135
  def update!(**args)
14419
15136
  @citation_threshold = args[:citation_threshold] if args.key?(:citation_threshold)
15137
+ @enable_claim_level_score = args[:enable_claim_level_score] if args.key?(:enable_claim_level_score)
14420
15138
  end
14421
15139
  end
14422
15140
 
@@ -16442,15 +17160,15 @@ module Google
16442
17160
 
16443
17161
  # The MIME type of the content. Supported types: * `application/pdf` (PDF, only
16444
17162
  # native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) *
16445
- # `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-
16446
- # officedocument.wordprocessingml.document` (DOCX) * `application/vnd.
16447
- # openxmlformats-officedocument.presentationml.presentation` (PPTX) * `
16448
- # application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `
16449
- # application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are
16450
- # supported only if layout parser is enabled in the data store: * `image/bmp` (
16451
- # BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/
16452
- # tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.
16453
- # xhtml.
17163
+ # `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `
17164
+ # application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
17165
+ # * `application/vnd.openxmlformats-officedocument.presentationml.presentation`
17166
+ # (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (
17167
+ # XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following
17168
+ # types are supported only if layout parser is enabled in the data store: * `
17169
+ # image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG)
17170
+ # * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-
17171
+ # types.xhtml.
16454
17172
  # Corresponds to the JSON property `mimeType`
16455
17173
  # @return [String]
16456
17174
  attr_accessor :mime_type
@@ -16742,6 +17460,21 @@ module Google
16742
17460
  attr_accessor :enable_table_annotation
16743
17461
  alias_method :enable_table_annotation?, :enable_table_annotation
16744
17462
 
17463
+ # Optional. List of HTML classes to exclude from the parsed content.
17464
+ # Corresponds to the JSON property `excludeHtmlClasses`
17465
+ # @return [Array<String>]
17466
+ attr_accessor :exclude_html_classes
17467
+
17468
+ # Optional. List of HTML elements to exclude from the parsed content.
17469
+ # Corresponds to the JSON property `excludeHtmlElements`
17470
+ # @return [Array<String>]
17471
+ attr_accessor :exclude_html_elements
17472
+
17473
+ # Optional. List of HTML ids to exclude from the parsed content.
17474
+ # Corresponds to the JSON property `excludeHtmlIds`
17475
+ # @return [Array<String>]
17476
+ attr_accessor :exclude_html_ids
17477
+
16745
17478
  def initialize(**args)
16746
17479
  update!(**args)
16747
17480
  end
@@ -16750,6 +17483,9 @@ module Google
16750
17483
  def update!(**args)
16751
17484
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
16752
17485
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
17486
+ @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
17487
+ @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
17488
+ @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
16753
17489
  end
16754
17490
  end
16755
17491
 
@@ -16927,6 +17663,11 @@ module Google
16927
17663
  # @return [String]
16928
17664
  attr_accessor :industry_vertical
16929
17665
 
17666
+ # Additional config specs for a Media Recommendation engine.
17667
+ # Corresponds to the JSON property `mediaRecommendationEngineConfig`
17668
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig]
17669
+ attr_accessor :media_recommendation_engine_config
17670
+
16930
17671
  # Immutable. The fully qualified resource name of the engine. This field must be
16931
17672
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
16932
17673
  # projects/`project`/locations/`location`/collections/`collection`/engines/`
@@ -16965,6 +17706,7 @@ module Google
16965
17706
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
16966
17707
  @display_name = args[:display_name] if args.key?(:display_name)
16967
17708
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
17709
+ @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
16968
17710
  @name = args[:name] if args.key?(:name)
16969
17711
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
16970
17712
  @solution_type = args[:solution_type] if args.key?(:solution_type)
@@ -17106,6 +17848,157 @@ module Google
17106
17848
  end
17107
17849
  end
17108
17850
 
17851
+ # Additional config specs for a Media Recommendation engine.
17852
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig
17853
+ include Google::Apis::Core::Hashable
17854
+
17855
+ # More feature configs of the selected engine type.
17856
+ # Corresponds to the JSON property `engineFeaturesConfig`
17857
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
17858
+ attr_accessor :engine_features_config
17859
+
17860
+ # The optimization objective. e.g., `cvr`. This field together with
17861
+ # optimization_objective describe engine metadata to use to control engine
17862
+ # training and serving. Currently supported values: `ctr`, `cvr`. If not
17863
+ # specified, we choose default based on engine type. Default depends on type of
17864
+ # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
17865
+ # Corresponds to the JSON property `optimizationObjective`
17866
+ # @return [String]
17867
+ attr_accessor :optimization_objective
17868
+
17869
+ # Custom threshold for `cvr` optimization_objective.
17870
+ # Corresponds to the JSON property `optimizationObjectiveConfig`
17871
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
17872
+ attr_accessor :optimization_objective_config
17873
+
17874
+ # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
17875
+ # part of the cost of running the service is frequency of training - this can be
17876
+ # used to determine when to train engine in order to control cost. If not
17877
+ # specified: the default value for `CreateEngine` method is `TRAINING`. The
17878
+ # default value for `UpdateEngine` method is to keep the state the same as
17879
+ # before.
17880
+ # Corresponds to the JSON property `trainingState`
17881
+ # @return [String]
17882
+ attr_accessor :training_state
17883
+
17884
+ # Required. The type of engine. e.g., `recommended-for-you`. This field together
17885
+ # with optimization_objective describe engine metadata to use to control engine
17886
+ # training and serving. Currently supported values: `recommended-for-you`, `
17887
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
17888
+ # Corresponds to the JSON property `type`
17889
+ # @return [String]
17890
+ attr_accessor :type
17891
+
17892
+ def initialize(**args)
17893
+ update!(**args)
17894
+ end
17895
+
17896
+ # Update properties of this object
17897
+ def update!(**args)
17898
+ @engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
17899
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
17900
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
17901
+ @training_state = args[:training_state] if args.key?(:training_state)
17902
+ @type = args[:type] if args.key?(:type)
17903
+ end
17904
+ end
17905
+
17906
+ # More feature configs of the selected engine type.
17907
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
17908
+ include Google::Apis::Core::Hashable
17909
+
17910
+ # Feature configurations that are required for creating a Most Popular engine.
17911
+ # Corresponds to the JSON property `mostPopularConfig`
17912
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
17913
+ attr_accessor :most_popular_config
17914
+
17915
+ # Additional feature configurations for creating a `recommended-for-you` engine.
17916
+ # Corresponds to the JSON property `recommendedForYouConfig`
17917
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
17918
+ attr_accessor :recommended_for_you_config
17919
+
17920
+ def initialize(**args)
17921
+ update!(**args)
17922
+ end
17923
+
17924
+ # Update properties of this object
17925
+ def update!(**args)
17926
+ @most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
17927
+ @recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
17928
+ end
17929
+ end
17930
+
17931
+ # Feature configurations that are required for creating a Most Popular engine.
17932
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
17933
+ include Google::Apis::Core::Hashable
17934
+
17935
+ # The time window of which the engine is queried at training and prediction time.
17936
+ # Positive integers only. The value translates to the last X days of events.
17937
+ # Currently required for the `most-popular-items` engine.
17938
+ # Corresponds to the JSON property `timeWindowDays`
17939
+ # @return [Fixnum]
17940
+ attr_accessor :time_window_days
17941
+
17942
+ def initialize(**args)
17943
+ update!(**args)
17944
+ end
17945
+
17946
+ # Update properties of this object
17947
+ def update!(**args)
17948
+ @time_window_days = args[:time_window_days] if args.key?(:time_window_days)
17949
+ end
17950
+ end
17951
+
17952
+ # Custom threshold for `cvr` optimization_objective.
17953
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
17954
+ include Google::Apis::Core::Hashable
17955
+
17956
+ # Required. The name of the field to target. Currently supported values: `watch-
17957
+ # percentage`, `watch-time`.
17958
+ # Corresponds to the JSON property `targetField`
17959
+ # @return [String]
17960
+ attr_accessor :target_field
17961
+
17962
+ # Required. The threshold to be applied to the target (e.g., 0.5).
17963
+ # Corresponds to the JSON property `targetFieldValueFloat`
17964
+ # @return [Float]
17965
+ attr_accessor :target_field_value_float
17966
+
17967
+ def initialize(**args)
17968
+ update!(**args)
17969
+ end
17970
+
17971
+ # Update properties of this object
17972
+ def update!(**args)
17973
+ @target_field = args[:target_field] if args.key?(:target_field)
17974
+ @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
17975
+ end
17976
+ end
17977
+
17978
+ # Additional feature configurations for creating a `recommended-for-you` engine.
17979
+ class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
17980
+ include Google::Apis::Core::Hashable
17981
+
17982
+ # The type of event with which the engine is queried at prediction time. If set
17983
+ # to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
17984
+ # as `context-event` in engine training. If set to `view-home-page`, `view-home-
17985
+ # page` will also be used as `context-events` in addition to `view-item`, `media-
17986
+ # play`, and `media-complete`. Currently supported for the `recommended-for-you`
17987
+ # engine. Currently supported values: `view-home-page`, `generic`.
17988
+ # Corresponds to the JSON property `contextEventType`
17989
+ # @return [String]
17990
+ attr_accessor :context_event_type
17991
+
17992
+ def initialize(**args)
17993
+ update!(**args)
17994
+ end
17995
+
17996
+ # Update properties of this object
17997
+ def update!(**args)
17998
+ @context_event_type = args[:context_event_type] if args.key?(:context_event_type)
17999
+ end
18000
+ end
18001
+
17109
18002
  # Configurations for a Search Engine.
17110
18003
  class GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
17111
18004
  include Google::Apis::Core::Hashable
@@ -17257,6 +18150,11 @@ module Google
17257
18150
  # @return [String]
17258
18151
  attr_accessor :chunk_text
17259
18152
 
18153
+ # The domain of the source.
18154
+ # Corresponds to the JSON property `domain`
18155
+ # @return [String]
18156
+ attr_accessor :domain
18157
+
17260
18158
  # The index of this chunk. Currently, only used for the streaming mode.
17261
18159
  # Corresponds to the JSON property `index`
17262
18160
  # @return [Fixnum]
@@ -17274,6 +18172,16 @@ module Google
17274
18172
  # @return [Hash<String,String>]
17275
18173
  attr_accessor :source_metadata
17276
18174
 
18175
+ # The title of the source.
18176
+ # Corresponds to the JSON property `title`
18177
+ # @return [String]
18178
+ attr_accessor :title
18179
+
18180
+ # The URI of the source.
18181
+ # Corresponds to the JSON property `uri`
18182
+ # @return [String]
18183
+ attr_accessor :uri
18184
+
17277
18185
  def initialize(**args)
17278
18186
  update!(**args)
17279
18187
  end
@@ -17281,9 +18189,12 @@ module Google
17281
18189
  # Update properties of this object
17282
18190
  def update!(**args)
17283
18191
  @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
18192
+ @domain = args[:domain] if args.key?(:domain)
17284
18193
  @index = args[:index] if args.key?(:index)
17285
18194
  @source = args[:source] if args.key?(:source)
17286
18195
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
18196
+ @title = args[:title] if args.key?(:title)
18197
+ @uri = args[:uri] if args.key?(:uri)
17287
18198
  end
17288
18199
  end
17289
18200
 
@@ -18981,6 +19892,32 @@ module Google
18981
19892
  end
18982
19893
  end
18983
19894
 
19895
+ # Response message for UserLicenseService.ListUserLicenses.
19896
+ class GoogleCloudDiscoveryengineV1betaListUserLicensesResponse
19897
+ include Google::Apis::Core::Hashable
19898
+
19899
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
19900
+ # field is omitted, there are no subsequent pages.
19901
+ # Corresponds to the JSON property `nextPageToken`
19902
+ # @return [String]
19903
+ attr_accessor :next_page_token
19904
+
19905
+ # All the customer's UserLicenses.
19906
+ # Corresponds to the JSON property `userLicenses`
19907
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserLicense>]
19908
+ attr_accessor :user_licenses
19909
+
19910
+ def initialize(**args)
19911
+ update!(**args)
19912
+ end
19913
+
19914
+ # Update properties of this object
19915
+ def update!(**args)
19916
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
19917
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
19918
+ end
19919
+ end
19920
+
18984
19921
  # Media-specific user event information.
18985
19922
  class GoogleCloudDiscoveryengineV1betaMediaInfo
18986
19923
  include Google::Apis::Core::Hashable
@@ -21603,6 +22540,14 @@ module Google
21603
22540
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec]
21604
22541
  attr_accessor :boost_spec
21605
22542
 
22543
+ # Optional. Custom search operators which if specified will be used to filter
22544
+ # results from workspace data stores. For more information on custom search
22545
+ # operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/
22546
+ # 6172299).
22547
+ # Corresponds to the JSON property `customSearchOperators`
22548
+ # @return [String]
22549
+ attr_accessor :custom_search_operators
22550
+
21606
22551
  # Required. Full resource name of DataStore, such as `projects/`project`/
21607
22552
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
21608
22553
  # Corresponds to the JSON property `dataStore`
@@ -21623,6 +22568,7 @@ module Google
21623
22568
  # Update properties of this object
21624
22569
  def update!(**args)
21625
22570
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
22571
+ @custom_search_operators = args[:custom_search_operators] if args.key?(:custom_search_operators)
21626
22572
  @data_store = args[:data_store] if args.key?(:data_store)
21627
22573
  @filter = args[:filter] if args.key?(:filter)
21628
22574
  end
@@ -22335,12 +23281,6 @@ module Google
22335
23281
  # @return [String]
22336
23282
  attr_accessor :rewritten_query
22337
23283
 
22338
- # The SQL request that was generated from the natural language query
22339
- # understanding phase.
22340
- # Corresponds to the JSON property `sqlRequest`
22341
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest]
22342
- attr_accessor :sql_request
22343
-
22344
23284
  # The filters that were extracted from the input query represented in a
22345
23285
  # structured form.
22346
23286
  # Corresponds to the JSON property `structuredExtractedFilter`
@@ -22356,31 +23296,10 @@ module Google
22356
23296
  @classified_intents = args[:classified_intents] if args.key?(:classified_intents)
22357
23297
  @extracted_filters = args[:extracted_filters] if args.key?(:extracted_filters)
22358
23298
  @rewritten_query = args[:rewritten_query] if args.key?(:rewritten_query)
22359
- @sql_request = args[:sql_request] if args.key?(:sql_request)
22360
23299
  @structured_extracted_filter = args[:structured_extracted_filter] if args.key?(:structured_extracted_filter)
22361
23300
  end
22362
23301
  end
22363
23302
 
22364
- # The SQL request that was generated from the natural language query
22365
- # understanding phase.
22366
- class GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest
22367
- include Google::Apis::Core::Hashable
22368
-
22369
- # Optional. The SQL query in text format.
22370
- # Corresponds to the JSON property `sqlQuery`
22371
- # @return [String]
22372
- attr_accessor :sql_query
22373
-
22374
- def initialize(**args)
22375
- update!(**args)
22376
- end
22377
-
22378
- # Update properties of this object
22379
- def update!(**args)
22380
- @sql_query = args[:sql_query] if args.key?(:sql_query)
22381
- end
22382
- end
22383
-
22384
23303
  # The filters that were extracted from the input query represented in a
22385
23304
  # structured form.
22386
23305
  class GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter
@@ -23021,6 +23940,11 @@ module Google
23021
23940
  class GoogleCloudDiscoveryengineV1betaServingConfig
23022
23941
  include Google::Apis::Core::Hashable
23023
23942
 
23943
+ # The specification for answer generation.
23944
+ # Corresponds to the JSON property `answerGenerationSpec`
23945
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec]
23946
+ attr_accessor :answer_generation_spec
23947
+
23024
23948
  # Boost controls to use in serving path. All triggered boost controls will be
23025
23949
  # applied. Boost controls must be in the same data store as the serving config.
23026
23950
  # Maximum of 20 boost controls.
@@ -23187,6 +24111,7 @@ module Google
23187
24111
 
23188
24112
  # Update properties of this object
23189
24113
  def update!(**args)
24114
+ @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
23190
24115
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
23191
24116
  @create_time = args[:create_time] if args.key?(:create_time)
23192
24117
  @display_name = args[:display_name] if args.key?(:display_name)
@@ -24417,6 +25342,79 @@ module Google
24417
25342
  end
24418
25343
  end
24419
25344
 
25345
+ # User License information assigned by the admin.
25346
+ class GoogleCloudDiscoveryengineV1betaUserLicense
25347
+ include Google::Apis::Core::Hashable
25348
+
25349
+ # Output only. User created timestamp.
25350
+ # Corresponds to the JSON property `createTime`
25351
+ # @return [String]
25352
+ attr_accessor :create_time
25353
+
25354
+ # Output only. User last logged in time. If the user has not logged in yet, this
25355
+ # field will be empty.
25356
+ # Corresponds to the JSON property `lastLoginTime`
25357
+ # @return [String]
25358
+ attr_accessor :last_login_time
25359
+
25360
+ # Output only. License assignment state of the user. If the user is assigned
25361
+ # with a license config, the user loggin will be assigned with the license; If
25362
+ # the user's license assignment state is unassigned or unspecified, no license
25363
+ # config will be associated to the user;
25364
+ # Corresponds to the JSON property `licenseAssignmentState`
25365
+ # @return [String]
25366
+ attr_accessor :license_assignment_state
25367
+
25368
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
25369
+ # to the user.
25370
+ # Corresponds to the JSON property `licenseConfig`
25371
+ # @return [String]
25372
+ attr_accessor :license_config
25373
+
25374
+ # Output only. User update timestamp.
25375
+ # Corresponds to the JSON property `updateTime`
25376
+ # @return [String]
25377
+ attr_accessor :update_time
25378
+
25379
+ # Optional. The full resource name of the User, in the format of `projects/`
25380
+ # project`/locations/`location`/userStores/`user_store`/users/`user_id``. This
25381
+ # field must be a UTF-8 encoded string with a length limit of 2048 characters.
25382
+ # If the user field is empty, it's indicating the user has not logged in yet and
25383
+ # no User entity is created.
25384
+ # Corresponds to the JSON property `user`
25385
+ # @return [String]
25386
+ attr_accessor :user
25387
+
25388
+ # Required. Immutable. The user principal of the User, could be email address or
25389
+ # other prinical identifier. This field is immutable. Admin assign licenses
25390
+ # based on the user principal.
25391
+ # Corresponds to the JSON property `userPrincipal`
25392
+ # @return [String]
25393
+ attr_accessor :user_principal
25394
+
25395
+ # Optional. The user profile. We user user full name(First name + Last name) as
25396
+ # user profile.
25397
+ # Corresponds to the JSON property `userProfile`
25398
+ # @return [String]
25399
+ attr_accessor :user_profile
25400
+
25401
+ def initialize(**args)
25402
+ update!(**args)
25403
+ end
25404
+
25405
+ # Update properties of this object
25406
+ def update!(**args)
25407
+ @create_time = args[:create_time] if args.key?(:create_time)
25408
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
25409
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
25410
+ @license_config = args[:license_config] if args.key?(:license_config)
25411
+ @update_time = args[:update_time] if args.key?(:update_time)
25412
+ @user = args[:user] if args.key?(:user)
25413
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
25414
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
25415
+ end
25416
+ end
25417
+
24420
25418
  # Config to store data store type configuration for workspace data
24421
25419
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
24422
25420
  include Google::Apis::Core::Hashable