google-apis-discoveryengine_v1alpha 0.63.0 → 0.65.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0600c3289768ff7430d9c3b39d1bcff4ad03015c3c0c1a102ca2aaf5de19a7a4
4
- data.tar.gz: a1e019a7f78ca38ccb37fc8fbcd2bd541fa4422092a357b69ff13fcfc4f303aa
3
+ metadata.gz: 62377e7723e44d296037c7ed4e29ec8a1822890b303fb6e49da7f15383bd94a6
4
+ data.tar.gz: a53993cf5e2bd3d910adcd819229d4a13fbb5da4d6ac4eec524d30eb01088638
5
5
  SHA512:
6
- metadata.gz: eb4a9dbfa6e91ce4968d059b87336fd39ec92e36384fa4933083bcf1d8e289484779507493b1520c0760ae3474203df1d198b89b6170aa60f92a6dfff43eb9b9
7
- data.tar.gz: e6c78fc4683dcfcc30bc28d16720ddd4e45ec32e3d257b1ac9e22858471c2331bbba66841500ae89176b471493737a96e83654f76599b0971e19d4ae59bb6ac9
6
+ metadata.gz: 96901fcd0b3f70caaf3662530283fbbca2d6e74de9a6b366b74609d89d9de5b576ec192de2e081ba54c930c37b4e550017bde6f95a8dfbe0b98732e5dd0bcf9f
7
+ data.tar.gz: 332965462875ea82e2527d0af338237ba979f9ecd50bcbe789ff092e023194adb7bb4a89d9721e3a6c5a92f1cc6fe36f0eb337efa7b716b853183b9f5ebb15f8
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-discoveryengine_v1alpha
2
2
 
3
+ ### v0.65.0 (2025-06-15)
4
+
5
+ * Regenerated from discovery document revision 20250609
6
+
7
+ ### v0.64.0 (2025-05-25)
8
+
9
+ * Regenerated from discovery document revision 20250521
10
+ * Regenerated using generator version 0.18.0
11
+
3
12
  ### v0.63.0 (2025-05-21)
4
13
 
5
14
  * Regenerated from discovery document revision 20250519
@@ -1793,6 +1793,71 @@ module Google
1793
1793
  end
1794
1794
  end
1795
1795
 
1796
+ # Metadata related to the progress of the UserLicenseService.
1797
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
1798
+ # longrunning.Operation.metadata field.
1799
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
1800
+ include Google::Apis::Core::Hashable
1801
+
1802
+ # Operation create time.
1803
+ # Corresponds to the JSON property `createTime`
1804
+ # @return [String]
1805
+ attr_accessor :create_time
1806
+
1807
+ # Count of user licenses that failed to be updated.
1808
+ # Corresponds to the JSON property `failureCount`
1809
+ # @return [Fixnum]
1810
+ attr_accessor :failure_count
1811
+
1812
+ # Count of user licenses successfully updated.
1813
+ # Corresponds to the JSON property `successCount`
1814
+ # @return [Fixnum]
1815
+ attr_accessor :success_count
1816
+
1817
+ # Operation last update time. If the operation is done, this is also the finish
1818
+ # time.
1819
+ # Corresponds to the JSON property `updateTime`
1820
+ # @return [String]
1821
+ attr_accessor :update_time
1822
+
1823
+ def initialize(**args)
1824
+ update!(**args)
1825
+ end
1826
+
1827
+ # Update properties of this object
1828
+ def update!(**args)
1829
+ @create_time = args[:create_time] if args.key?(:create_time)
1830
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
1831
+ @success_count = args[:success_count] if args.key?(:success_count)
1832
+ @update_time = args[:update_time] if args.key?(:update_time)
1833
+ end
1834
+ end
1835
+
1836
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
1837
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
1838
+ include Google::Apis::Core::Hashable
1839
+
1840
+ # A sample of errors encountered while processing the request.
1841
+ # Corresponds to the JSON property `errorSamples`
1842
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
1843
+ attr_accessor :error_samples
1844
+
1845
+ # UserLicenses successfully updated.
1846
+ # Corresponds to the JSON property `userLicenses`
1847
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1UserLicense>]
1848
+ attr_accessor :user_licenses
1849
+
1850
+ def initialize(**args)
1851
+ update!(**args)
1852
+ end
1853
+
1854
+ # Update properties of this object
1855
+ def update!(**args)
1856
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
1857
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
1858
+ end
1859
+ end
1860
+
1796
1861
  # Configurations used to enable CMEK data encryption with Cloud KMS keys.
1797
1862
  class GoogleCloudDiscoveryengineV1CmekConfig
1798
1863
  include Google::Apis::Core::Hashable
@@ -1822,7 +1887,7 @@ module Google
1822
1887
 
1823
1888
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
1824
1889
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
1825
- # `cmekConfig``.
1890
+ # `cmek_config``.
1826
1891
  # Corresponds to the JSON property `name`
1827
1892
  # @return [String]
1828
1893
  attr_accessor :name
@@ -3037,6 +3102,12 @@ module Google
3037
3102
  # @return [Array<String>]
3038
3103
  attr_accessor :exclude_html_ids
3039
3104
 
3105
+ # Optional. Contains the required structure types to extract from the document.
3106
+ # Supported values: * `shareholder-structure`
3107
+ # Corresponds to the JSON property `structuredContentTypes`
3108
+ # @return [Array<String>]
3109
+ attr_accessor :structured_content_types
3110
+
3040
3111
  def initialize(**args)
3041
3112
  update!(**args)
3042
3113
  end
@@ -3048,6 +3119,7 @@ module Google
3048
3119
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
3049
3120
  @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
3050
3121
  @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
3122
+ @structured_content_types = args[:structured_content_types] if args.key?(:structured_content_types)
3051
3123
  end
3052
3124
  end
3053
3125
 
@@ -3167,6 +3239,15 @@ module Google
3167
3239
  # @return [String]
3168
3240
  attr_accessor :display_name
3169
3241
 
3242
+ # Optional. Feature config for the engine to opt in or opt out of features.
3243
+ # Supported keys: * `*`: all features, if it's present, all other feature state
3244
+ # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
3245
+ # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
3246
+ # org-chart` * `bi-directional-audio` * `feedback`
3247
+ # Corresponds to the JSON property `features`
3248
+ # @return [Hash<String,String>]
3249
+ attr_accessor :features
3250
+
3170
3251
  # Optional. The industry vertical that the engine registers. The restriction of
3171
3252
  # the Engine industry vertical is based on DataStore: Vertical on Engine has to
3172
3253
  # match vertical of the DataStore linked to the engine.
@@ -3216,6 +3297,7 @@ module Google
3216
3297
  @data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
3217
3298
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
3218
3299
  @display_name = args[:display_name] if args.key?(:display_name)
3300
+ @features = args[:features] if args.key?(:features)
3219
3301
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
3220
3302
  @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
3221
3303
  @name = args[:name] if args.key?(:name)
@@ -5256,6 +5338,69 @@ module Google
5256
5338
  end
5257
5339
  end
5258
5340
 
5341
+ # User License information assigned by the admin.
5342
+ class GoogleCloudDiscoveryengineV1UserLicense
5343
+ include Google::Apis::Core::Hashable
5344
+
5345
+ # Output only. User created timestamp.
5346
+ # Corresponds to the JSON property `createTime`
5347
+ # @return [String]
5348
+ attr_accessor :create_time
5349
+
5350
+ # Output only. User last logged in time. If the user has not logged in yet, this
5351
+ # field will be empty.
5352
+ # Corresponds to the JSON property `lastLoginTime`
5353
+ # @return [String]
5354
+ attr_accessor :last_login_time
5355
+
5356
+ # Output only. License assignment state of the user. If the user is assigned
5357
+ # with a license config, the user loggin will be assigned with the license; If
5358
+ # the user's license assignment state is unassigned or unspecified, no license
5359
+ # config will be associated to the user;
5360
+ # Corresponds to the JSON property `licenseAssignmentState`
5361
+ # @return [String]
5362
+ attr_accessor :license_assignment_state
5363
+
5364
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
5365
+ # to the user.
5366
+ # Corresponds to the JSON property `licenseConfig`
5367
+ # @return [String]
5368
+ attr_accessor :license_config
5369
+
5370
+ # Output only. User update timestamp.
5371
+ # Corresponds to the JSON property `updateTime`
5372
+ # @return [String]
5373
+ attr_accessor :update_time
5374
+
5375
+ # Required. Immutable. The user principal of the User, could be email address or
5376
+ # other prinical identifier. This field is immutable. Admin assign licenses
5377
+ # based on the user principal.
5378
+ # Corresponds to the JSON property `userPrincipal`
5379
+ # @return [String]
5380
+ attr_accessor :user_principal
5381
+
5382
+ # Optional. The user profile. We user user full name(First name + Last name) as
5383
+ # user profile.
5384
+ # Corresponds to the JSON property `userProfile`
5385
+ # @return [String]
5386
+ attr_accessor :user_profile
5387
+
5388
+ def initialize(**args)
5389
+ update!(**args)
5390
+ end
5391
+
5392
+ # Update properties of this object
5393
+ def update!(**args)
5394
+ @create_time = args[:create_time] if args.key?(:create_time)
5395
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
5396
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
5397
+ @license_config = args[:license_config] if args.key?(:license_config)
5398
+ @update_time = args[:update_time] if args.key?(:update_time)
5399
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
5400
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
5401
+ end
5402
+ end
5403
+
5259
5404
  # Config to store data store type configuration for workspace data
5260
5405
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
5261
5406
  include Google::Apis::Core::Hashable
@@ -7898,11 +8043,6 @@ module Google
7898
8043
  attr_accessor :delete_unassigned_user_licenses
7899
8044
  alias_method :delete_unassigned_user_licenses?, :delete_unassigned_user_licenses
7900
8045
 
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
8046
  # The inline source for the input config for BatchUpdateUserLicenses method.
7907
8047
  # Corresponds to the JSON property `inlineSource`
7908
8048
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource]
@@ -7915,7 +8055,6 @@ module Google
7915
8055
  # Update properties of this object
7916
8056
  def update!(**args)
7917
8057
  @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
8058
  @inline_source = args[:inline_source] if args.key?(:inline_source)
7920
8059
  end
7921
8060
  end
@@ -8880,7 +9019,7 @@ module Google
8880
9019
 
8881
9020
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
8882
9021
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
8883
- # `cmekConfig``.
9022
+ # `cmek_config``.
8884
9023
  # Corresponds to the JSON property `name`
8885
9024
  # @return [String]
8886
9025
  attr_accessor :name
@@ -9295,7 +9434,7 @@ module Google
9295
9434
  attr_accessor :errors
9296
9435
 
9297
9436
  # The number of documents extracted from connector source, ready to be ingested
9298
- # to UCS.
9437
+ # to VAIS.
9299
9438
  # Corresponds to the JSON property `extractedRecordCount`
9300
9439
  # @return [Fixnum]
9301
9440
  attr_accessor :extracted_record_count
@@ -9310,6 +9449,12 @@ module Google
9310
9449
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress]
9311
9450
  attr_accessor :progress
9312
9451
 
9452
+ # The number of documents scheduled to be crawled/extracted from connector
9453
+ # source. This only applies to third party connectors.
9454
+ # Corresponds to the JSON property `scheduledRecordCount`
9455
+ # @return [Fixnum]
9456
+ attr_accessor :scheduled_record_count
9457
+
9313
9458
  # The number of requests sent to 3p API.
9314
9459
  # Corresponds to the JSON property `sourceApiRequestCount`
9315
9460
  # @return [Fixnum]
@@ -9349,6 +9494,7 @@ module Google
9349
9494
  @extracted_record_count = args[:extracted_record_count] if args.key?(:extracted_record_count)
9350
9495
  @indexed_record_count = args[:indexed_record_count] if args.key?(:indexed_record_count)
9351
9496
  @progress = args[:progress] if args.key?(:progress)
9497
+ @scheduled_record_count = args[:scheduled_record_count] if args.key?(:scheduled_record_count)
9352
9498
  @source_api_request_count = args[:source_api_request_count] if args.key?(:source_api_request_count)
9353
9499
  @state = args[:state] if args.key?(:state)
9354
9500
  @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
@@ -10373,13 +10519,13 @@ module Google
10373
10519
 
10374
10520
  # Optional. The refresh interval specifically for incremental data syncs. If
10375
10521
  # unset, incremental syncs will use the default from env, set to 3hrs. The
10376
- # minimum is 30 minutes and maximum is 7 days.
10522
+ # minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors.
10377
10523
  # Corresponds to the JSON property `incrementalRefreshInterval`
10378
10524
  # @return [String]
10379
10525
  attr_accessor :incremental_refresh_interval
10380
10526
 
10381
10527
  # Optional. Indicates whether incremental syncs are paused for this connector.
10382
- # This is independent of auto_run_disabled.
10528
+ # This is independent of auto_run_disabled. Applicable to only 3P connectors.
10383
10529
  # Corresponds to the JSON property `incrementalSyncDisabled`
10384
10530
  # @return [Boolean]
10385
10531
  attr_accessor :incremental_sync_disabled
@@ -11762,6 +11908,12 @@ module Google
11762
11908
  # @return [Array<String>]
11763
11909
  attr_accessor :exclude_html_ids
11764
11910
 
11911
+ # Optional. Contains the required structure types to extract from the document.
11912
+ # Supported values: * `shareholder-structure`
11913
+ # Corresponds to the JSON property `structuredContentTypes`
11914
+ # @return [Array<String>]
11915
+ attr_accessor :structured_content_types
11916
+
11765
11917
  def initialize(**args)
11766
11918
  update!(**args)
11767
11919
  end
@@ -11773,6 +11925,7 @@ module Google
11773
11925
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
11774
11926
  @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
11775
11927
  @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
11928
+ @structured_content_types = args[:structured_content_types] if args.key?(:structured_content_types)
11776
11929
  end
11777
11930
  end
11778
11931
 
@@ -11943,6 +12096,15 @@ module Google
11943
12096
  # @return [String]
11944
12097
  attr_accessor :display_name
11945
12098
 
12099
+ # Optional. Feature config for the engine to opt in or opt out of features.
12100
+ # Supported keys: * `*`: all features, if it's present, all other feature state
12101
+ # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
12102
+ # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
12103
+ # org-chart` * `bi-directional-audio` * `feedback`
12104
+ # Corresponds to the JSON property `features`
12105
+ # @return [Hash<String,String>]
12106
+ attr_accessor :features
12107
+
11946
12108
  # Optional. The industry vertical that the engine registers. The restriction of
11947
12109
  # the Engine industry vertical is based on DataStore: Vertical on Engine has to
11948
12110
  # match vertical of the DataStore linked to the engine.
@@ -12002,6 +12164,7 @@ module Google
12002
12164
  @data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
12003
12165
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
12004
12166
  @display_name = args[:display_name] if args.key?(:display_name)
12167
+ @features = args[:features] if args.key?(:features)
12005
12168
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
12006
12169
  @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
12007
12170
  @name = args[:name] if args.key?(:name)
@@ -12311,6 +12474,12 @@ module Google
12311
12474
  # @return [String]
12312
12475
  attr_accessor :data_state
12313
12476
 
12477
+ # Output only. The timestamp when the latest successful training finished. Only
12478
+ # applicable on Media Recommendation engines.
12479
+ # Corresponds to the JSON property `lastTrainTime`
12480
+ # @return [String]
12481
+ attr_accessor :last_train_time
12482
+
12314
12483
  # Output only. The timestamp when the latest successful tune finished. Only
12315
12484
  # applicable on Media Recommendation engines.
12316
12485
  # Corresponds to the JSON property `lastTuneTime`
@@ -12339,6 +12508,7 @@ module Google
12339
12508
  # Update properties of this object
12340
12509
  def update!(**args)
12341
12510
  @data_state = args[:data_state] if args.key?(:data_state)
12511
+ @last_train_time = args[:last_train_time] if args.key?(:last_train_time)
12342
12512
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
12343
12513
  @serving_state = args[:serving_state] if args.key?(:serving_state)
12344
12514
  @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
@@ -12637,7 +12807,7 @@ module Google
12637
12807
  class GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec
12638
12808
  include Google::Apis::Core::Hashable
12639
12809
 
12640
- # Required. The full resource name of the SampleQuerySet used for the evaluation,
12810
+ # Optional. The full resource name of the SampleQuerySet used for the evaluation,
12641
12811
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
12642
12812
  # sampleQuerySet``.
12643
12813
  # Corresponds to the JSON property `sampleQuerySet`
@@ -15199,6 +15369,12 @@ module Google
15199
15369
  class GoogleCloudDiscoveryengineV1alphaPrincipal
15200
15370
  include Google::Apis::Core::Hashable
15201
15371
 
15372
+ # For 3P application identities which are not present in the customer identity
15373
+ # provider.
15374
+ # Corresponds to the JSON property `externalEntityId`
15375
+ # @return [String]
15376
+ attr_accessor :external_entity_id
15377
+
15202
15378
  # Group identifier. For Google Workspace user account, group_id should be the
15203
15379
  # google workspace group email. For non-google identity provider user account,
15204
15380
  # group_id is the mapped group identifier configured during the workforcepool
@@ -15221,6 +15397,7 @@ module Google
15221
15397
 
15222
15398
  # Update properties of this object
15223
15399
  def update!(**args)
15400
+ @external_entity_id = args[:external_entity_id] if args.key?(:external_entity_id)
15224
15401
  @group_id = args[:group_id] if args.key?(:group_id)
15225
15402
  @user_id = args[:user_id] if args.key?(:user_id)
15226
15403
  end
@@ -15928,7 +16105,7 @@ module Google
15928
16105
  class GoogleCloudDiscoveryengineV1alphaQuery
15929
16106
  include Google::Apis::Core::Hashable
15930
16107
 
15931
- # Unique Id for the query.
16108
+ # Output only. Unique Id for the query.
15932
16109
  # Corresponds to the JSON property `queryId`
15933
16110
  # @return [String]
15934
16111
  attr_accessor :query_id
@@ -17416,34 +17593,52 @@ module Google
17416
17593
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec]
17417
17594
  attr_accessor :query_expansion_spec
17418
17595
 
17419
- # The ranking expression controls the customized ranking on retrieval documents.
17420
- # This overrides ServingConfig.ranking_expression. The syntax and supported
17421
- # features depend on the ranking_expression_backend value. If
17422
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
17423
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
17424
- # single function or multiple functions that are joined by "+". *
17596
+ # Optional. The ranking expression controls the customized ranking on retrieval
17597
+ # documents. This overrides ServingConfig.ranking_expression. The syntax and
17598
+ # supported features depend on the `ranking_expression_backend` value. If `
17599
+ # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
17600
+ # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
17601
+ # it should be a single function or multiple functions that are joined by "+". *
17425
17602
  # ranking_expression = function, ` " + ", function `; Supported functions: *
17426
17603
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
17427
17604
  # variables: * `relevance_score`: pre-defined keywords, used for measure
17428
17605
  # relevance between query and document. * `embedding_field_path`: the document
17429
17606
  # embedding field used with query embedding vector. * `dotProduct`: embedding
17430
- # function between embedding_field_path and query embedding vector. Example
17607
+ # function between `embedding_field_path` and query embedding vector. Example
17431
17608
  # ranking expression: If document has an embedding field doc_embedding, the
17432
17609
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
17433
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
17434
- # CLEARBOX`, the following expression types (and combinations of those chained
17435
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
17436
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
17437
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
17438
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
17439
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
17440
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
17441
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
17442
- # The following signals are supported: * gecko_score -- semantic similarity
17443
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
17444
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
17445
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
17446
- # base_rank -- the default rank of the result
17610
+ # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
17611
+ # the following expression types (and combinations of those chained using + or *
17612
+ # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
17613
+ # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
17614
+ # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
17615
+ # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
17616
+ # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
17617
+ # examples of ranking formulas that use the supported ranking expression types: -
17618
+ # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
17619
+ # mostly rank by the logarithm of `keyword_similarity_score` with slight `
17620
+ # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
17621
+ # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
17622
+ # rank by the exponent of `semantic_similarity_score` filling the value with 0
17623
+ # if it's NaN, also add constant 0.3 adjustment to the final score if `
17624
+ # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
17625
+ # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
17626
+ # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
17627
+ # semantic_smilarity_score`. The following signals are supported: * `
17628
+ # semantic_similarity_score`: semantic similarity adjustment that is calculated
17629
+ # using the embeddings generated by a proprietary Google model. This score
17630
+ # determines how semantically similar a search query is to a document. * `
17631
+ # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
17632
+ # BM25) ranking function. This score is calculated using a probabilistic model
17633
+ # to estimate the probability that a document is relevant to a given query. * `
17634
+ # relevance_score`: semantic relevance adjustment that uses a proprietary Google
17635
+ # model to determine the meaning and intent behind a user's query in context
17636
+ # with the content in the documents. * `pctr_rank`: predicted conversion rate
17637
+ # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
17638
+ # relevance and attractiveness of a search result from a user's perspective. A
17639
+ # higher pCTR suggests that the result is more likely to satisfy the user's
17640
+ # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
17641
+ # freshness adjustment as a rank * `base_rank`: the default rank of the result
17447
17642
  # Corresponds to the JSON property `rankingExpression`
17448
17643
  # @return [String]
17449
17644
  attr_accessor :ranking_expression
@@ -17528,6 +17723,15 @@ module Google
17528
17723
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec]
17529
17724
  attr_accessor :spell_correction_spec
17530
17725
 
17726
+ # Uses the Engine, ServingConfig and Control freshly read from the database.
17727
+ # Note: this skips config cache and introduces dependency on databases, which
17728
+ # could significantly increase the API latency. It should only be used for
17729
+ # testing, but not serving end users.
17730
+ # Corresponds to the JSON property `useLatestData`
17731
+ # @return [Boolean]
17732
+ attr_accessor :use_latest_data
17733
+ alias_method :use_latest_data?, :use_latest_data
17734
+
17531
17735
  # Information of an end user.
17532
17736
  # Corresponds to the JSON property `userInfo`
17533
17737
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo]
@@ -17599,6 +17803,7 @@ module Google
17599
17803
  @session = args[:session] if args.key?(:session)
17600
17804
  @session_spec = args[:session_spec] if args.key?(:session_spec)
17601
17805
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
17806
+ @use_latest_data = args[:use_latest_data] if args.key?(:use_latest_data)
17602
17807
  @user_info = args[:user_info] if args.key?(:user_info)
17603
17808
  @user_labels = args[:user_labels] if args.key?(:user_labels)
17604
17809
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
@@ -19889,8 +20094,8 @@ module Google
19889
20094
  class GoogleCloudDiscoveryengineV1alphaSessionTurn
19890
20095
  include Google::Apis::Core::Hashable
19891
20096
 
19892
- # The resource name of the answer to the user query. Only set if the answer
19893
- # generation (/answer API call) happened in this turn.
20097
+ # Optional. The resource name of the answer to the user query. Only set if the
20098
+ # answer generation (/answer API call) happened in this turn.
19894
20099
  # Corresponds to the JSON property `answer`
19895
20100
  # @return [String]
19896
20101
  attr_accessor :answer
@@ -21249,15 +21454,6 @@ module Google
21249
21454
  # @return [String]
21250
21455
  attr_accessor :update_time
21251
21456
 
21252
- # Optional. The full resource name of the User, in the format of `projects/`
21253
- # project`/locations/`location`/userStores/`user_store`/users/`user_id``. This
21254
- # field must be a UTF-8 encoded string with a length limit of 2048 characters.
21255
- # If the user field is empty, it's indicating the user has not logged in yet and
21256
- # no User entity is created.
21257
- # Corresponds to the JSON property `user`
21258
- # @return [String]
21259
- attr_accessor :user
21260
-
21261
21457
  # Required. Immutable. The user principal of the User, could be email address or
21262
21458
  # other prinical identifier. This field is immutable. Admin assign licenses
21263
21459
  # based on the user principal.
@@ -21282,7 +21478,6 @@ module Google
21282
21478
  @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
21283
21479
  @license_config = args[:license_config] if args.key?(:license_config)
21284
21480
  @update_time = args[:update_time] if args.key?(:update_time)
21285
- @user = args[:user] if args.key?(:user)
21286
21481
  @user_principal = args[:user_principal] if args.key?(:user_principal)
21287
21482
  @user_profile = args[:user_profile] if args.key?(:user_profile)
21288
21483
  end
@@ -22021,6 +22216,14 @@ module Google
22021
22216
  attr_accessor :enable_visual_content_summary
22022
22217
  alias_method :enable_visual_content_summary?, :enable_visual_content_summary
22023
22218
 
22219
+ # Output only. Feature config for the engine to opt in or opt out of features.
22220
+ # Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery`
22221
+ # * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-
22222
+ # chart` * `bi-directional-audio` * `feedback`
22223
+ # Corresponds to the JSON property `features`
22224
+ # @return [Hash<String,String>]
22225
+ attr_accessor :features
22226
+
22024
22227
  # Describes configuration for generative answer.
22025
22228
  # Corresponds to the JSON property `generativeAnswerConfig`
22026
22229
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig]
@@ -22052,6 +22255,7 @@ module Google
22052
22255
  @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
22053
22256
  @enable_search_as_you_type = args[:enable_search_as_you_type] if args.key?(:enable_search_as_you_type)
22054
22257
  @enable_visual_content_summary = args[:enable_visual_content_summary] if args.key?(:enable_visual_content_summary)
22258
+ @features = args[:features] if args.key?(:features)
22055
22259
  @generative_answer_config = args[:generative_answer_config] if args.key?(:generative_answer_config)
22056
22260
  @interaction_type = args[:interaction_type] if args.key?(:interaction_type)
22057
22261
  @result_description_type = args[:result_description_type] if args.key?(:result_description_type)
@@ -22258,6 +22462,71 @@ module Google
22258
22462
  end
22259
22463
  end
22260
22464
 
22465
+ # Metadata related to the progress of the UserLicenseService.
22466
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
22467
+ # longrunning.Operation.metadata field.
22468
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
22469
+ include Google::Apis::Core::Hashable
22470
+
22471
+ # Operation create time.
22472
+ # Corresponds to the JSON property `createTime`
22473
+ # @return [String]
22474
+ attr_accessor :create_time
22475
+
22476
+ # Count of user licenses that failed to be updated.
22477
+ # Corresponds to the JSON property `failureCount`
22478
+ # @return [Fixnum]
22479
+ attr_accessor :failure_count
22480
+
22481
+ # Count of user licenses successfully updated.
22482
+ # Corresponds to the JSON property `successCount`
22483
+ # @return [Fixnum]
22484
+ attr_accessor :success_count
22485
+
22486
+ # Operation last update time. If the operation is done, this is also the finish
22487
+ # time.
22488
+ # Corresponds to the JSON property `updateTime`
22489
+ # @return [String]
22490
+ attr_accessor :update_time
22491
+
22492
+ def initialize(**args)
22493
+ update!(**args)
22494
+ end
22495
+
22496
+ # Update properties of this object
22497
+ def update!(**args)
22498
+ @create_time = args[:create_time] if args.key?(:create_time)
22499
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
22500
+ @success_count = args[:success_count] if args.key?(:success_count)
22501
+ @update_time = args[:update_time] if args.key?(:update_time)
22502
+ end
22503
+ end
22504
+
22505
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
22506
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
22507
+ include Google::Apis::Core::Hashable
22508
+
22509
+ # A sample of errors encountered while processing the request.
22510
+ # Corresponds to the JSON property `errorSamples`
22511
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
22512
+ attr_accessor :error_samples
22513
+
22514
+ # UserLicenses successfully updated.
22515
+ # Corresponds to the JSON property `userLicenses`
22516
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaUserLicense>]
22517
+ attr_accessor :user_licenses
22518
+
22519
+ def initialize(**args)
22520
+ update!(**args)
22521
+ end
22522
+
22523
+ # Update properties of this object
22524
+ def update!(**args)
22525
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
22526
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
22527
+ end
22528
+ end
22529
+
22261
22530
  # Configurations used to enable CMEK data encryption with Cloud KMS keys.
22262
22531
  class GoogleCloudDiscoveryengineV1betaCmekConfig
22263
22532
  include Google::Apis::Core::Hashable
@@ -22287,7 +22556,7 @@ module Google
22287
22556
 
22288
22557
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
22289
22558
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
22290
- # `cmekConfig``.
22559
+ # `cmek_config``.
22291
22560
  # Corresponds to the JSON property `name`
22292
22561
  # @return [String]
22293
22562
  attr_accessor :name
@@ -23560,6 +23829,12 @@ module Google
23560
23829
  # @return [Array<String>]
23561
23830
  attr_accessor :exclude_html_ids
23562
23831
 
23832
+ # Optional. Contains the required structure types to extract from the document.
23833
+ # Supported values: * `shareholder-structure`
23834
+ # Corresponds to the JSON property `structuredContentTypes`
23835
+ # @return [Array<String>]
23836
+ attr_accessor :structured_content_types
23837
+
23563
23838
  def initialize(**args)
23564
23839
  update!(**args)
23565
23840
  end
@@ -23571,6 +23846,7 @@ module Google
23571
23846
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
23572
23847
  @exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
23573
23848
  @exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
23849
+ @structured_content_types = args[:structured_content_types] if args.key?(:structured_content_types)
23574
23850
  end
23575
23851
  end
23576
23852
 
@@ -23690,6 +23966,15 @@ module Google
23690
23966
  # @return [String]
23691
23967
  attr_accessor :display_name
23692
23968
 
23969
+ # Optional. Feature config for the engine to opt in or opt out of features.
23970
+ # Supported keys: * `*`: all features, if it's present, all other feature state
23971
+ # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
23972
+ # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
23973
+ # org-chart` * `bi-directional-audio` * `feedback`
23974
+ # Corresponds to the JSON property `features`
23975
+ # @return [Hash<String,String>]
23976
+ attr_accessor :features
23977
+
23693
23978
  # Optional. The industry vertical that the engine registers. The restriction of
23694
23979
  # the Engine industry vertical is based on DataStore: Vertical on Engine has to
23695
23980
  # match vertical of the DataStore linked to the engine.
@@ -23739,6 +24024,7 @@ module Google
23739
24024
  @data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
23740
24025
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
23741
24026
  @display_name = args[:display_name] if args.key?(:display_name)
24027
+ @features = args[:features] if args.key?(:features)
23742
24028
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
23743
24029
  @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
23744
24030
  @name = args[:name] if args.key?(:name)
@@ -24158,7 +24444,7 @@ module Google
24158
24444
  class GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec
24159
24445
  include Google::Apis::Core::Hashable
24160
24446
 
24161
- # Required. The full resource name of the SampleQuerySet used for the evaluation,
24447
+ # Optional. The full resource name of the SampleQuerySet used for the evaluation,
24162
24448
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
24163
24449
  # sampleQuerySet``.
24164
24450
  # Corresponds to the JSON property `sampleQuerySet`
@@ -25422,34 +25708,52 @@ module Google
25422
25708
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec]
25423
25709
  attr_accessor :query_expansion_spec
25424
25710
 
25425
- # The ranking expression controls the customized ranking on retrieval documents.
25426
- # This overrides ServingConfig.ranking_expression. The syntax and supported
25427
- # features depend on the ranking_expression_backend value. If
25428
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
25429
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
25430
- # single function or multiple functions that are joined by "+". *
25711
+ # Optional. The ranking expression controls the customized ranking on retrieval
25712
+ # documents. This overrides ServingConfig.ranking_expression. The syntax and
25713
+ # supported features depend on the `ranking_expression_backend` value. If `
25714
+ # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
25715
+ # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
25716
+ # it should be a single function or multiple functions that are joined by "+". *
25431
25717
  # ranking_expression = function, ` " + ", function `; Supported functions: *
25432
25718
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
25433
25719
  # variables: * `relevance_score`: pre-defined keywords, used for measure
25434
25720
  # relevance between query and document. * `embedding_field_path`: the document
25435
25721
  # embedding field used with query embedding vector. * `dotProduct`: embedding
25436
- # function between embedding_field_path and query embedding vector. Example
25722
+ # function between `embedding_field_path` and query embedding vector. Example
25437
25723
  # ranking expression: If document has an embedding field doc_embedding, the
25438
25724
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
25439
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
25440
- # CLEARBOX`, the following expression types (and combinations of those chained
25441
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
25442
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
25443
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
25444
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
25445
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
25446
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
25447
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
25448
- # The following signals are supported: * gecko_score -- semantic similarity
25449
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
25450
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
25451
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
25452
- # base_rank -- the default rank of the result
25725
+ # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
25726
+ # the following expression types (and combinations of those chained using + or *
25727
+ # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
25728
+ # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
25729
+ # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
25730
+ # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
25731
+ # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
25732
+ # examples of ranking formulas that use the supported ranking expression types: -
25733
+ # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
25734
+ # mostly rank by the logarithm of `keyword_similarity_score` with slight `
25735
+ # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
25736
+ # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
25737
+ # rank by the exponent of `semantic_similarity_score` filling the value with 0
25738
+ # if it's NaN, also add constant 0.3 adjustment to the final score if `
25739
+ # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
25740
+ # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
25741
+ # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
25742
+ # semantic_smilarity_score`. The following signals are supported: * `
25743
+ # semantic_similarity_score`: semantic similarity adjustment that is calculated
25744
+ # using the embeddings generated by a proprietary Google model. This score
25745
+ # determines how semantically similar a search query is to a document. * `
25746
+ # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
25747
+ # BM25) ranking function. This score is calculated using a probabilistic model
25748
+ # to estimate the probability that a document is relevant to a given query. * `
25749
+ # relevance_score`: semantic relevance adjustment that uses a proprietary Google
25750
+ # model to determine the meaning and intent behind a user's query in context
25751
+ # with the content in the documents. * `pctr_rank`: predicted conversion rate
25752
+ # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
25753
+ # relevance and attractiveness of a search result from a user's perspective. A
25754
+ # higher pCTR suggests that the result is more likely to satisfy the user's
25755
+ # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
25756
+ # freshness adjustment as a rank * `base_rank`: the default rank of the result
25453
25757
  # Corresponds to the JSON property `rankingExpression`
25454
25758
  # @return [String]
25455
25759
  attr_accessor :ranking_expression
@@ -27049,6 +27353,69 @@ module Google
27049
27353
  end
27050
27354
  end
27051
27355
 
27356
+ # User License information assigned by the admin.
27357
+ class GoogleCloudDiscoveryengineV1betaUserLicense
27358
+ include Google::Apis::Core::Hashable
27359
+
27360
+ # Output only. User created timestamp.
27361
+ # Corresponds to the JSON property `createTime`
27362
+ # @return [String]
27363
+ attr_accessor :create_time
27364
+
27365
+ # Output only. User last logged in time. If the user has not logged in yet, this
27366
+ # field will be empty.
27367
+ # Corresponds to the JSON property `lastLoginTime`
27368
+ # @return [String]
27369
+ attr_accessor :last_login_time
27370
+
27371
+ # Output only. License assignment state of the user. If the user is assigned
27372
+ # with a license config, the user loggin will be assigned with the license; If
27373
+ # the user's license assignment state is unassigned or unspecified, no license
27374
+ # config will be associated to the user;
27375
+ # Corresponds to the JSON property `licenseAssignmentState`
27376
+ # @return [String]
27377
+ attr_accessor :license_assignment_state
27378
+
27379
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
27380
+ # to the user.
27381
+ # Corresponds to the JSON property `licenseConfig`
27382
+ # @return [String]
27383
+ attr_accessor :license_config
27384
+
27385
+ # Output only. User update timestamp.
27386
+ # Corresponds to the JSON property `updateTime`
27387
+ # @return [String]
27388
+ attr_accessor :update_time
27389
+
27390
+ # Required. Immutable. The user principal of the User, could be email address or
27391
+ # other prinical identifier. This field is immutable. Admin assign licenses
27392
+ # based on the user principal.
27393
+ # Corresponds to the JSON property `userPrincipal`
27394
+ # @return [String]
27395
+ attr_accessor :user_principal
27396
+
27397
+ # Optional. The user profile. We user user full name(First name + Last name) as
27398
+ # user profile.
27399
+ # Corresponds to the JSON property `userProfile`
27400
+ # @return [String]
27401
+ attr_accessor :user_profile
27402
+
27403
+ def initialize(**args)
27404
+ update!(**args)
27405
+ end
27406
+
27407
+ # Update properties of this object
27408
+ def update!(**args)
27409
+ @create_time = args[:create_time] if args.key?(:create_time)
27410
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
27411
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
27412
+ @license_config = args[:license_config] if args.key?(:license_config)
27413
+ @update_time = args[:update_time] if args.key?(:update_time)
27414
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
27415
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
27416
+ end
27417
+ end
27418
+
27052
27419
  # Config to store data store type configuration for workspace data
27053
27420
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
27054
27421
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1alpha
18
18
  # Version of the google-apis-discoveryengine_v1alpha gem
19
- GEM_VERSION = "0.63.0"
19
+ GEM_VERSION = "0.65.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.17.0"
22
+ GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250519"
25
+ REVISION = "20250609"
26
26
  end
27
27
  end
28
28
  end
@@ -238,6 +238,18 @@ module Google
238
238
  include Google::Apis::Core::JsonObjectSupport
239
239
  end
240
240
 
241
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
242
+ class Representation < Google::Apis::Core::JsonRepresentation; end
243
+
244
+ include Google::Apis::Core::JsonObjectSupport
245
+ end
246
+
247
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
248
+ class Representation < Google::Apis::Core::JsonRepresentation; end
249
+
250
+ include Google::Apis::Core::JsonObjectSupport
251
+ end
252
+
241
253
  class GoogleCloudDiscoveryengineV1CmekConfig
242
254
  class Representation < Google::Apis::Core::JsonRepresentation; end
243
255
 
@@ -796,6 +808,12 @@ module Google
796
808
  include Google::Apis::Core::JsonObjectSupport
797
809
  end
798
810
 
811
+ class GoogleCloudDiscoveryengineV1UserLicense
812
+ class Representation < Google::Apis::Core::JsonRepresentation; end
813
+
814
+ include Google::Apis::Core::JsonObjectSupport
815
+ end
816
+
799
817
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
800
818
  class Representation < Google::Apis::Core::JsonRepresentation; end
801
819
 
@@ -3472,6 +3490,18 @@ module Google
3472
3490
  include Google::Apis::Core::JsonObjectSupport
3473
3491
  end
3474
3492
 
3493
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
3494
+ class Representation < Google::Apis::Core::JsonRepresentation; end
3495
+
3496
+ include Google::Apis::Core::JsonObjectSupport
3497
+ end
3498
+
3499
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
3500
+ class Representation < Google::Apis::Core::JsonRepresentation; end
3501
+
3502
+ include Google::Apis::Core::JsonObjectSupport
3503
+ end
3504
+
3475
3505
  class GoogleCloudDiscoveryengineV1betaCmekConfig
3476
3506
  class Representation < Google::Apis::Core::JsonRepresentation; end
3477
3507
 
@@ -4240,6 +4270,12 @@ module Google
4240
4270
  include Google::Apis::Core::JsonObjectSupport
4241
4271
  end
4242
4272
 
4273
+ class GoogleCloudDiscoveryengineV1betaUserLicense
4274
+ class Representation < Google::Apis::Core::JsonRepresentation; end
4275
+
4276
+ include Google::Apis::Core::JsonObjectSupport
4277
+ end
4278
+
4243
4279
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
4244
4280
  class Representation < Google::Apis::Core::JsonRepresentation; end
4245
4281
 
@@ -4752,6 +4788,26 @@ module Google
4752
4788
  end
4753
4789
  end
4754
4790
 
4791
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
4792
+ # @private
4793
+ class Representation < Google::Apis::Core::JsonRepresentation
4794
+ property :create_time, as: 'createTime'
4795
+ property :failure_count, :numeric_string => true, as: 'failureCount'
4796
+ property :success_count, :numeric_string => true, as: 'successCount'
4797
+ property :update_time, as: 'updateTime'
4798
+ end
4799
+ end
4800
+
4801
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
4802
+ # @private
4803
+ class Representation < Google::Apis::Core::JsonRepresentation
4804
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus::Representation
4805
+
4806
+ collection :user_licenses, as: 'userLicenses', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1UserLicense, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1UserLicense::Representation
4807
+
4808
+ end
4809
+ end
4810
+
4755
4811
  class GoogleCloudDiscoveryengineV1CmekConfig
4756
4812
  # @private
4757
4813
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5096,6 +5152,7 @@ module Google
5096
5152
  collection :exclude_html_classes, as: 'excludeHtmlClasses'
5097
5153
  collection :exclude_html_elements, as: 'excludeHtmlElements'
5098
5154
  collection :exclude_html_ids, as: 'excludeHtmlIds'
5155
+ collection :structured_content_types, as: 'structuredContentTypes'
5099
5156
  end
5100
5157
  end
5101
5158
 
@@ -5134,6 +5191,7 @@ module Google
5134
5191
  collection :data_store_ids, as: 'dataStoreIds'
5135
5192
  property :disable_analytics, as: 'disableAnalytics'
5136
5193
  property :display_name, as: 'displayName'
5194
+ hash :features, as: 'features'
5137
5195
  property :industry_vertical, as: 'industryVertical'
5138
5196
  property :media_recommendation_engine_config, as: 'mediaRecommendationEngineConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig::Representation
5139
5197
 
@@ -5672,6 +5730,19 @@ module Google
5672
5730
  end
5673
5731
  end
5674
5732
 
5733
+ class GoogleCloudDiscoveryengineV1UserLicense
5734
+ # @private
5735
+ class Representation < Google::Apis::Core::JsonRepresentation
5736
+ property :create_time, as: 'createTime'
5737
+ property :last_login_time, as: 'lastLoginTime'
5738
+ property :license_assignment_state, as: 'licenseAssignmentState'
5739
+ property :license_config, as: 'licenseConfig'
5740
+ property :update_time, as: 'updateTime'
5741
+ property :user_principal, as: 'userPrincipal'
5742
+ property :user_profile, as: 'userProfile'
5743
+ end
5744
+ end
5745
+
5675
5746
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
5676
5747
  # @private
5677
5748
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6437,8 +6508,6 @@ module Google
6437
6508
  # @private
6438
6509
  class Representation < Google::Apis::Core::JsonRepresentation
6439
6510
  property :delete_unassigned_user_licenses, as: 'deleteUnassignedUserLicenses'
6440
- property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource::Representation
6441
-
6442
6511
  property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource::Representation
6443
6512
 
6444
6513
  end
@@ -6807,6 +6876,7 @@ module Google
6807
6876
  property :indexed_record_count, :numeric_string => true, as: 'indexedRecordCount'
6808
6877
  property :progress, as: 'progress', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress::Representation
6809
6878
 
6879
+ property :scheduled_record_count, :numeric_string => true, as: 'scheduledRecordCount'
6810
6880
  property :source_api_request_count, :numeric_string => true, as: 'sourceApiRequestCount'
6811
6881
  property :state, as: 'state'
6812
6882
  property :state_update_time, as: 'stateUpdateTime'
@@ -7449,6 +7519,7 @@ module Google
7449
7519
  collection :exclude_html_classes, as: 'excludeHtmlClasses'
7450
7520
  collection :exclude_html_elements, as: 'excludeHtmlElements'
7451
7521
  collection :exclude_html_ids, as: 'excludeHtmlIds'
7522
+ collection :structured_content_types, as: 'structuredContentTypes'
7452
7523
  end
7453
7524
  end
7454
7525
 
@@ -7507,6 +7578,7 @@ module Google
7507
7578
  collection :data_store_ids, as: 'dataStoreIds'
7508
7579
  property :disable_analytics, as: 'disableAnalytics'
7509
7580
  property :display_name, as: 'displayName'
7581
+ hash :features, as: 'features'
7510
7582
  property :industry_vertical, as: 'industryVertical'
7511
7583
  property :media_recommendation_engine_config, as: 'mediaRecommendationEngineConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig::Representation
7512
7584
 
@@ -7605,6 +7677,7 @@ module Google
7605
7677
  # @private
7606
7678
  class Representation < Google::Apis::Core::JsonRepresentation
7607
7679
  property :data_state, as: 'dataState'
7680
+ property :last_train_time, as: 'lastTrainTime'
7608
7681
  property :last_tune_time, as: 'lastTuneTime'
7609
7682
  property :serving_state, as: 'servingState'
7610
7683
  property :tuning_operation, as: 'tuningOperation'
@@ -8465,6 +8538,7 @@ module Google
8465
8538
  class GoogleCloudDiscoveryengineV1alphaPrincipal
8466
8539
  # @private
8467
8540
  class Representation < Google::Apis::Core::JsonRepresentation
8541
+ property :external_entity_id, as: 'externalEntityId'
8468
8542
  property :group_id, as: 'groupId'
8469
8543
  property :user_id, as: 'userId'
8470
8544
  end
@@ -9068,6 +9142,7 @@ module Google
9068
9142
 
9069
9143
  property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec::Representation
9070
9144
 
9145
+ property :use_latest_data, as: 'useLatestData'
9071
9146
  property :user_info, as: 'userInfo', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo::Representation
9072
9147
 
9073
9148
  hash :user_labels, as: 'userLabels'
@@ -10027,7 +10102,6 @@ module Google
10027
10102
  property :license_assignment_state, as: 'licenseAssignmentState'
10028
10103
  property :license_config, as: 'licenseConfig'
10029
10104
  property :update_time, as: 'updateTime'
10030
- property :user, as: 'user'
10031
10105
  property :user_principal, as: 'userPrincipal'
10032
10106
  property :user_profile, as: 'userProfile'
10033
10107
  end
@@ -10212,6 +10286,7 @@ module Google
10212
10286
  property :enable_safe_search, as: 'enableSafeSearch'
10213
10287
  property :enable_search_as_you_type, as: 'enableSearchAsYouType'
10214
10288
  property :enable_visual_content_summary, as: 'enableVisualContentSummary'
10289
+ hash :features, as: 'features'
10215
10290
  property :generative_answer_config, as: 'generativeAnswerConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig::Representation
10216
10291
 
10217
10292
  property :interaction_type, as: 'interactionType'
@@ -10269,6 +10344,26 @@ module Google
10269
10344
  end
10270
10345
  end
10271
10346
 
10347
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
10348
+ # @private
10349
+ class Representation < Google::Apis::Core::JsonRepresentation
10350
+ property :create_time, as: 'createTime'
10351
+ property :failure_count, :numeric_string => true, as: 'failureCount'
10352
+ property :success_count, :numeric_string => true, as: 'successCount'
10353
+ property :update_time, as: 'updateTime'
10354
+ end
10355
+ end
10356
+
10357
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
10358
+ # @private
10359
+ class Representation < Google::Apis::Core::JsonRepresentation
10360
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus::Representation
10361
+
10362
+ collection :user_licenses, as: 'userLicenses', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaUserLicense, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaUserLicense::Representation
10363
+
10364
+ end
10365
+ end
10366
+
10272
10367
  class GoogleCloudDiscoveryengineV1betaCmekConfig
10273
10368
  # @private
10274
10369
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -10637,6 +10732,7 @@ module Google
10637
10732
  collection :exclude_html_classes, as: 'excludeHtmlClasses'
10638
10733
  collection :exclude_html_elements, as: 'excludeHtmlElements'
10639
10734
  collection :exclude_html_ids, as: 'excludeHtmlIds'
10735
+ collection :structured_content_types, as: 'structuredContentTypes'
10640
10736
  end
10641
10737
  end
10642
10738
 
@@ -10675,6 +10771,7 @@ module Google
10675
10771
  collection :data_store_ids, as: 'dataStoreIds'
10676
10772
  property :disable_analytics, as: 'disableAnalytics'
10677
10773
  property :display_name, as: 'displayName'
10774
+ hash :features, as: 'features'
10678
10775
  property :industry_vertical, as: 'industryVertical'
10679
10776
  property :media_recommendation_engine_config, as: 'mediaRecommendationEngineConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig::Representation
10680
10777
 
@@ -11548,6 +11645,19 @@ module Google
11548
11645
  end
11549
11646
  end
11550
11647
 
11648
+ class GoogleCloudDiscoveryengineV1betaUserLicense
11649
+ # @private
11650
+ class Representation < Google::Apis::Core::JsonRepresentation
11651
+ property :create_time, as: 'createTime'
11652
+ property :last_login_time, as: 'lastLoginTime'
11653
+ property :license_assignment_state, as: 'licenseAssignmentState'
11654
+ property :license_config, as: 'licenseConfig'
11655
+ property :update_time, as: 'updateTime'
11656
+ property :user_principal, as: 'userPrincipal'
11657
+ property :user_profile, as: 'userProfile'
11658
+ end
11659
+ end
11660
+
11551
11661
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
11552
11662
  # @private
11553
11663
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -490,7 +490,7 @@ module Google
490
490
  # @param [String] name
491
491
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
492
492
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
493
- # `cmekConfig``.
493
+ # `cmek_config``.
494
494
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
495
495
  # @param [Boolean] set_default
496
496
  # Set the following CmekConfig as the default to be used for child resources if
@@ -628,7 +628,7 @@ module Google
628
628
  # @param [String] name
629
629
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
630
630
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
631
- # `cmekConfig``.
631
+ # `cmek_config``.
632
632
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
633
633
  # @param [Boolean] set_default
634
634
  # Set the following CmekConfig as the default to be used for child resources if
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.63.0
4
+ version: 0.65.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.63.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.65.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
62
62
  rdoc_options: []
63
63
  require_paths: