google-apis-discoveryengine_v1alpha 0.64.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: 74850e66d6ee5695012672c654eb264b854d93a8c081e160422e2b0c609714a2
4
- data.tar.gz: 503e678921a91db0588ad6c3fc085c845cf4f7ff46eb05462dd924a36cea4490
3
+ metadata.gz: 62377e7723e44d296037c7ed4e29ec8a1822890b303fb6e49da7f15383bd94a6
4
+ data.tar.gz: a53993cf5e2bd3d910adcd819229d4a13fbb5da4d6ac4eec524d30eb01088638
5
5
  SHA512:
6
- metadata.gz: 3eba39a7559bb93df76c0b74db20c03e48c4d5705afee727f447b188019f1f6cd49b597b4513d26125b95b79cfb6d6158222269e4294ca2917ccf75e5254e021
7
- data.tar.gz: 9ec2f36a45466af6e56625b5a9c22c19e69afceb7a0407c2f00b7954a53a4ded8edebd4c60f67be682b04ff665debed2f585c97bd70830935522ad557541aabf
6
+ metadata.gz: 96901fcd0b3f70caaf3662530283fbbca2d6e74de9a6b366b74609d89d9de5b576ec192de2e081ba54c930c37b4e550017bde6f95a8dfbe0b98732e5dd0bcf9f
7
+ data.tar.gz: 332965462875ea82e2527d0af338237ba979f9ecd50bcbe789ff092e023194adb7bb4a89d9721e3a6c5a92f1cc6fe36f0eb337efa7b716b853183b9f5ebb15f8
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
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
+
3
7
  ### v0.64.0 (2025-05-25)
4
8
 
5
9
  * Regenerated from discovery document revision 20250521
@@ -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
@@ -5273,6 +5338,69 @@ module Google
5273
5338
  end
5274
5339
  end
5275
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
+
5276
5404
  # Config to store data store type configuration for workspace data
5277
5405
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
5278
5406
  include Google::Apis::Core::Hashable
@@ -7915,11 +8043,6 @@ module Google
7915
8043
  attr_accessor :delete_unassigned_user_licenses
7916
8044
  alias_method :delete_unassigned_user_licenses?, :delete_unassigned_user_licenses
7917
8045
 
7918
- # Cloud Storage location for input content.
7919
- # Corresponds to the JSON property `gcsSource`
7920
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource]
7921
- attr_accessor :gcs_source
7922
-
7923
8046
  # The inline source for the input config for BatchUpdateUserLicenses method.
7924
8047
  # Corresponds to the JSON property `inlineSource`
7925
8048
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource]
@@ -7932,7 +8055,6 @@ module Google
7932
8055
  # Update properties of this object
7933
8056
  def update!(**args)
7934
8057
  @delete_unassigned_user_licenses = args[:delete_unassigned_user_licenses] if args.key?(:delete_unassigned_user_licenses)
7935
- @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
7936
8058
  @inline_source = args[:inline_source] if args.key?(:inline_source)
7937
8059
  end
7938
8060
  end
@@ -8897,7 +9019,7 @@ module Google
8897
9019
 
8898
9020
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
8899
9021
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
8900
- # `cmekConfig``.
9022
+ # `cmek_config``.
8901
9023
  # Corresponds to the JSON property `name`
8902
9024
  # @return [String]
8903
9025
  attr_accessor :name
@@ -10397,13 +10519,13 @@ module Google
10397
10519
 
10398
10520
  # Optional. The refresh interval specifically for incremental data syncs. If
10399
10521
  # unset, incremental syncs will use the default from env, set to 3hrs. The
10400
- # minimum is 30 minutes and maximum is 7 days.
10522
+ # minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors.
10401
10523
  # Corresponds to the JSON property `incrementalRefreshInterval`
10402
10524
  # @return [String]
10403
10525
  attr_accessor :incremental_refresh_interval
10404
10526
 
10405
10527
  # Optional. Indicates whether incremental syncs are paused for this connector.
10406
- # This is independent of auto_run_disabled.
10528
+ # This is independent of auto_run_disabled. Applicable to only 3P connectors.
10407
10529
  # Corresponds to the JSON property `incrementalSyncDisabled`
10408
10530
  # @return [Boolean]
10409
10531
  attr_accessor :incremental_sync_disabled
@@ -12685,7 +12807,7 @@ module Google
12685
12807
  class GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec
12686
12808
  include Google::Apis::Core::Hashable
12687
12809
 
12688
- # 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,
12689
12811
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
12690
12812
  # sampleQuerySet``.
12691
12813
  # Corresponds to the JSON property `sampleQuerySet`
@@ -15247,6 +15369,12 @@ module Google
15247
15369
  class GoogleCloudDiscoveryengineV1alphaPrincipal
15248
15370
  include Google::Apis::Core::Hashable
15249
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
+
15250
15378
  # Group identifier. For Google Workspace user account, group_id should be the
15251
15379
  # google workspace group email. For non-google identity provider user account,
15252
15380
  # group_id is the mapped group identifier configured during the workforcepool
@@ -15269,6 +15397,7 @@ module Google
15269
15397
 
15270
15398
  # Update properties of this object
15271
15399
  def update!(**args)
15400
+ @external_entity_id = args[:external_entity_id] if args.key?(:external_entity_id)
15272
15401
  @group_id = args[:group_id] if args.key?(:group_id)
15273
15402
  @user_id = args[:user_id] if args.key?(:user_id)
15274
15403
  end
@@ -15976,7 +16105,7 @@ module Google
15976
16105
  class GoogleCloudDiscoveryengineV1alphaQuery
15977
16106
  include Google::Apis::Core::Hashable
15978
16107
 
15979
- # Unique Id for the query.
16108
+ # Output only. Unique Id for the query.
15980
16109
  # Corresponds to the JSON property `queryId`
15981
16110
  # @return [String]
15982
16111
  attr_accessor :query_id
@@ -17464,34 +17593,52 @@ module Google
17464
17593
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec]
17465
17594
  attr_accessor :query_expansion_spec
17466
17595
 
17467
- # The ranking expression controls the customized ranking on retrieval documents.
17468
- # This overrides ServingConfig.ranking_expression. The syntax and supported
17469
- # features depend on the ranking_expression_backend value. If
17470
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
17471
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
17472
- # 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 "+". *
17473
17602
  # ranking_expression = function, ` " + ", function `; Supported functions: *
17474
17603
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
17475
17604
  # variables: * `relevance_score`: pre-defined keywords, used for measure
17476
17605
  # relevance between query and document. * `embedding_field_path`: the document
17477
17606
  # embedding field used with query embedding vector. * `dotProduct`: embedding
17478
- # function between embedding_field_path and query embedding vector. Example
17607
+ # function between `embedding_field_path` and query embedding vector. Example
17479
17608
  # ranking expression: If document has an embedding field doc_embedding, the
17480
17609
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
17481
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
17482
- # CLEARBOX`, the following expression types (and combinations of those chained
17483
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
17484
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
17485
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
17486
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
17487
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
17488
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
17489
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
17490
- # The following signals are supported: * gecko_score -- semantic similarity
17491
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
17492
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
17493
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
17494
- # 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
17495
17642
  # Corresponds to the JSON property `rankingExpression`
17496
17643
  # @return [String]
17497
17644
  attr_accessor :ranking_expression
@@ -17576,6 +17723,15 @@ module Google
17576
17723
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec]
17577
17724
  attr_accessor :spell_correction_spec
17578
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
+
17579
17735
  # Information of an end user.
17580
17736
  # Corresponds to the JSON property `userInfo`
17581
17737
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo]
@@ -17647,6 +17803,7 @@ module Google
17647
17803
  @session = args[:session] if args.key?(:session)
17648
17804
  @session_spec = args[:session_spec] if args.key?(:session_spec)
17649
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)
17650
17807
  @user_info = args[:user_info] if args.key?(:user_info)
17651
17808
  @user_labels = args[:user_labels] if args.key?(:user_labels)
17652
17809
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
@@ -19937,8 +20094,8 @@ module Google
19937
20094
  class GoogleCloudDiscoveryengineV1alphaSessionTurn
19938
20095
  include Google::Apis::Core::Hashable
19939
20096
 
19940
- # The resource name of the answer to the user query. Only set if the answer
19941
- # 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.
19942
20099
  # Corresponds to the JSON property `answer`
19943
20100
  # @return [String]
19944
20101
  attr_accessor :answer
@@ -22305,6 +22462,71 @@ module Google
22305
22462
  end
22306
22463
  end
22307
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
+
22308
22530
  # Configurations used to enable CMEK data encryption with Cloud KMS keys.
22309
22531
  class GoogleCloudDiscoveryengineV1betaCmekConfig
22310
22532
  include Google::Apis::Core::Hashable
@@ -22334,7 +22556,7 @@ module Google
22334
22556
 
22335
22557
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
22336
22558
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
22337
- # `cmekConfig``.
22559
+ # `cmek_config``.
22338
22560
  # Corresponds to the JSON property `name`
22339
22561
  # @return [String]
22340
22562
  attr_accessor :name
@@ -24222,7 +24444,7 @@ module Google
24222
24444
  class GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec
24223
24445
  include Google::Apis::Core::Hashable
24224
24446
 
24225
- # 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,
24226
24448
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
24227
24449
  # sampleQuerySet``.
24228
24450
  # Corresponds to the JSON property `sampleQuerySet`
@@ -25486,34 +25708,52 @@ module Google
25486
25708
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec]
25487
25709
  attr_accessor :query_expansion_spec
25488
25710
 
25489
- # The ranking expression controls the customized ranking on retrieval documents.
25490
- # This overrides ServingConfig.ranking_expression. The syntax and supported
25491
- # features depend on the ranking_expression_backend value. If
25492
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
25493
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
25494
- # 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 "+". *
25495
25717
  # ranking_expression = function, ` " + ", function `; Supported functions: *
25496
25718
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
25497
25719
  # variables: * `relevance_score`: pre-defined keywords, used for measure
25498
25720
  # relevance between query and document. * `embedding_field_path`: the document
25499
25721
  # embedding field used with query embedding vector. * `dotProduct`: embedding
25500
- # function between embedding_field_path and query embedding vector. Example
25722
+ # function between `embedding_field_path` and query embedding vector. Example
25501
25723
  # ranking expression: If document has an embedding field doc_embedding, the
25502
25724
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
25503
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
25504
- # CLEARBOX`, the following expression types (and combinations of those chained
25505
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
25506
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
25507
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
25508
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
25509
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
25510
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
25511
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
25512
- # The following signals are supported: * gecko_score -- semantic similarity
25513
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
25514
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
25515
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
25516
- # 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
25517
25757
  # Corresponds to the JSON property `rankingExpression`
25518
25758
  # @return [String]
25519
25759
  attr_accessor :ranking_expression
@@ -27113,6 +27353,69 @@ module Google
27113
27353
  end
27114
27354
  end
27115
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
+
27116
27419
  # Config to store data store type configuration for workspace data
27117
27420
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
27118
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.64.0"
19
+ GEM_VERSION = "0.65.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250521"
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
@@ -5674,6 +5730,19 @@ module Google
5674
5730
  end
5675
5731
  end
5676
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
+
5677
5746
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
5678
5747
  # @private
5679
5748
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6439,8 +6508,6 @@ module Google
6439
6508
  # @private
6440
6509
  class Representation < Google::Apis::Core::JsonRepresentation
6441
6510
  property :delete_unassigned_user_licenses, as: 'deleteUnassignedUserLicenses'
6442
- property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource::Representation
6443
-
6444
6511
  property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource::Representation
6445
6512
 
6446
6513
  end
@@ -8471,6 +8538,7 @@ module Google
8471
8538
  class GoogleCloudDiscoveryengineV1alphaPrincipal
8472
8539
  # @private
8473
8540
  class Representation < Google::Apis::Core::JsonRepresentation
8541
+ property :external_entity_id, as: 'externalEntityId'
8474
8542
  property :group_id, as: 'groupId'
8475
8543
  property :user_id, as: 'userId'
8476
8544
  end
@@ -9074,6 +9142,7 @@ module Google
9074
9142
 
9075
9143
  property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec::Representation
9076
9144
 
9145
+ property :use_latest_data, as: 'useLatestData'
9077
9146
  property :user_info, as: 'userInfo', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo::Representation
9078
9147
 
9079
9148
  hash :user_labels, as: 'userLabels'
@@ -10275,6 +10344,26 @@ module Google
10275
10344
  end
10276
10345
  end
10277
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
+
10278
10367
  class GoogleCloudDiscoveryengineV1betaCmekConfig
10279
10368
  # @private
10280
10369
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -11556,6 +11645,19 @@ module Google
11556
11645
  end
11557
11646
  end
11558
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
+
11559
11661
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
11560
11662
  # @private
11561
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.64.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.64.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: