google-apis-discoveryengine_v1beta 0.67.0 → 0.69.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: 55f64b52fa5b463e2e166928d961ef6731706728196417f5d92dabb8e769f475
4
- data.tar.gz: '02184d3f3f58c3a1e3cedbb74c4e82296e1e4646995a3e460bd244561ede5aa6'
3
+ metadata.gz: 91904a463a895559bfa3b7c0e72df667ba162d78e2b083bc6fb98b2cffc0b43b
4
+ data.tar.gz: 525cd55e903f1a3353fcb0281117631673b19e8865766a241782117088affa5d
5
5
  SHA512:
6
- metadata.gz: ff2840d8d992f22f5f04a4e5354a72177686e424223650ac74da6f6f24450e49d45da7b271820bda660e9fe27f6f7709a511c15715b8582566a0fb9207c3fdd9
7
- data.tar.gz: 3a23886a3fba3c5a46532f4dbeac95f35cc24753a48512d303c1a9e72bf3f127710caf9df2d82f64cfd16433f0367fe599a13fbbaea0634dec7c6e8a5118b72e
6
+ metadata.gz: 7195d5cf9bbe977abab90089c5f47a34d6420c6a92583558eb203755cc17e2daf9ff4f141b7976f6ddd3f2d23ae097b6a3ad726c63b93607c1656e8ff9504418
7
+ data.tar.gz: 32cb2bd3bf4e9d9408d987593136f2fb2472cf4959008d8a760d6d52361b7a22534e1ac370ac38d67fcadf38669e3683c08c0b5f3eca96075ca4d9c0f34436d0
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1beta
2
2
 
3
+ ### v0.69.0 (2025-06-15)
4
+
5
+ * Regenerated from discovery document revision 20250609
6
+
7
+ ### v0.68.0 (2025-06-08)
8
+
9
+ * Regenerated from discovery document revision 20250604
10
+
3
11
  ### v0.67.0 (2025-05-25)
4
12
 
5
13
  * Regenerated from discovery document revision 20250521
@@ -914,6 +914,71 @@ module Google
914
914
  end
915
915
  end
916
916
 
917
+ # Metadata related to the progress of the UserLicenseService.
918
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
919
+ # longrunning.Operation.metadata field.
920
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
921
+ include Google::Apis::Core::Hashable
922
+
923
+ # Operation create time.
924
+ # Corresponds to the JSON property `createTime`
925
+ # @return [String]
926
+ attr_accessor :create_time
927
+
928
+ # Count of user licenses that failed to be updated.
929
+ # Corresponds to the JSON property `failureCount`
930
+ # @return [Fixnum]
931
+ attr_accessor :failure_count
932
+
933
+ # Count of user licenses successfully updated.
934
+ # Corresponds to the JSON property `successCount`
935
+ # @return [Fixnum]
936
+ attr_accessor :success_count
937
+
938
+ # Operation last update time. If the operation is done, this is also the finish
939
+ # time.
940
+ # Corresponds to the JSON property `updateTime`
941
+ # @return [String]
942
+ attr_accessor :update_time
943
+
944
+ def initialize(**args)
945
+ update!(**args)
946
+ end
947
+
948
+ # Update properties of this object
949
+ def update!(**args)
950
+ @create_time = args[:create_time] if args.key?(:create_time)
951
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
952
+ @success_count = args[:success_count] if args.key?(:success_count)
953
+ @update_time = args[:update_time] if args.key?(:update_time)
954
+ end
955
+ end
956
+
957
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
958
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
959
+ include Google::Apis::Core::Hashable
960
+
961
+ # A sample of errors encountered while processing the request.
962
+ # Corresponds to the JSON property `errorSamples`
963
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
964
+ attr_accessor :error_samples
965
+
966
+ # UserLicenses successfully updated.
967
+ # Corresponds to the JSON property `userLicenses`
968
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1UserLicense>]
969
+ attr_accessor :user_licenses
970
+
971
+ def initialize(**args)
972
+ update!(**args)
973
+ end
974
+
975
+ # Update properties of this object
976
+ def update!(**args)
977
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
978
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
979
+ end
980
+ end
981
+
917
982
  # Configurations used to enable CMEK data encryption with Cloud KMS keys.
918
983
  class GoogleCloudDiscoveryengineV1CmekConfig
919
984
  include Google::Apis::Core::Hashable
@@ -943,7 +1008,7 @@ module Google
943
1008
 
944
1009
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
945
1010
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
946
- # `cmekConfig``.
1011
+ # `cmek_config``.
947
1012
  # Corresponds to the JSON property `name`
948
1013
  # @return [String]
949
1014
  attr_accessor :name
@@ -4394,6 +4459,69 @@ module Google
4394
4459
  end
4395
4460
  end
4396
4461
 
4462
+ # User License information assigned by the admin.
4463
+ class GoogleCloudDiscoveryengineV1UserLicense
4464
+ include Google::Apis::Core::Hashable
4465
+
4466
+ # Output only. User created timestamp.
4467
+ # Corresponds to the JSON property `createTime`
4468
+ # @return [String]
4469
+ attr_accessor :create_time
4470
+
4471
+ # Output only. User last logged in time. If the user has not logged in yet, this
4472
+ # field will be empty.
4473
+ # Corresponds to the JSON property `lastLoginTime`
4474
+ # @return [String]
4475
+ attr_accessor :last_login_time
4476
+
4477
+ # Output only. License assignment state of the user. If the user is assigned
4478
+ # with a license config, the user loggin will be assigned with the license; If
4479
+ # the user's license assignment state is unassigned or unspecified, no license
4480
+ # config will be associated to the user;
4481
+ # Corresponds to the JSON property `licenseAssignmentState`
4482
+ # @return [String]
4483
+ attr_accessor :license_assignment_state
4484
+
4485
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
4486
+ # to the user.
4487
+ # Corresponds to the JSON property `licenseConfig`
4488
+ # @return [String]
4489
+ attr_accessor :license_config
4490
+
4491
+ # Output only. User update timestamp.
4492
+ # Corresponds to the JSON property `updateTime`
4493
+ # @return [String]
4494
+ attr_accessor :update_time
4495
+
4496
+ # Required. Immutable. The user principal of the User, could be email address or
4497
+ # other prinical identifier. This field is immutable. Admin assign licenses
4498
+ # based on the user principal.
4499
+ # Corresponds to the JSON property `userPrincipal`
4500
+ # @return [String]
4501
+ attr_accessor :user_principal
4502
+
4503
+ # Optional. The user profile. We user user full name(First name + Last name) as
4504
+ # user profile.
4505
+ # Corresponds to the JSON property `userProfile`
4506
+ # @return [String]
4507
+ attr_accessor :user_profile
4508
+
4509
+ def initialize(**args)
4510
+ update!(**args)
4511
+ end
4512
+
4513
+ # Update properties of this object
4514
+ def update!(**args)
4515
+ @create_time = args[:create_time] if args.key?(:create_time)
4516
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
4517
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
4518
+ @license_config = args[:license_config] if args.key?(:license_config)
4519
+ @update_time = args[:update_time] if args.key?(:update_time)
4520
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
4521
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
4522
+ end
4523
+ end
4524
+
4397
4525
  # Config to store data store type configuration for workspace data
4398
4526
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
4399
4527
  include Google::Apis::Core::Hashable
@@ -5499,7 +5627,7 @@ module Google
5499
5627
 
5500
5628
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
5501
5629
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
5502
- # `cmekConfig``.
5630
+ # `cmek_config``.
5503
5631
  # Corresponds to the JSON property `name`
5504
5632
  # @return [String]
5505
5633
  attr_accessor :name
@@ -6500,13 +6628,13 @@ module Google
6500
6628
 
6501
6629
  # Optional. The refresh interval specifically for incremental data syncs. If
6502
6630
  # unset, incremental syncs will use the default from env, set to 3hrs. The
6503
- # minimum is 30 minutes and maximum is 7 days.
6631
+ # minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors.
6504
6632
  # Corresponds to the JSON property `incrementalRefreshInterval`
6505
6633
  # @return [String]
6506
6634
  attr_accessor :incremental_refresh_interval
6507
6635
 
6508
6636
  # Optional. Indicates whether incremental syncs are paused for this connector.
6509
- # This is independent of auto_run_disabled.
6637
+ # This is independent of auto_run_disabled. Applicable to only 3P connectors.
6510
6638
  # Corresponds to the JSON property `incrementalSyncDisabled`
6511
6639
  # @return [Boolean]
6512
6640
  attr_accessor :incremental_sync_disabled
@@ -8324,7 +8452,7 @@ module Google
8324
8452
  class GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec
8325
8453
  include Google::Apis::Core::Hashable
8326
8454
 
8327
- # Required. The full resource name of the SampleQuerySet used for the evaluation,
8455
+ # Optional. The full resource name of the SampleQuerySet used for the evaluation,
8328
8456
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
8329
8457
  # sampleQuerySet``.
8330
8458
  # Corresponds to the JSON property `sampleQuerySet`
@@ -9751,7 +9879,7 @@ module Google
9751
9879
  class GoogleCloudDiscoveryengineV1alphaQuery
9752
9880
  include Google::Apis::Core::Hashable
9753
9881
 
9754
- # Unique Id for the query.
9882
+ # Output only. Unique Id for the query.
9755
9883
  # Corresponds to the JSON property `queryId`
9756
9884
  # @return [String]
9757
9885
  attr_accessor :query_id
@@ -10314,34 +10442,52 @@ module Google
10314
10442
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec]
10315
10443
  attr_accessor :query_expansion_spec
10316
10444
 
10317
- # The ranking expression controls the customized ranking on retrieval documents.
10318
- # This overrides ServingConfig.ranking_expression. The syntax and supported
10319
- # features depend on the ranking_expression_backend value. If
10320
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
10321
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
10322
- # single function or multiple functions that are joined by "+". *
10445
+ # Optional. The ranking expression controls the customized ranking on retrieval
10446
+ # documents. This overrides ServingConfig.ranking_expression. The syntax and
10447
+ # supported features depend on the `ranking_expression_backend` value. If `
10448
+ # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
10449
+ # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
10450
+ # it should be a single function or multiple functions that are joined by "+". *
10323
10451
  # ranking_expression = function, ` " + ", function `; Supported functions: *
10324
10452
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
10325
10453
  # variables: * `relevance_score`: pre-defined keywords, used for measure
10326
10454
  # relevance between query and document. * `embedding_field_path`: the document
10327
10455
  # embedding field used with query embedding vector. * `dotProduct`: embedding
10328
- # function between embedding_field_path and query embedding vector. Example
10456
+ # function between `embedding_field_path` and query embedding vector. Example
10329
10457
  # ranking expression: If document has an embedding field doc_embedding, the
10330
10458
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
10331
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
10332
- # CLEARBOX`, the following expression types (and combinations of those chained
10333
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
10334
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
10335
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
10336
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
10337
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
10338
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
10339
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
10340
- # The following signals are supported: * gecko_score -- semantic similarity
10341
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
10342
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
10343
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
10344
- # base_rank -- the default rank of the result
10459
+ # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
10460
+ # the following expression types (and combinations of those chained using + or *
10461
+ # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
10462
+ # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
10463
+ # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
10464
+ # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
10465
+ # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
10466
+ # examples of ranking formulas that use the supported ranking expression types: -
10467
+ # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
10468
+ # mostly rank by the logarithm of `keyword_similarity_score` with slight `
10469
+ # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
10470
+ # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
10471
+ # rank by the exponent of `semantic_similarity_score` filling the value with 0
10472
+ # if it's NaN, also add constant 0.3 adjustment to the final score if `
10473
+ # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
10474
+ # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
10475
+ # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
10476
+ # semantic_smilarity_score`. The following signals are supported: * `
10477
+ # semantic_similarity_score`: semantic similarity adjustment that is calculated
10478
+ # using the embeddings generated by a proprietary Google model. This score
10479
+ # determines how semantically similar a search query is to a document. * `
10480
+ # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
10481
+ # BM25) ranking function. This score is calculated using a probabilistic model
10482
+ # to estimate the probability that a document is relevant to a given query. * `
10483
+ # relevance_score`: semantic relevance adjustment that uses a proprietary Google
10484
+ # model to determine the meaning and intent behind a user's query in context
10485
+ # with the content in the documents. * `pctr_rank`: predicted conversion rate
10486
+ # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
10487
+ # relevance and attractiveness of a search result from a user's perspective. A
10488
+ # higher pCTR suggests that the result is more likely to satisfy the user's
10489
+ # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
10490
+ # freshness adjustment as a rank * `base_rank`: the default rank of the result
10345
10491
  # Corresponds to the JSON property `rankingExpression`
10346
10492
  # @return [String]
10347
10493
  attr_accessor :ranking_expression
@@ -10426,6 +10572,15 @@ module Google
10426
10572
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec]
10427
10573
  attr_accessor :spell_correction_spec
10428
10574
 
10575
+ # Uses the Engine, ServingConfig and Control freshly read from the database.
10576
+ # Note: this skips config cache and introduces dependency on databases, which
10577
+ # could significantly increase the API latency. It should only be used for
10578
+ # testing, but not serving end users.
10579
+ # Corresponds to the JSON property `useLatestData`
10580
+ # @return [Boolean]
10581
+ attr_accessor :use_latest_data
10582
+ alias_method :use_latest_data?, :use_latest_data
10583
+
10429
10584
  # Information of an end user.
10430
10585
  # Corresponds to the JSON property `userInfo`
10431
10586
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaUserInfo]
@@ -10497,6 +10652,7 @@ module Google
10497
10652
  @session = args[:session] if args.key?(:session)
10498
10653
  @session_spec = args[:session_spec] if args.key?(:session_spec)
10499
10654
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
10655
+ @use_latest_data = args[:use_latest_data] if args.key?(:use_latest_data)
10500
10656
  @user_info = args[:user_info] if args.key?(:user_info)
10501
10657
  @user_labels = args[:user_labels] if args.key?(:user_labels)
10502
10658
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
@@ -11546,8 +11702,8 @@ module Google
11546
11702
  class GoogleCloudDiscoveryengineV1alphaSessionTurn
11547
11703
  include Google::Apis::Core::Hashable
11548
11704
 
11549
- # The resource name of the answer to the user query. Only set if the answer
11550
- # generation (/answer API call) happened in this turn.
11705
+ # Optional. The resource name of the answer to the user query. Only set if the
11706
+ # answer generation (/answer API call) happened in this turn.
11551
11707
  # Corresponds to the JSON property `answer`
11552
11708
  # @return [String]
11553
11709
  attr_accessor :answer
@@ -14687,6 +14843,46 @@ module Google
14687
14843
  end
14688
14844
  end
14689
14845
 
14846
+ # Metadata related to the progress of the UserLicenseService.
14847
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
14848
+ # longrunning.Operation.metadata field.
14849
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
14850
+ include Google::Apis::Core::Hashable
14851
+
14852
+ # Operation create time.
14853
+ # Corresponds to the JSON property `createTime`
14854
+ # @return [String]
14855
+ attr_accessor :create_time
14856
+
14857
+ # Count of user licenses that failed to be updated.
14858
+ # Corresponds to the JSON property `failureCount`
14859
+ # @return [Fixnum]
14860
+ attr_accessor :failure_count
14861
+
14862
+ # Count of user licenses successfully updated.
14863
+ # Corresponds to the JSON property `successCount`
14864
+ # @return [Fixnum]
14865
+ attr_accessor :success_count
14866
+
14867
+ # Operation last update time. If the operation is done, this is also the finish
14868
+ # time.
14869
+ # Corresponds to the JSON property `updateTime`
14870
+ # @return [String]
14871
+ attr_accessor :update_time
14872
+
14873
+ def initialize(**args)
14874
+ update!(**args)
14875
+ end
14876
+
14877
+ # Update properties of this object
14878
+ def update!(**args)
14879
+ @create_time = args[:create_time] if args.key?(:create_time)
14880
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
14881
+ @success_count = args[:success_count] if args.key?(:success_count)
14882
+ @update_time = args[:update_time] if args.key?(:update_time)
14883
+ end
14884
+ end
14885
+
14690
14886
  # Request message for UserLicenseService.BatchUpdateUserLicenses method.
14691
14887
  class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest
14692
14888
  include Google::Apis::Core::Hashable
@@ -14699,11 +14895,6 @@ module Google
14699
14895
  attr_accessor :delete_unassigned_user_licenses
14700
14896
  alias_method :delete_unassigned_user_licenses?, :delete_unassigned_user_licenses
14701
14897
 
14702
- # Cloud Storage location for input content.
14703
- # Corresponds to the JSON property `gcsSource`
14704
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource]
14705
- attr_accessor :gcs_source
14706
-
14707
14898
  # The inline source for the input config for BatchUpdateUserLicenses method.
14708
14899
  # Corresponds to the JSON property `inlineSource`
14709
14900
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource]
@@ -14716,7 +14907,6 @@ module Google
14716
14907
  # Update properties of this object
14717
14908
  def update!(**args)
14718
14909
  @delete_unassigned_user_licenses = args[:delete_unassigned_user_licenses] if args.key?(:delete_unassigned_user_licenses)
14719
- @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
14720
14910
  @inline_source = args[:inline_source] if args.key?(:inline_source)
14721
14911
  end
14722
14912
  end
@@ -14747,6 +14937,31 @@ module Google
14747
14937
  end
14748
14938
  end
14749
14939
 
14940
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
14941
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
14942
+ include Google::Apis::Core::Hashable
14943
+
14944
+ # A sample of errors encountered while processing the request.
14945
+ # Corresponds to the JSON property `errorSamples`
14946
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
14947
+ attr_accessor :error_samples
14948
+
14949
+ # UserLicenses successfully updated.
14950
+ # Corresponds to the JSON property `userLicenses`
14951
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserLicense>]
14952
+ attr_accessor :user_licenses
14953
+
14954
+ def initialize(**args)
14955
+ update!(**args)
14956
+ end
14957
+
14958
+ # Update properties of this object
14959
+ def update!(**args)
14960
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
14961
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
14962
+ end
14963
+ end
14964
+
14750
14965
  # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
14751
14966
  class GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest
14752
14967
  include Google::Apis::Core::Hashable
@@ -15514,7 +15729,7 @@ module Google
15514
15729
 
15515
15730
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
15516
15731
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
15517
- # `cmekConfig``.
15732
+ # `cmek_config``.
15518
15733
  # Corresponds to the JSON property `name`
15519
15734
  # @return [String]
15520
15735
  attr_accessor :name
@@ -18258,7 +18473,7 @@ module Google
18258
18473
  class GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec
18259
18474
  include Google::Apis::Core::Hashable
18260
18475
 
18261
- # Required. The full resource name of the SampleQuerySet used for the evaluation,
18476
+ # Optional. The full resource name of the SampleQuerySet used for the evaluation,
18262
18477
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
18263
18478
  # sampleQuerySet``.
18264
18479
  # Corresponds to the JSON property `sampleQuerySet`
@@ -20318,6 +20533,12 @@ module Google
20318
20533
  class GoogleCloudDiscoveryengineV1betaPrincipal
20319
20534
  include Google::Apis::Core::Hashable
20320
20535
 
20536
+ # For 3P application identities which are not present in the customer identity
20537
+ # provider.
20538
+ # Corresponds to the JSON property `externalEntityId`
20539
+ # @return [String]
20540
+ attr_accessor :external_entity_id
20541
+
20321
20542
  # Group identifier. For Google Workspace user account, group_id should be the
20322
20543
  # google workspace group email. For non-google identity provider user account,
20323
20544
  # group_id is the mapped group identifier configured during the workforcepool
@@ -20340,6 +20561,7 @@ module Google
20340
20561
 
20341
20562
  # Update properties of this object
20342
20563
  def update!(**args)
20564
+ @external_entity_id = args[:external_entity_id] if args.key?(:external_entity_id)
20343
20565
  @group_id = args[:group_id] if args.key?(:group_id)
20344
20566
  @user_id = args[:user_id] if args.key?(:user_id)
20345
20567
  end
@@ -20907,7 +21129,7 @@ module Google
20907
21129
  class GoogleCloudDiscoveryengineV1betaQuery
20908
21130
  include Google::Apis::Core::Hashable
20909
21131
 
20910
- # Unique Id for the query.
21132
+ # Output only. Unique Id for the query.
20911
21133
  # Corresponds to the JSON property `queryId`
20912
21134
  # @return [String]
20913
21135
  attr_accessor :query_id
@@ -21960,34 +22182,52 @@ module Google
21960
22182
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec]
21961
22183
  attr_accessor :query_expansion_spec
21962
22184
 
21963
- # The ranking expression controls the customized ranking on retrieval documents.
21964
- # This overrides ServingConfig.ranking_expression. The syntax and supported
21965
- # features depend on the ranking_expression_backend value. If
21966
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
21967
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
21968
- # single function or multiple functions that are joined by "+". *
22185
+ # Optional. The ranking expression controls the customized ranking on retrieval
22186
+ # documents. This overrides ServingConfig.ranking_expression. The syntax and
22187
+ # supported features depend on the `ranking_expression_backend` value. If `
22188
+ # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
22189
+ # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
22190
+ # it should be a single function or multiple functions that are joined by "+". *
21969
22191
  # ranking_expression = function, ` " + ", function `; Supported functions: *
21970
22192
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
21971
22193
  # variables: * `relevance_score`: pre-defined keywords, used for measure
21972
22194
  # relevance between query and document. * `embedding_field_path`: the document
21973
22195
  # embedding field used with query embedding vector. * `dotProduct`: embedding
21974
- # function between embedding_field_path and query embedding vector. Example
22196
+ # function between `embedding_field_path` and query embedding vector. Example
21975
22197
  # ranking expression: If document has an embedding field doc_embedding, the
21976
22198
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
21977
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
21978
- # CLEARBOX`, the following expression types (and combinations of those chained
21979
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
21980
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
21981
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
21982
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
21983
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
21984
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
21985
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
21986
- # The following signals are supported: * gecko_score -- semantic similarity
21987
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
21988
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
21989
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
21990
- # base_rank -- the default rank of the result
22199
+ # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
22200
+ # the following expression types (and combinations of those chained using + or *
22201
+ # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
22202
+ # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
22203
+ # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
22204
+ # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
22205
+ # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
22206
+ # examples of ranking formulas that use the supported ranking expression types: -
22207
+ # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
22208
+ # mostly rank by the logarithm of `keyword_similarity_score` with slight `
22209
+ # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
22210
+ # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
22211
+ # rank by the exponent of `semantic_similarity_score` filling the value with 0
22212
+ # if it's NaN, also add constant 0.3 adjustment to the final score if `
22213
+ # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
22214
+ # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
22215
+ # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
22216
+ # semantic_smilarity_score`. The following signals are supported: * `
22217
+ # semantic_similarity_score`: semantic similarity adjustment that is calculated
22218
+ # using the embeddings generated by a proprietary Google model. This score
22219
+ # determines how semantically similar a search query is to a document. * `
22220
+ # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
22221
+ # BM25) ranking function. This score is calculated using a probabilistic model
22222
+ # to estimate the probability that a document is relevant to a given query. * `
22223
+ # relevance_score`: semantic relevance adjustment that uses a proprietary Google
22224
+ # model to determine the meaning and intent behind a user's query in context
22225
+ # with the content in the documents. * `pctr_rank`: predicted conversion rate
22226
+ # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
22227
+ # relevance and attractiveness of a search result from a user's perspective. A
22228
+ # higher pCTR suggests that the result is more likely to satisfy the user's
22229
+ # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
22230
+ # freshness adjustment as a rank * `base_rank`: the default rank of the result
21991
22231
  # Corresponds to the JSON property `rankingExpression`
21992
22232
  # @return [String]
21993
22233
  attr_accessor :ranking_expression
@@ -24420,8 +24660,8 @@ module Google
24420
24660
  class GoogleCloudDiscoveryengineV1betaSessionTurn
24421
24661
  include Google::Apis::Core::Hashable
24422
24662
 
24423
- # The resource name of the answer to the user query. Only set if the answer
24424
- # generation (/answer API call) happened in this turn.
24663
+ # Optional. The resource name of the answer to the user query. Only set if the
24664
+ # answer generation (/answer API call) happened in this turn.
24425
24665
  # Corresponds to the JSON property `answer`
24426
24666
  # @return [String]
24427
24667
  attr_accessor :answer
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1beta
18
18
  # Version of the google-apis-discoveryengine_v1beta gem
19
- GEM_VERSION = "0.67.0"
19
+ GEM_VERSION = "0.69.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
@@ -160,6 +160,18 @@ module Google
160
160
  include Google::Apis::Core::JsonObjectSupport
161
161
  end
162
162
 
163
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
169
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
170
+ class Representation < Google::Apis::Core::JsonRepresentation; end
171
+
172
+ include Google::Apis::Core::JsonObjectSupport
173
+ end
174
+
163
175
  class GoogleCloudDiscoveryengineV1CmekConfig
164
176
  class Representation < Google::Apis::Core::JsonRepresentation; end
165
177
 
@@ -718,6 +730,12 @@ module Google
718
730
  include Google::Apis::Core::JsonObjectSupport
719
731
  end
720
732
 
733
+ class GoogleCloudDiscoveryengineV1UserLicense
734
+ class Representation < Google::Apis::Core::JsonRepresentation; end
735
+
736
+ include Google::Apis::Core::JsonObjectSupport
737
+ end
738
+
721
739
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
722
740
  class Representation < Google::Apis::Core::JsonRepresentation; end
723
741
 
@@ -2362,6 +2380,12 @@ module Google
2362
2380
  include Google::Apis::Core::JsonObjectSupport
2363
2381
  end
2364
2382
 
2383
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
2384
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2385
+
2386
+ include Google::Apis::Core::JsonObjectSupport
2387
+ end
2388
+
2365
2389
  class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest
2366
2390
  class Representation < Google::Apis::Core::JsonRepresentation; end
2367
2391
 
@@ -2374,6 +2398,12 @@ module Google
2374
2398
  include Google::Apis::Core::JsonObjectSupport
2375
2399
  end
2376
2400
 
2401
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
2402
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2403
+
2404
+ include Google::Apis::Core::JsonObjectSupport
2405
+ end
2406
+
2377
2407
  class GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest
2378
2408
  class Representation < Google::Apis::Core::JsonRepresentation; end
2379
2409
 
@@ -4403,6 +4433,26 @@ module Google
4403
4433
  end
4404
4434
  end
4405
4435
 
4436
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
4437
+ # @private
4438
+ class Representation < Google::Apis::Core::JsonRepresentation
4439
+ property :create_time, as: 'createTime'
4440
+ property :failure_count, :numeric_string => true, as: 'failureCount'
4441
+ property :success_count, :numeric_string => true, as: 'successCount'
4442
+ property :update_time, as: 'updateTime'
4443
+ end
4444
+ end
4445
+
4446
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
4447
+ # @private
4448
+ class Representation < Google::Apis::Core::JsonRepresentation
4449
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
4450
+
4451
+ collection :user_licenses, as: 'userLicenses', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1UserLicense, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1UserLicense::Representation
4452
+
4453
+ end
4454
+ end
4455
+
4406
4456
  class GoogleCloudDiscoveryengineV1CmekConfig
4407
4457
  # @private
4408
4458
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5325,6 +5375,19 @@ module Google
5325
5375
  end
5326
5376
  end
5327
5377
 
5378
+ class GoogleCloudDiscoveryengineV1UserLicense
5379
+ # @private
5380
+ class Representation < Google::Apis::Core::JsonRepresentation
5381
+ property :create_time, as: 'createTime'
5382
+ property :last_login_time, as: 'lastLoginTime'
5383
+ property :license_assignment_state, as: 'licenseAssignmentState'
5384
+ property :license_config, as: 'licenseConfig'
5385
+ property :update_time, as: 'updateTime'
5386
+ property :user_principal, as: 'userPrincipal'
5387
+ property :user_profile, as: 'userProfile'
5388
+ end
5389
+ end
5390
+
5328
5391
  class GoogleCloudDiscoveryengineV1WorkspaceConfig
5329
5392
  # @private
5330
5393
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6951,6 +7014,7 @@ module Google
6951
7014
 
6952
7015
  property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec::Representation
6953
7016
 
7017
+ property :use_latest_data, as: 'useLatestData'
6954
7018
  property :user_info, as: 'userInfo', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaUserInfo, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaUserInfo::Representation
6955
7019
 
6956
7020
  hash :user_labels, as: 'userLabels'
@@ -8121,12 +8185,20 @@ module Google
8121
8185
  end
8122
8186
  end
8123
8187
 
8188
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
8189
+ # @private
8190
+ class Representation < Google::Apis::Core::JsonRepresentation
8191
+ property :create_time, as: 'createTime'
8192
+ property :failure_count, :numeric_string => true, as: 'failureCount'
8193
+ property :success_count, :numeric_string => true, as: 'successCount'
8194
+ property :update_time, as: 'updateTime'
8195
+ end
8196
+ end
8197
+
8124
8198
  class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest
8125
8199
  # @private
8126
8200
  class Representation < Google::Apis::Core::JsonRepresentation
8127
8201
  property :delete_unassigned_user_licenses, as: 'deleteUnassignedUserLicenses'
8128
- property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource::Representation
8129
-
8130
8202
  property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource::Representation
8131
8203
 
8132
8204
  end
@@ -8141,6 +8213,16 @@ module Google
8141
8213
  end
8142
8214
  end
8143
8215
 
8216
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
8217
+ # @private
8218
+ class Representation < Google::Apis::Core::JsonRepresentation
8219
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
8220
+
8221
+ collection :user_licenses, as: 'userLicenses', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserLicense, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserLicense::Representation
8222
+
8223
+ end
8224
+ end
8225
+
8144
8226
  class GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest
8145
8227
  # @private
8146
8228
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -9732,6 +9814,7 @@ module Google
9732
9814
  class GoogleCloudDiscoveryengineV1betaPrincipal
9733
9815
  # @private
9734
9816
  class Representation < Google::Apis::Core::JsonRepresentation
9817
+ property :external_entity_id, as: 'externalEntityId'
9735
9818
  property :group_id, as: 'groupId'
9736
9819
  property :user_id, as: 'userId'
9737
9820
  end
@@ -241,7 +241,7 @@ module Google
241
241
  # @param [String] name
242
242
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
243
243
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
244
- # `cmekConfig``.
244
+ # `cmek_config``.
245
245
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig] google_cloud_discoveryengine_v1beta_cmek_config_object
246
246
  # @param [Boolean] set_default
247
247
  # Set the following CmekConfig as the default to be used for child resources if
@@ -379,7 +379,7 @@ module Google
379
379
  # @param [String] name
380
380
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
381
381
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
382
- # `cmekConfig``.
382
+ # `cmek_config``.
383
383
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig] google_cloud_discoveryengine_v1beta_cmek_config_object
384
384
  # @param [Boolean] set_default
385
385
  # 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_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.67.0
4
+ version: 0.69.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_v1beta/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.67.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.69.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
62
62
  rdoc_options: []
63
63
  require_paths: