google-apis-discoveryengine_v1 0.39.0 → 0.41.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: 4a797385247771e27eabc70cc34e579fba1f902c918785d1dc34611c692d5ff2
4
- data.tar.gz: 16299e0fad7ad9c31fb610432ee5b7dc46743ff10f2eb5915a27435d3bc7232d
3
+ metadata.gz: 1a9bab2651820fdf80d2d7a4210951ee9e938f214c53d3f1f6241b37bbdf2a50
4
+ data.tar.gz: 6ef540a69afe8d970b16e95befb7e04be9154ae9a1c3112abf78c13393e21a7e
5
5
  SHA512:
6
- metadata.gz: 0ae2b818fdd58bac605049787de8ebb9951fd5e07181b4304fa29d215348810a16093826178491ac460974feb17eaadf76591acd6c8d54461f96b6e16589f577
7
- data.tar.gz: cee25acc8ffc3628cda9c28220f2fbba12ec6d0c5c03dfe75ebf220c90009f0c51d7aa522a2b79802bb5d93971e84ad97028c99ab37fb7e0458c185b4e3b2ad6
6
+ metadata.gz: 1ddbec02b6828c64488e64c580aab7995391015feb4cbb95784548989981a8823d94198227239830b083815226d9f4daec6d130f9b5ad34312a0316608024ac2
7
+ data.tar.gz: 5dfcc952bb8581a2b89957759613c551e58d237c78e5831d2acd57800a9eace03a44e328d7f6803f3dbb89bcd0e358bc19ef5b2648d8658e34e0fe6642c084f8
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1
2
2
 
3
+ ### v0.41.0 (2025-06-15)
4
+
5
+ * Regenerated from discovery document revision 20250609
6
+
7
+ ### v0.40.0 (2025-06-08)
8
+
9
+ * Regenerated from discovery document revision 20250604
10
+
3
11
  ### v0.39.0 (2025-05-25)
4
12
 
5
13
  * Regenerated from discovery document revision 20250521
@@ -2657,6 +2657,46 @@ module Google
2657
2657
  end
2658
2658
  end
2659
2659
 
2660
+ # Metadata related to the progress of the UserLicenseService.
2661
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
2662
+ # longrunning.Operation.metadata field.
2663
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
2664
+ include Google::Apis::Core::Hashable
2665
+
2666
+ # Operation create time.
2667
+ # Corresponds to the JSON property `createTime`
2668
+ # @return [String]
2669
+ attr_accessor :create_time
2670
+
2671
+ # Count of user licenses that failed to be updated.
2672
+ # Corresponds to the JSON property `failureCount`
2673
+ # @return [Fixnum]
2674
+ attr_accessor :failure_count
2675
+
2676
+ # Count of user licenses successfully updated.
2677
+ # Corresponds to the JSON property `successCount`
2678
+ # @return [Fixnum]
2679
+ attr_accessor :success_count
2680
+
2681
+ # Operation last update time. If the operation is done, this is also the finish
2682
+ # time.
2683
+ # Corresponds to the JSON property `updateTime`
2684
+ # @return [String]
2685
+ attr_accessor :update_time
2686
+
2687
+ def initialize(**args)
2688
+ update!(**args)
2689
+ end
2690
+
2691
+ # Update properties of this object
2692
+ def update!(**args)
2693
+ @create_time = args[:create_time] if args.key?(:create_time)
2694
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
2695
+ @success_count = args[:success_count] if args.key?(:success_count)
2696
+ @update_time = args[:update_time] if args.key?(:update_time)
2697
+ end
2698
+ end
2699
+
2660
2700
  # Request message for UserLicenseService.BatchUpdateUserLicenses method.
2661
2701
  class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest
2662
2702
  include Google::Apis::Core::Hashable
@@ -2669,11 +2709,6 @@ module Google
2669
2709
  attr_accessor :delete_unassigned_user_licenses
2670
2710
  alias_method :delete_unassigned_user_licenses?, :delete_unassigned_user_licenses
2671
2711
 
2672
- # Cloud Storage location for input content.
2673
- # Corresponds to the JSON property `gcsSource`
2674
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
2675
- attr_accessor :gcs_source
2676
-
2677
2712
  # The inline source for the input config for BatchUpdateUserLicenses method.
2678
2713
  # Corresponds to the JSON property `inlineSource`
2679
2714
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource]
@@ -2686,7 +2721,6 @@ module Google
2686
2721
  # Update properties of this object
2687
2722
  def update!(**args)
2688
2723
  @delete_unassigned_user_licenses = args[:delete_unassigned_user_licenses] if args.key?(:delete_unassigned_user_licenses)
2689
- @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
2690
2724
  @inline_source = args[:inline_source] if args.key?(:inline_source)
2691
2725
  end
2692
2726
  end
@@ -2717,6 +2751,31 @@ module Google
2717
2751
  end
2718
2752
  end
2719
2753
 
2754
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
2755
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
2756
+ include Google::Apis::Core::Hashable
2757
+
2758
+ # A sample of errors encountered while processing the request.
2759
+ # Corresponds to the JSON property `errorSamples`
2760
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
2761
+ attr_accessor :error_samples
2762
+
2763
+ # UserLicenses successfully updated.
2764
+ # Corresponds to the JSON property `userLicenses`
2765
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserLicense>]
2766
+ attr_accessor :user_licenses
2767
+
2768
+ def initialize(**args)
2769
+ update!(**args)
2770
+ end
2771
+
2772
+ # Update properties of this object
2773
+ def update!(**args)
2774
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
2775
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
2776
+ end
2777
+ end
2778
+
2720
2779
  # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
2721
2780
  class GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest
2722
2781
  include Google::Apis::Core::Hashable
@@ -3484,7 +3543,7 @@ module Google
3484
3543
 
3485
3544
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
3486
3545
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
3487
- # `cmekConfig``.
3546
+ # `cmek_config``.
3488
3547
  # Corresponds to the JSON property `name`
3489
3548
  # @return [String]
3490
3549
  attr_accessor :name
@@ -7634,6 +7693,12 @@ module Google
7634
7693
  class GoogleCloudDiscoveryengineV1Principal
7635
7694
  include Google::Apis::Core::Hashable
7636
7695
 
7696
+ # For 3P application identities which are not present in the customer identity
7697
+ # provider.
7698
+ # Corresponds to the JSON property `externalEntityId`
7699
+ # @return [String]
7700
+ attr_accessor :external_entity_id
7701
+
7637
7702
  # Group identifier. For Google Workspace user account, group_id should be the
7638
7703
  # google workspace group email. For non-google identity provider user account,
7639
7704
  # group_id is the mapped group identifier configured during the workforcepool
@@ -7656,6 +7721,7 @@ module Google
7656
7721
 
7657
7722
  # Update properties of this object
7658
7723
  def update!(**args)
7724
+ @external_entity_id = args[:external_entity_id] if args.key?(:external_entity_id)
7659
7725
  @group_id = args[:group_id] if args.key?(:group_id)
7660
7726
  @user_id = args[:user_id] if args.key?(:user_id)
7661
7727
  end
@@ -8196,7 +8262,7 @@ module Google
8196
8262
  class GoogleCloudDiscoveryengineV1Query
8197
8263
  include Google::Apis::Core::Hashable
8198
8264
 
8199
- # Unique Id for the query.
8265
+ # Output only. Unique Id for the query.
8200
8266
  # Corresponds to the JSON property `queryId`
8201
8267
  # @return [String]
8202
8268
  attr_accessor :query_id
@@ -10685,8 +10751,8 @@ module Google
10685
10751
  class GoogleCloudDiscoveryengineV1SessionTurn
10686
10752
  include Google::Apis::Core::Hashable
10687
10753
 
10688
- # The resource name of the answer to the user query. Only set if the answer
10689
- # generation (/answer API call) happened in this turn.
10754
+ # Optional. The resource name of the answer to the user query. Only set if the
10755
+ # answer generation (/answer API call) happened in this turn.
10690
10756
  # Corresponds to the JSON property `answer`
10691
10757
  # @return [String]
10692
10758
  attr_accessor :answer
@@ -12782,7 +12848,7 @@ module Google
12782
12848
 
12783
12849
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
12784
12850
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
12785
- # `cmekConfig``.
12851
+ # `cmek_config``.
12786
12852
  # Corresponds to the JSON property `name`
12787
12853
  # @return [String]
12788
12854
  attr_accessor :name
@@ -13783,13 +13849,13 @@ module Google
13783
13849
 
13784
13850
  # Optional. The refresh interval specifically for incremental data syncs. If
13785
13851
  # unset, incremental syncs will use the default from env, set to 3hrs. The
13786
- # minimum is 30 minutes and maximum is 7 days.
13852
+ # minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors.
13787
13853
  # Corresponds to the JSON property `incrementalRefreshInterval`
13788
13854
  # @return [String]
13789
13855
  attr_accessor :incremental_refresh_interval
13790
13856
 
13791
13857
  # Optional. Indicates whether incremental syncs are paused for this connector.
13792
- # This is independent of auto_run_disabled.
13858
+ # This is independent of auto_run_disabled. Applicable to only 3P connectors.
13793
13859
  # Corresponds to the JSON property `incrementalSyncDisabled`
13794
13860
  # @return [Boolean]
13795
13861
  attr_accessor :incremental_sync_disabled
@@ -15607,7 +15673,7 @@ module Google
15607
15673
  class GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec
15608
15674
  include Google::Apis::Core::Hashable
15609
15675
 
15610
- # Required. The full resource name of the SampleQuerySet used for the evaluation,
15676
+ # Optional. The full resource name of the SampleQuerySet used for the evaluation,
15611
15677
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
15612
15678
  # sampleQuerySet``.
15613
15679
  # Corresponds to the JSON property `sampleQuerySet`
@@ -17034,7 +17100,7 @@ module Google
17034
17100
  class GoogleCloudDiscoveryengineV1alphaQuery
17035
17101
  include Google::Apis::Core::Hashable
17036
17102
 
17037
- # Unique Id for the query.
17103
+ # Output only. Unique Id for the query.
17038
17104
  # Corresponds to the JSON property `queryId`
17039
17105
  # @return [String]
17040
17106
  attr_accessor :query_id
@@ -17597,34 +17663,52 @@ module Google
17597
17663
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec]
17598
17664
  attr_accessor :query_expansion_spec
17599
17665
 
17600
- # The ranking expression controls the customized ranking on retrieval documents.
17601
- # This overrides ServingConfig.ranking_expression. The syntax and supported
17602
- # features depend on the ranking_expression_backend value. If
17603
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
17604
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
17605
- # single function or multiple functions that are joined by "+". *
17666
+ # Optional. The ranking expression controls the customized ranking on retrieval
17667
+ # documents. This overrides ServingConfig.ranking_expression. The syntax and
17668
+ # supported features depend on the `ranking_expression_backend` value. If `
17669
+ # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
17670
+ # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
17671
+ # it should be a single function or multiple functions that are joined by "+". *
17606
17672
  # ranking_expression = function, ` " + ", function `; Supported functions: *
17607
17673
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
17608
17674
  # variables: * `relevance_score`: pre-defined keywords, used for measure
17609
17675
  # relevance between query and document. * `embedding_field_path`: the document
17610
17676
  # embedding field used with query embedding vector. * `dotProduct`: embedding
17611
- # function between embedding_field_path and query embedding vector. Example
17677
+ # function between `embedding_field_path` and query embedding vector. Example
17612
17678
  # ranking expression: If document has an embedding field doc_embedding, the
17613
17679
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
17614
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
17615
- # CLEARBOX`, the following expression types (and combinations of those chained
17616
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
17617
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
17618
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
17619
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
17620
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
17621
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
17622
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
17623
- # The following signals are supported: * gecko_score -- semantic similarity
17624
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
17625
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
17626
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
17627
- # base_rank -- the default rank of the result
17680
+ # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
17681
+ # the following expression types (and combinations of those chained using + or *
17682
+ # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
17683
+ # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
17684
+ # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
17685
+ # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
17686
+ # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
17687
+ # examples of ranking formulas that use the supported ranking expression types: -
17688
+ # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
17689
+ # mostly rank by the logarithm of `keyword_similarity_score` with slight `
17690
+ # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
17691
+ # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
17692
+ # rank by the exponent of `semantic_similarity_score` filling the value with 0
17693
+ # if it's NaN, also add constant 0.3 adjustment to the final score if `
17694
+ # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
17695
+ # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
17696
+ # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
17697
+ # semantic_smilarity_score`. The following signals are supported: * `
17698
+ # semantic_similarity_score`: semantic similarity adjustment that is calculated
17699
+ # using the embeddings generated by a proprietary Google model. This score
17700
+ # determines how semantically similar a search query is to a document. * `
17701
+ # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
17702
+ # BM25) ranking function. This score is calculated using a probabilistic model
17703
+ # to estimate the probability that a document is relevant to a given query. * `
17704
+ # relevance_score`: semantic relevance adjustment that uses a proprietary Google
17705
+ # model to determine the meaning and intent behind a user's query in context
17706
+ # with the content in the documents. * `pctr_rank`: predicted conversion rate
17707
+ # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
17708
+ # relevance and attractiveness of a search result from a user's perspective. A
17709
+ # higher pCTR suggests that the result is more likely to satisfy the user's
17710
+ # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
17711
+ # freshness adjustment as a rank * `base_rank`: the default rank of the result
17628
17712
  # Corresponds to the JSON property `rankingExpression`
17629
17713
  # @return [String]
17630
17714
  attr_accessor :ranking_expression
@@ -17709,6 +17793,15 @@ module Google
17709
17793
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec]
17710
17794
  attr_accessor :spell_correction_spec
17711
17795
 
17796
+ # Uses the Engine, ServingConfig and Control freshly read from the database.
17797
+ # Note: this skips config cache and introduces dependency on databases, which
17798
+ # could significantly increase the API latency. It should only be used for
17799
+ # testing, but not serving end users.
17800
+ # Corresponds to the JSON property `useLatestData`
17801
+ # @return [Boolean]
17802
+ attr_accessor :use_latest_data
17803
+ alias_method :use_latest_data?, :use_latest_data
17804
+
17712
17805
  # Information of an end user.
17713
17806
  # Corresponds to the JSON property `userInfo`
17714
17807
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaUserInfo]
@@ -17780,6 +17873,7 @@ module Google
17780
17873
  @session = args[:session] if args.key?(:session)
17781
17874
  @session_spec = args[:session_spec] if args.key?(:session_spec)
17782
17875
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
17876
+ @use_latest_data = args[:use_latest_data] if args.key?(:use_latest_data)
17783
17877
  @user_info = args[:user_info] if args.key?(:user_info)
17784
17878
  @user_labels = args[:user_labels] if args.key?(:user_labels)
17785
17879
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
@@ -18829,8 +18923,8 @@ module Google
18829
18923
  class GoogleCloudDiscoveryengineV1alphaSessionTurn
18830
18924
  include Google::Apis::Core::Hashable
18831
18925
 
18832
- # The resource name of the answer to the user query. Only set if the answer
18833
- # generation (/answer API call) happened in this turn.
18926
+ # Optional. The resource name of the answer to the user query. Only set if the
18927
+ # answer generation (/answer API call) happened in this turn.
18834
18928
  # Corresponds to the JSON property `answer`
18835
18929
  # @return [String]
18836
18930
  attr_accessor :answer
@@ -19638,6 +19732,71 @@ module Google
19638
19732
  end
19639
19733
  end
19640
19734
 
19735
+ # Metadata related to the progress of the UserLicenseService.
19736
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
19737
+ # longrunning.Operation.metadata field.
19738
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
19739
+ include Google::Apis::Core::Hashable
19740
+
19741
+ # Operation create time.
19742
+ # Corresponds to the JSON property `createTime`
19743
+ # @return [String]
19744
+ attr_accessor :create_time
19745
+
19746
+ # Count of user licenses that failed to be updated.
19747
+ # Corresponds to the JSON property `failureCount`
19748
+ # @return [Fixnum]
19749
+ attr_accessor :failure_count
19750
+
19751
+ # Count of user licenses successfully updated.
19752
+ # Corresponds to the JSON property `successCount`
19753
+ # @return [Fixnum]
19754
+ attr_accessor :success_count
19755
+
19756
+ # Operation last update time. If the operation is done, this is also the finish
19757
+ # time.
19758
+ # Corresponds to the JSON property `updateTime`
19759
+ # @return [String]
19760
+ attr_accessor :update_time
19761
+
19762
+ def initialize(**args)
19763
+ update!(**args)
19764
+ end
19765
+
19766
+ # Update properties of this object
19767
+ def update!(**args)
19768
+ @create_time = args[:create_time] if args.key?(:create_time)
19769
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
19770
+ @success_count = args[:success_count] if args.key?(:success_count)
19771
+ @update_time = args[:update_time] if args.key?(:update_time)
19772
+ end
19773
+ end
19774
+
19775
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
19776
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
19777
+ include Google::Apis::Core::Hashable
19778
+
19779
+ # A sample of errors encountered while processing the request.
19780
+ # Corresponds to the JSON property `errorSamples`
19781
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
19782
+ attr_accessor :error_samples
19783
+
19784
+ # UserLicenses successfully updated.
19785
+ # Corresponds to the JSON property `userLicenses`
19786
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaUserLicense>]
19787
+ attr_accessor :user_licenses
19788
+
19789
+ def initialize(**args)
19790
+ update!(**args)
19791
+ end
19792
+
19793
+ # Update properties of this object
19794
+ def update!(**args)
19795
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
19796
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
19797
+ end
19798
+ end
19799
+
19641
19800
  # Configurations used to enable CMEK data encryption with Cloud KMS keys.
19642
19801
  class GoogleCloudDiscoveryengineV1betaCmekConfig
19643
19802
  include Google::Apis::Core::Hashable
@@ -19667,7 +19826,7 @@ module Google
19667
19826
 
19668
19827
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
19669
19828
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
19670
- # `cmekConfig``.
19829
+ # `cmek_config``.
19671
19830
  # Corresponds to the JSON property `name`
19672
19831
  # @return [String]
19673
19832
  attr_accessor :name
@@ -21555,7 +21714,7 @@ module Google
21555
21714
  class GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec
21556
21715
  include Google::Apis::Core::Hashable
21557
21716
 
21558
- # Required. The full resource name of the SampleQuerySet used for the evaluation,
21717
+ # Optional. The full resource name of the SampleQuerySet used for the evaluation,
21559
21718
  # in the format of `projects/`project`/locations/`location`/sampleQuerySets/`
21560
21719
  # sampleQuerySet``.
21561
21720
  # Corresponds to the JSON property `sampleQuerySet`
@@ -22819,34 +22978,52 @@ module Google
22819
22978
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec]
22820
22979
  attr_accessor :query_expansion_spec
22821
22980
 
22822
- # The ranking expression controls the customized ranking on retrieval documents.
22823
- # This overrides ServingConfig.ranking_expression. The syntax and supported
22824
- # features depend on the ranking_expression_backend value. If
22825
- # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
22826
- # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
22827
- # single function or multiple functions that are joined by "+". *
22981
+ # Optional. The ranking expression controls the customized ranking on retrieval
22982
+ # documents. This overrides ServingConfig.ranking_expression. The syntax and
22983
+ # supported features depend on the `ranking_expression_backend` value. If `
22984
+ # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
22985
+ # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
22986
+ # it should be a single function or multiple functions that are joined by "+". *
22828
22987
  # ranking_expression = function, ` " + ", function `; Supported functions: *
22829
22988
  # double * relevance_score * double * dotProduct(embedding_field_path) Function
22830
22989
  # variables: * `relevance_score`: pre-defined keywords, used for measure
22831
22990
  # relevance between query and document. * `embedding_field_path`: the document
22832
22991
  # embedding field used with query embedding vector. * `dotProduct`: embedding
22833
- # function between embedding_field_path and query embedding vector. Example
22992
+ # function between `embedding_field_path` and query embedding vector. Example
22834
22993
  # ranking expression: If document has an embedding field doc_embedding, the
22835
22994
  # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
22836
- # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
22837
- # CLEARBOX`, the following expression types (and combinations of those chained
22838
- # using + or * operators) are supported: * double * signal * log(signal) * exp(
22839
- # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
22840
- # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
22841
- # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
22842
- # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
22843
- # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
22844
- # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
22845
- # The following signals are supported: * gecko_score -- semantic similarity
22846
- # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
22847
- # semantic relevance adjustment * pctr_rank -- predicted conversion rate
22848
- # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
22849
- # base_rank -- the default rank of the result
22995
+ # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
22996
+ # the following expression types (and combinations of those chained using + or *
22997
+ # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
22998
+ # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
22999
+ # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
23000
+ # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
23001
+ # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
23002
+ # examples of ranking formulas that use the supported ranking expression types: -
23003
+ # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
23004
+ # mostly rank by the logarithm of `keyword_similarity_score` with slight `
23005
+ # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
23006
+ # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
23007
+ # rank by the exponent of `semantic_similarity_score` filling the value with 0
23008
+ # if it's NaN, also add constant 0.3 adjustment to the final score if `
23009
+ # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
23010
+ # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
23011
+ # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
23012
+ # semantic_smilarity_score`. The following signals are supported: * `
23013
+ # semantic_similarity_score`: semantic similarity adjustment that is calculated
23014
+ # using the embeddings generated by a proprietary Google model. This score
23015
+ # determines how semantically similar a search query is to a document. * `
23016
+ # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
23017
+ # BM25) ranking function. This score is calculated using a probabilistic model
23018
+ # to estimate the probability that a document is relevant to a given query. * `
23019
+ # relevance_score`: semantic relevance adjustment that uses a proprietary Google
23020
+ # model to determine the meaning and intent behind a user's query in context
23021
+ # with the content in the documents. * `pctr_rank`: predicted conversion rate
23022
+ # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
23023
+ # relevance and attractiveness of a search result from a user's perspective. A
23024
+ # higher pCTR suggests that the result is more likely to satisfy the user's
23025
+ # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
23026
+ # freshness adjustment as a rank * `base_rank`: the default rank of the result
22850
23027
  # Corresponds to the JSON property `rankingExpression`
22851
23028
  # @return [String]
22852
23029
  attr_accessor :ranking_expression
@@ -24446,6 +24623,69 @@ module Google
24446
24623
  end
24447
24624
  end
24448
24625
 
24626
+ # User License information assigned by the admin.
24627
+ class GoogleCloudDiscoveryengineV1betaUserLicense
24628
+ include Google::Apis::Core::Hashable
24629
+
24630
+ # Output only. User created timestamp.
24631
+ # Corresponds to the JSON property `createTime`
24632
+ # @return [String]
24633
+ attr_accessor :create_time
24634
+
24635
+ # Output only. User last logged in time. If the user has not logged in yet, this
24636
+ # field will be empty.
24637
+ # Corresponds to the JSON property `lastLoginTime`
24638
+ # @return [String]
24639
+ attr_accessor :last_login_time
24640
+
24641
+ # Output only. License assignment state of the user. If the user is assigned
24642
+ # with a license config, the user loggin will be assigned with the license; If
24643
+ # the user's license assignment state is unassigned or unspecified, no license
24644
+ # config will be associated to the user;
24645
+ # Corresponds to the JSON property `licenseAssignmentState`
24646
+ # @return [String]
24647
+ attr_accessor :license_assignment_state
24648
+
24649
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
24650
+ # to the user.
24651
+ # Corresponds to the JSON property `licenseConfig`
24652
+ # @return [String]
24653
+ attr_accessor :license_config
24654
+
24655
+ # Output only. User update timestamp.
24656
+ # Corresponds to the JSON property `updateTime`
24657
+ # @return [String]
24658
+ attr_accessor :update_time
24659
+
24660
+ # Required. Immutable. The user principal of the User, could be email address or
24661
+ # other prinical identifier. This field is immutable. Admin assign licenses
24662
+ # based on the user principal.
24663
+ # Corresponds to the JSON property `userPrincipal`
24664
+ # @return [String]
24665
+ attr_accessor :user_principal
24666
+
24667
+ # Optional. The user profile. We user user full name(First name + Last name) as
24668
+ # user profile.
24669
+ # Corresponds to the JSON property `userProfile`
24670
+ # @return [String]
24671
+ attr_accessor :user_profile
24672
+
24673
+ def initialize(**args)
24674
+ update!(**args)
24675
+ end
24676
+
24677
+ # Update properties of this object
24678
+ def update!(**args)
24679
+ @create_time = args[:create_time] if args.key?(:create_time)
24680
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
24681
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
24682
+ @license_config = args[:license_config] if args.key?(:license_config)
24683
+ @update_time = args[:update_time] if args.key?(:update_time)
24684
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
24685
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
24686
+ end
24687
+ end
24688
+
24449
24689
  # Config to store data store type configuration for workspace data
24450
24690
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
24451
24691
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1
18
18
  # Version of the google-apis-discoveryengine_v1 gem
19
- GEM_VERSION = "0.39.0"
19
+ GEM_VERSION = "0.41.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
@@ -466,6 +466,12 @@ module Google
466
466
  include Google::Apis::Core::JsonObjectSupport
467
467
  end
468
468
 
469
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
470
+ class Representation < Google::Apis::Core::JsonRepresentation; end
471
+
472
+ include Google::Apis::Core::JsonObjectSupport
473
+ end
474
+
469
475
  class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest
470
476
  class Representation < Google::Apis::Core::JsonRepresentation; end
471
477
 
@@ -478,6 +484,12 @@ module Google
478
484
  include Google::Apis::Core::JsonObjectSupport
479
485
  end
480
486
 
487
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
488
+ class Representation < Google::Apis::Core::JsonRepresentation; end
489
+
490
+ include Google::Apis::Core::JsonObjectSupport
491
+ end
492
+
481
493
  class GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest
482
494
  class Representation < Google::Apis::Core::JsonRepresentation; end
483
495
 
@@ -3118,6 +3130,18 @@ module Google
3118
3130
  include Google::Apis::Core::JsonObjectSupport
3119
3131
  end
3120
3132
 
3133
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
3134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
3135
+
3136
+ include Google::Apis::Core::JsonObjectSupport
3137
+ end
3138
+
3139
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
3140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
3141
+
3142
+ include Google::Apis::Core::JsonObjectSupport
3143
+ end
3144
+
3121
3145
  class GoogleCloudDiscoveryengineV1betaCmekConfig
3122
3146
  class Representation < Google::Apis::Core::JsonRepresentation; end
3123
3147
 
@@ -3886,6 +3910,12 @@ module Google
3886
3910
  include Google::Apis::Core::JsonObjectSupport
3887
3911
  end
3888
3912
 
3913
+ class GoogleCloudDiscoveryengineV1betaUserLicense
3914
+ class Representation < Google::Apis::Core::JsonRepresentation; end
3915
+
3916
+ include Google::Apis::Core::JsonObjectSupport
3917
+ end
3918
+
3889
3919
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
3890
3920
  class Representation < Google::Apis::Core::JsonRepresentation; end
3891
3921
 
@@ -4702,12 +4732,20 @@ module Google
4702
4732
  end
4703
4733
  end
4704
4734
 
4735
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata
4736
+ # @private
4737
+ class Representation < Google::Apis::Core::JsonRepresentation
4738
+ property :create_time, as: 'createTime'
4739
+ property :failure_count, :numeric_string => true, as: 'failureCount'
4740
+ property :success_count, :numeric_string => true, as: 'successCount'
4741
+ property :update_time, as: 'updateTime'
4742
+ end
4743
+ end
4744
+
4705
4745
  class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest
4706
4746
  # @private
4707
4747
  class Representation < Google::Apis::Core::JsonRepresentation
4708
4748
  property :delete_unassigned_user_licenses, as: 'deleteUnassignedUserLicenses'
4709
- property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource::Representation
4710
-
4711
4749
  property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource::Representation
4712
4750
 
4713
4751
  end
@@ -4722,6 +4760,16 @@ module Google
4722
4760
  end
4723
4761
  end
4724
4762
 
4763
+ class GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse
4764
+ # @private
4765
+ class Representation < Google::Apis::Core::JsonRepresentation
4766
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
4767
+
4768
+ collection :user_licenses, as: 'userLicenses', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserLicense, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserLicense::Representation
4769
+
4770
+ end
4771
+ end
4772
+
4725
4773
  class GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest
4726
4774
  # @private
4727
4775
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6095,6 +6143,7 @@ module Google
6095
6143
  class GoogleCloudDiscoveryengineV1Principal
6096
6144
  # @private
6097
6145
  class Representation < Google::Apis::Core::JsonRepresentation
6146
+ property :external_entity_id, as: 'externalEntityId'
6098
6147
  property :group_id, as: 'groupId'
6099
6148
  property :user_id, as: 'userId'
6100
6149
  end
@@ -8709,6 +8758,7 @@ module Google
8709
8758
 
8710
8759
  property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec::Representation
8711
8760
 
8761
+ property :use_latest_data, as: 'useLatestData'
8712
8762
  property :user_info, as: 'userInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaUserInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaUserInfo::Representation
8713
8763
 
8714
8764
  hash :user_labels, as: 'userLabels'
@@ -9206,6 +9256,26 @@ module Google
9206
9256
  end
9207
9257
  end
9208
9258
 
9259
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata
9260
+ # @private
9261
+ class Representation < Google::Apis::Core::JsonRepresentation
9262
+ property :create_time, as: 'createTime'
9263
+ property :failure_count, :numeric_string => true, as: 'failureCount'
9264
+ property :success_count, :numeric_string => true, as: 'successCount'
9265
+ property :update_time, as: 'updateTime'
9266
+ end
9267
+ end
9268
+
9269
+ class GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse
9270
+ # @private
9271
+ class Representation < Google::Apis::Core::JsonRepresentation
9272
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
9273
+
9274
+ collection :user_licenses, as: 'userLicenses', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaUserLicense, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaUserLicense::Representation
9275
+
9276
+ end
9277
+ end
9278
+
9209
9279
  class GoogleCloudDiscoveryengineV1betaCmekConfig
9210
9280
  # @private
9211
9281
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -10487,6 +10557,19 @@ module Google
10487
10557
  end
10488
10558
  end
10489
10559
 
10560
+ class GoogleCloudDiscoveryengineV1betaUserLicense
10561
+ # @private
10562
+ class Representation < Google::Apis::Core::JsonRepresentation
10563
+ property :create_time, as: 'createTime'
10564
+ property :last_login_time, as: 'lastLoginTime'
10565
+ property :license_assignment_state, as: 'licenseAssignmentState'
10566
+ property :license_config, as: 'licenseConfig'
10567
+ property :update_time, as: 'updateTime'
10568
+ property :user_principal, as: 'userPrincipal'
10569
+ property :user_profile, as: 'userProfile'
10570
+ end
10571
+ end
10572
+
10490
10573
  class GoogleCloudDiscoveryengineV1betaWorkspaceConfig
10491
10574
  # @private
10492
10575
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -127,7 +127,7 @@ module Google
127
127
  # @param [String] name
128
128
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
129
129
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
130
- # `cmekConfig``.
130
+ # `cmek_config``.
131
131
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CmekConfig] google_cloud_discoveryengine_v1_cmek_config_object
132
132
  # @param [Boolean] set_default
133
133
  # Set the following CmekConfig as the default to be used for child resources if
@@ -265,7 +265,7 @@ module Google
265
265
  # @param [String] name
266
266
  # Required. The name of the CmekConfig of the form `projects/`project`/locations/
267
267
  # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
268
- # `cmekConfig``.
268
+ # `cmek_config``.
269
269
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CmekConfig] google_cloud_discoveryengine_v1_cmek_config_object
270
270
  # @param [Boolean] set_default
271
271
  # 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_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.39.0
4
+ version: 0.41.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_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.39.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.41.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
62
62
  rdoc_options: []
63
63
  require_paths: