google-apis-discoveryengine_v1alpha 0.43.0 → 0.44.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7ed9018925cf399fca4382e9d7ee045f54c0a7b8ca55be17090502e7123bcd3c
4
- data.tar.gz: ab507df4842300e7a3340f9fbb574e5cb69277cda11380114e57725ec1b82fc3
3
+ metadata.gz: d6e0686297a1bf8ad5e52d595974f8422a38871d2f61058321e9bad65e9eed0e
4
+ data.tar.gz: b454097807515ea4576de4ebc2c57e7764879318b66664d42ea6799eeb4d3372
5
5
  SHA512:
6
- metadata.gz: ab81429d9d896ce8508ffc1f6df4c7c6d138ddac7bab27a2abe97bb779e6d819bcbe9cc398da4bdd6a2eba48b0a052277109ab9a97f7eed0159892568c14a2a2
7
- data.tar.gz: 632c182562a10c23507cd6b3a4f5b0cd04c09cc6fbaaf655a269d5989958a9f9f8f143e93578bc8ce2eb5aea5683c33627690fbd1b03636df76d390c6c8bdcdc
6
+ metadata.gz: c204e5e58da44df6d599810192cfd4cfe0ac997a7ae803f833d89080ee1511656fcf729f7ad81105042cb503eaf2362e036764a73cf8a64137a841d916fa2458
7
+ data.tar.gz: 4e5c001dfa0833d1b00ae20c87bb25375b14e7a165ff92005602d028be0c10622049b1dacdd261cd40367348f516c9a4904c40318c7d0f927da14fe2c9076129
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-discoveryengine_v1alpha
2
2
 
3
+ ### v0.44.0 (2024-04-21)
4
+
5
+ * Regenerated from discovery document revision 20240415
6
+
3
7
  ### v0.43.0 (2024-04-07)
4
8
 
5
9
  * Regenerated from discovery document revision 20240401
@@ -741,8 +741,8 @@ module Google
741
741
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
742
742
  include Google::Apis::Core::Hashable
743
743
 
744
- # Apply additional enhanced OCR processing to a list of document elements.
745
- # Supported values: * `table`: advanced table parsing model.
744
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
745
+ # elements processing, please switch to `layout_parsing_config`.
746
746
  # Corresponds to the JSON property `enhancedDocumentElements`
747
747
  # @return [Array<String>]
748
748
  attr_accessor :enhanced_document_elements
@@ -917,8 +917,8 @@ module Google
917
917
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
918
918
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
919
919
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
920
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
921
- # agent association after Engine is created.
920
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
921
+ # association after Engine is created.
922
922
  # Corresponds to the JSON property `dialogflowAgentToLink`
923
923
  # @return [String]
924
924
  attr_accessor :dialogflow_agent_to_link
@@ -1031,7 +1031,7 @@ module Google
1031
1031
  attr_accessor :search_add_ons
1032
1032
 
1033
1033
  # The search feature tier of this engine. Different tiers might have different
1034
- # pricing. To learn more, please check the pricing documentation. Defaults to
1034
+ # pricing. To learn more, check the pricing documentation. Defaults to
1035
1035
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
1036
1036
  # Corresponds to the JSON property `searchTier`
1037
1037
  # @return [String]
@@ -1711,8 +1711,8 @@ module Google
1711
1711
  # @return [String]
1712
1712
  attr_accessor :create_time
1713
1713
 
1714
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
1715
- # collection`/engines/`engine`/sessions/*/answers/*`
1714
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
1715
+ # collections/`collection`/engines/`engine`/sessions/*/answers/*`
1716
1716
  # Corresponds to the JSON property `name`
1717
1717
  # @return [String]
1718
1718
  attr_accessor :name
@@ -2051,7 +2051,7 @@ module Google
2051
2051
  attr_accessor :disable
2052
2052
  alias_method :disable?, :disable
2053
2053
 
2054
- # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it
2054
+ # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it
2055
2055
  # will be set to 1 by default.
2056
2056
  # Corresponds to the JSON property `maxRephraseSteps`
2057
2057
  # @return [Fixnum]
@@ -2142,6 +2142,11 @@ module Google
2142
2142
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec]
2143
2143
  attr_accessor :boost_spec
2144
2144
 
2145
+ # Defines custom fine tuning spec.
2146
+ # Corresponds to the JSON property `customFineTuningSpec`
2147
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
2148
+ attr_accessor :custom_fine_tuning_spec
2149
+
2145
2150
  # The filter syntax consists of an expression language for constructing a
2146
2151
  # predicate from one or more fields of the documents being filtered. Filter
2147
2152
  # expression is case-sensitive. This will be used to filter search results which
@@ -2188,6 +2193,7 @@ module Google
2188
2193
  # Update properties of this object
2189
2194
  def update!(**args)
2190
2195
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
2196
+ @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
2191
2197
  @filter = args[:filter] if args.key?(:filter)
2192
2198
  @max_return_results = args[:max_return_results] if args.key?(:max_return_results)
2193
2199
  @order_by = args[:order_by] if args.key?(:order_by)
@@ -2399,6 +2405,11 @@ module Google
2399
2405
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
2400
2406
  attr_accessor :answer
2401
2407
 
2408
+ # A global unique ID used for logging.
2409
+ # Corresponds to the JSON property `answerQueryToken`
2410
+ # @return [String]
2411
+ attr_accessor :answer_query_token
2412
+
2402
2413
  # External session proto definition.
2403
2414
  # Corresponds to the JSON property `session`
2404
2415
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
@@ -2411,6 +2422,7 @@ module Google
2411
2422
  # Update properties of this object
2412
2423
  def update!(**args)
2413
2424
  @answer = args[:answer] if args.key?(:answer)
2425
+ @answer_query_token = args[:answer_query_token] if args.key?(:answer_query_token)
2414
2426
  @session = args[:session] if args.key?(:session)
2415
2427
  end
2416
2428
  end
@@ -3220,7 +3232,7 @@ module Google
3220
3232
  attr_accessor :end_pos
3221
3233
 
3222
3234
  # Position indicating the start of the claim in the answer candidate, measured
3223
- # in bytes/unicode.
3235
+ # in bytes.
3224
3236
  # Corresponds to the JSON property `startPos`
3225
3237
  # @return [Fixnum]
3226
3238
  attr_accessor :start_pos
@@ -3358,6 +3370,12 @@ module Google
3358
3370
  class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
3359
3371
  include Google::Apis::Core::Hashable
3360
3372
 
3373
+ # Data representation. The structured JSON data for the document. It should
3374
+ # conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
3375
+ # Corresponds to the JSON property `structData`
3376
+ # @return [Hash<String,Object>]
3377
+ attr_accessor :struct_data
3378
+
3361
3379
  # Title of the document.
3362
3380
  # Corresponds to the JSON property `title`
3363
3381
  # @return [String]
@@ -3374,6 +3392,7 @@ module Google
3374
3392
 
3375
3393
  # Update properties of this object
3376
3394
  def update!(**args)
3395
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
3377
3396
  @title = args[:title] if args.key?(:title)
3378
3397
  @uri = args[:uri] if args.key?(:uri)
3379
3398
  end
@@ -3416,7 +3435,7 @@ module Google
3416
3435
 
3417
3436
  # Intermediate Cloud Storage directory used for the import with a length limit
3418
3437
  # of 2,000 characters. Can be specified if one wants to have the Cloud SQL
3419
- # export to a specific Cloud Storage directory. Please ensure that the Cloud SQL
3438
+ # export to a specific Cloud Storage directory. Ensure that the Cloud SQL
3420
3439
  # service account has the necessary Cloud Storage Admin permissions to access
3421
3440
  # the specified Cloud Storage directory.
3422
3441
  # Corresponds to the JSON property `gcsStagingDir`
@@ -3625,9 +3644,9 @@ module Google
3625
3644
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversationMessage>]
3626
3645
  attr_accessor :messages
3627
3646
 
3628
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
3629
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
3630
- # collections/`collection`/engines/*/conversations/*`.
3647
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
3648
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
3649
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
3631
3650
  # Corresponds to the JSON property `name`
3632
3651
  # @return [String]
3633
3652
  attr_accessor :name
@@ -4680,8 +4699,8 @@ module Google
4680
4699
  class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig
4681
4700
  include Google::Apis::Core::Hashable
4682
4701
 
4683
- # Apply additional enhanced OCR processing to a list of document elements.
4684
- # Supported values: * `table`: advanced table parsing model.
4702
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
4703
+ # elements processing, please switch to `layout_parsing_config`.
4685
4704
  # Corresponds to the JSON property `enhancedDocumentElements`
4686
4705
  # @return [Array<String>]
4687
4706
  attr_accessor :enhanced_document_elements
@@ -4925,8 +4944,8 @@ module Google
4925
4944
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
4926
4945
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
4927
4946
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
4928
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
4929
- # agent association after Engine is created.
4947
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
4948
+ # association after Engine is created.
4930
4949
  # Corresponds to the JSON property `dialogflowAgentToLink`
4931
4950
  # @return [String]
4932
4951
  attr_accessor :dialogflow_agent_to_link
@@ -5161,7 +5180,7 @@ module Google
5161
5180
  attr_accessor :search_add_ons
5162
5181
 
5163
5182
  # The search feature tier of this engine. Different tiers might have different
5164
- # pricing. To learn more, please check the pricing documentation. Defaults to
5183
+ # pricing. To learn more, check the pricing documentation. Defaults to
5165
5184
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
5166
5185
  # Corresponds to the JSON property `searchTier`
5167
5186
  # @return [String]
@@ -5446,6 +5465,15 @@ module Google
5446
5465
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
5447
5466
  include Google::Apis::Core::Hashable
5448
5467
 
5468
+ # If this field is set, only the corresponding source will be indexed for this
5469
+ # field. Otherwise, the values from different sources are merged. Assuming a
5470
+ # page with `` in meta tag, and `` in page map: if this enum is set to METATAGS,
5471
+ # we will only index ``; if this enum is not set, we will merge them and index ``
5472
+ # .
5473
+ # Corresponds to the JSON property `advancedSiteSearchDataSources`
5474
+ # @return [Array<String>]
5475
+ attr_accessor :advanced_site_search_data_sources
5476
+
5449
5477
  # If completable_option is COMPLETABLE_ENABLED, field values are directly used
5450
5478
  # and returned as suggestions for Autocomplete in CompletionService.
5451
5479
  # CompleteQuery. If completable_option is unset, the server behavior defaults to
@@ -5546,6 +5574,7 @@ module Google
5546
5574
 
5547
5575
  # Update properties of this object
5548
5576
  def update!(**args)
5577
+ @advanced_site_search_data_sources = args[:advanced_site_search_data_sources] if args.key?(:advanced_site_search_data_sources)
5549
5578
  @completable_option = args[:completable_option] if args.key?(:completable_option)
5550
5579
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
5551
5580
  @field_path = args[:field_path] if args.key?(:field_path)
@@ -5576,7 +5605,7 @@ module Google
5576
5605
 
5577
5606
  # Intermediate Cloud Storage directory used for the import with a length limit
5578
5607
  # of 2,000 characters. Can be specified if one wants to have the Firestore
5579
- # export to a specific Cloud Storage directory. Please ensure that the Firestore
5608
+ # export to a specific Cloud Storage directory. Ensure that the Firestore
5580
5609
  # service account has the necessary Cloud Storage Admin permissions to access
5581
5610
  # the specified Cloud Storage directory.
5582
5611
  # Corresponds to the JSON property `gcsStagingDir`
@@ -5748,66 +5777,6 @@ module Google
5748
5777
  end
5749
5778
  end
5750
5779
 
5751
- # Metadata related to the progress of the ImportCompletionSuggestions operation.
5752
- # This will be returned by the google.longrunning.Operation.metadata field.
5753
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata
5754
- include Google::Apis::Core::Hashable
5755
-
5756
- # Operation create time.
5757
- # Corresponds to the JSON property `createTime`
5758
- # @return [String]
5759
- attr_accessor :create_time
5760
-
5761
- # Operation last update time. If the operation is done, this is also the finish
5762
- # time.
5763
- # Corresponds to the JSON property `updateTime`
5764
- # @return [String]
5765
- attr_accessor :update_time
5766
-
5767
- def initialize(**args)
5768
- update!(**args)
5769
- end
5770
-
5771
- # Update properties of this object
5772
- def update!(**args)
5773
- @create_time = args[:create_time] if args.key?(:create_time)
5774
- @update_time = args[:update_time] if args.key?(:update_time)
5775
- end
5776
- end
5777
-
5778
- # Response of the CompletionService.ImportCompletionSuggestions method. If the
5779
- # long running operation is done, this message is returned by the google.
5780
- # longrunning.Operations.response field if the operation is successful.
5781
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse
5782
- include Google::Apis::Core::Hashable
5783
-
5784
- # A sample of errors encountered while processing the request.
5785
- # Corresponds to the JSON property `errorSamples`
5786
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
5787
- attr_accessor :error_samples
5788
-
5789
- # Count of CompletionSuggestions that failed to be imported.
5790
- # Corresponds to the JSON property `failureCount`
5791
- # @return [Fixnum]
5792
- attr_accessor :failure_count
5793
-
5794
- # Count of CompletionSuggestions successfully imported.
5795
- # Corresponds to the JSON property `successCount`
5796
- # @return [Fixnum]
5797
- attr_accessor :success_count
5798
-
5799
- def initialize(**args)
5800
- update!(**args)
5801
- end
5802
-
5803
- # Update properties of this object
5804
- def update!(**args)
5805
- @error_samples = args[:error_samples] if args.key?(:error_samples)
5806
- @failure_count = args[:failure_count] if args.key?(:failure_count)
5807
- @success_count = args[:success_count] if args.key?(:success_count)
5808
- end
5809
- end
5810
-
5811
5780
  # Metadata related to the progress of the ImportDocuments operation. This is
5812
5781
  # returned by the google.longrunning.Operation.metadata field.
5813
5782
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -6623,12 +6592,12 @@ module Google
6623
6592
 
6624
6593
  # The most specific category associated with a category page. To represent full
6625
6594
  # path of category, use '>' sign to separate different hierarchies. If '>' is
6626
- # part of the category name, please replace it with other character(s). Category
6627
- # pages include special pages such as sales or promotions. For instance, a
6628
- # special sale page may have the category hierarchy: `"pageCategory" : "Sales >
6629
- # 2017 Black Friday Deals"`. Required for `view-category-page` events. Other
6630
- # event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
6631
- # is returned.
6595
+ # part of the category name, replace it with other character(s). Category pages
6596
+ # include special pages such as sales or promotions. For instance, a special
6597
+ # sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017
6598
+ # Black Friday Deals"`. Required for `view-category-page` events. Other event
6599
+ # types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is
6600
+ # returned.
6632
6601
  # Corresponds to the JSON property `pageCategory`
6633
6602
  # @return [String]
6634
6603
  attr_accessor :page_category
@@ -6782,6 +6751,138 @@ module Google
6782
6751
  end
6783
6752
  end
6784
6753
 
6754
+ # Metadata and configurations for a Google Cloud project in the service.
6755
+ class GoogleCloudDiscoveryengineV1alphaProject
6756
+ include Google::Apis::Core::Hashable
6757
+
6758
+ # Output only. The timestamp when this project is created.
6759
+ # Corresponds to the JSON property `createTime`
6760
+ # @return [String]
6761
+ attr_accessor :create_time
6762
+
6763
+ # Output only. Full resource name of the project, for example `projects/`
6764
+ # project_number``. Note that when making requests, project number and project
6765
+ # id are both acceptable, but the server will always respond in project number.
6766
+ # Corresponds to the JSON property `name`
6767
+ # @return [String]
6768
+ attr_accessor :name
6769
+
6770
+ # Output only. The timestamp when this project is successfully provisioned.
6771
+ # Empty value means this project is still provisioning and is not ready for use.
6772
+ # Corresponds to the JSON property `provisionCompletionTime`
6773
+ # @return [String]
6774
+ attr_accessor :provision_completion_time
6775
+
6776
+ # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
6777
+ # Corresponds to the JSON property `serviceTermsMap`
6778
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProjectServiceTerms>]
6779
+ attr_accessor :service_terms_map
6780
+
6781
+ def initialize(**args)
6782
+ update!(**args)
6783
+ end
6784
+
6785
+ # Update properties of this object
6786
+ def update!(**args)
6787
+ @create_time = args[:create_time] if args.key?(:create_time)
6788
+ @name = args[:name] if args.key?(:name)
6789
+ @provision_completion_time = args[:provision_completion_time] if args.key?(:provision_completion_time)
6790
+ @service_terms_map = args[:service_terms_map] if args.key?(:service_terms_map)
6791
+ end
6792
+ end
6793
+
6794
+ # Metadata about the terms of service.
6795
+ class GoogleCloudDiscoveryengineV1alphaProjectServiceTerms
6796
+ include Google::Apis::Core::Hashable
6797
+
6798
+ # The last time when the project agreed to the terms of service.
6799
+ # Corresponds to the JSON property `acceptTime`
6800
+ # @return [String]
6801
+ attr_accessor :accept_time
6802
+
6803
+ # The last time when the project declined or revoked the agreement to terms of
6804
+ # service.
6805
+ # Corresponds to the JSON property `declineTime`
6806
+ # @return [String]
6807
+ attr_accessor :decline_time
6808
+
6809
+ # The unique identifier of this terms of service. Available terms: * `
6810
+ # GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-
6811
+ # use-terms). When using this as `id`, the acceptable version to provide is `
6812
+ # 2022-11-23`.
6813
+ # Corresponds to the JSON property `id`
6814
+ # @return [String]
6815
+ attr_accessor :id
6816
+
6817
+ # Whether the project has accepted/rejected the service terms or it is still
6818
+ # pending.
6819
+ # Corresponds to the JSON property `state`
6820
+ # @return [String]
6821
+ attr_accessor :state
6822
+
6823
+ # The version string of the terms of service. For acceptable values, see the
6824
+ # comments for id above.
6825
+ # Corresponds to the JSON property `version`
6826
+ # @return [String]
6827
+ attr_accessor :version
6828
+
6829
+ def initialize(**args)
6830
+ update!(**args)
6831
+ end
6832
+
6833
+ # Update properties of this object
6834
+ def update!(**args)
6835
+ @accept_time = args[:accept_time] if args.key?(:accept_time)
6836
+ @decline_time = args[:decline_time] if args.key?(:decline_time)
6837
+ @id = args[:id] if args.key?(:id)
6838
+ @state = args[:state] if args.key?(:state)
6839
+ @version = args[:version] if args.key?(:version)
6840
+ end
6841
+ end
6842
+
6843
+ # Metadata associated with a project provision operation.
6844
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata
6845
+ include Google::Apis::Core::Hashable
6846
+
6847
+ def initialize(**args)
6848
+ update!(**args)
6849
+ end
6850
+
6851
+ # Update properties of this object
6852
+ def update!(**args)
6853
+ end
6854
+ end
6855
+
6856
+ # Request for ProjectService.ProvisionProject method.
6857
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest
6858
+ include Google::Apis::Core::Hashable
6859
+
6860
+ # Required. Set to `true` to specify that caller has read and would like to give
6861
+ # consent to the [Terms for data use](https://cloud.google.com/retail/data-use-
6862
+ # terms).
6863
+ # Corresponds to the JSON property `acceptDataUseTerms`
6864
+ # @return [Boolean]
6865
+ attr_accessor :accept_data_use_terms
6866
+ alias_method :accept_data_use_terms?, :accept_data_use_terms
6867
+
6868
+ # Required. The version of the [Terms for data use](https://cloud.google.com/
6869
+ # retail/data-use-terms) that caller has read and would like to give consent to.
6870
+ # Acceptable version is `2022-11-23`, and this may change over time.
6871
+ # Corresponds to the JSON property `dataUseTermsVersion`
6872
+ # @return [String]
6873
+ attr_accessor :data_use_terms_version
6874
+
6875
+ def initialize(**args)
6876
+ update!(**args)
6877
+ end
6878
+
6879
+ # Update properties of this object
6880
+ def update!(**args)
6881
+ @accept_data_use_terms = args[:accept_data_use_terms] if args.key?(:accept_data_use_terms)
6882
+ @data_use_terms_version = args[:data_use_terms_version] if args.key?(:data_use_terms_version)
6883
+ end
6884
+ end
6885
+
6785
6886
  # Metadata related to the progress of the PurgeDocuments operation. This will be
6786
6887
  # returned by the google.longrunning.Operation.metadata field.
6787
6888
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
@@ -7130,7 +7231,7 @@ module Google
7130
7231
  # @return [String]
7131
7232
  attr_accessor :query
7132
7233
 
7133
- # Required. A list of records to rank. At most 100 records to rank.
7234
+ # Required. A list of records to rank. At most 200 records to rank.
7134
7235
  # Corresponds to the JSON property `records`
7135
7236
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankingRecord>]
7136
7237
  attr_accessor :records
@@ -7610,6 +7711,41 @@ module Google
7610
7711
  end
7611
7712
  end
7612
7713
 
7714
+ # Request for ReportConsentChange method.
7715
+ class GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest
7716
+ include Google::Apis::Core::Hashable
7717
+
7718
+ # Required. Whether customer decides to accept or decline service term. At this
7719
+ # moment, only accept action is supported.
7720
+ # Corresponds to the JSON property `consentChangeAction`
7721
+ # @return [String]
7722
+ attr_accessor :consent_change_action
7723
+
7724
+ # Required. The unique identifier of the terms of service to update. Available
7725
+ # term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/
7726
+ # retail/data-use-terms). When using this service term id, the acceptable
7727
+ # service_term_version to provide is `2022-11-23`.
7728
+ # Corresponds to the JSON property `serviceTermId`
7729
+ # @return [String]
7730
+ attr_accessor :service_term_id
7731
+
7732
+ # Required. The version string of the terms of service to update.
7733
+ # Corresponds to the JSON property `serviceTermVersion`
7734
+ # @return [String]
7735
+ attr_accessor :service_term_version
7736
+
7737
+ def initialize(**args)
7738
+ update!(**args)
7739
+ end
7740
+
7741
+ # Update properties of this object
7742
+ def update!(**args)
7743
+ @consent_change_action = args[:consent_change_action] if args.key?(:consent_change_action)
7744
+ @service_term_id = args[:service_term_id] if args.key?(:service_term_id)
7745
+ @service_term_version = args[:service_term_version] if args.key?(:service_term_version)
7746
+ end
7747
+ end
7748
+
7613
7749
  # Request for resuming training of an engine.
7614
7750
  class GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
7615
7751
  include Google::Apis::Core::Hashable
@@ -8208,8 +8344,8 @@ module Google
8208
8344
 
8209
8345
  # Specifies whether to return the confidence score from the extractive segments
8210
8346
  # in each search result. This feature is available only for new or allowlisted
8211
- # data stores. To allowlist your data store, please contact your Customer
8212
- # Engineer. The default value is `false`.
8347
+ # data stores. To allowlist your data store, contact your Customer Engineer. The
8348
+ # default value is `false`.
8213
8349
  # Corresponds to the JSON property `returnExtractiveSegmentScore`
8214
8350
  # @return [Boolean]
8215
8351
  attr_accessor :return_extractive_segment_score
@@ -8328,13 +8464,15 @@ module Google
8328
8464
 
8329
8465
  # The number of top results to generate the summary from. If the number of
8330
8466
  # results returned is less than `summaryResultCount`, the summary is generated
8331
- # from all of the results. At most 10 results can be used to generate a summary.
8467
+ # from all of the results. At most 10 results for documents mode, or 50 for
8468
+ # chunks mode, can be used to generate a summary. The chunks mode is used when
8469
+ # SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
8332
8470
  # Corresponds to the JSON property `summaryResultCount`
8333
8471
  # @return [Fixnum]
8334
8472
  attr_accessor :summary_result_count
8335
8473
 
8336
8474
  # If true, answer will be generated from most relevant chunks from top search
8337
- # results. This feature will improve summary quality. Please note that with this
8475
+ # results. This feature will improve summary quality. Note that with this
8338
8476
  # feature enabled, not all top search results will be referenced and included in
8339
8477
  # the reference list, so the citation source index only points to the search
8340
8478
  # results listed in the reference list.
@@ -9497,8 +9635,8 @@ module Google
9497
9635
  # @return [String]
9498
9636
  attr_accessor :end_time
9499
9637
 
9500
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
9501
- # collection`/engines/`engine`/sessions/*`
9638
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
9639
+ # collections/`collection`/engines/`engine`/sessions/*`
9502
9640
  # Corresponds to the JSON property `name`
9503
9641
  # @return [String]
9504
9642
  attr_accessor :name
@@ -11432,8 +11570,8 @@ module Google
11432
11570
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
11433
11571
  include Google::Apis::Core::Hashable
11434
11572
 
11435
- # Apply additional enhanced OCR processing to a list of document elements.
11436
- # Supported values: * `table`: advanced table parsing model.
11573
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
11574
+ # elements processing, please switch to `layout_parsing_config`.
11437
11575
  # Corresponds to the JSON property `enhancedDocumentElements`
11438
11576
  # @return [Array<String>]
11439
11577
  attr_accessor :enhanced_document_elements
@@ -11608,8 +11746,8 @@ module Google
11608
11746
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
11609
11747
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
11610
11748
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
11611
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
11612
- # agent association after Engine is created.
11749
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
11750
+ # association after Engine is created.
11613
11751
  # Corresponds to the JSON property `dialogflowAgentToLink`
11614
11752
  # @return [String]
11615
11753
  attr_accessor :dialogflow_agent_to_link
@@ -11722,7 +11860,7 @@ module Google
11722
11860
  attr_accessor :search_add_ons
11723
11861
 
11724
11862
  # The search feature tier of this engine. Different tiers might have different
11725
- # pricing. To learn more, please check the pricing documentation. Defaults to
11863
+ # pricing. To learn more, check the pricing documentation. Defaults to
11726
11864
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
11727
11865
  # Corresponds to the JSON property `searchTier`
11728
11866
  # @return [String]
@@ -12362,6 +12500,19 @@ module Google
12362
12500
  end
12363
12501
  end
12364
12502
 
12503
+ # Response associated with a tune operation.
12504
+ class GoogleCloudDiscoveryengineV1betaTuneEngineResponse
12505
+ include Google::Apis::Core::Hashable
12506
+
12507
+ def initialize(**args)
12508
+ update!(**args)
12509
+ end
12510
+
12511
+ # Update properties of this object
12512
+ def update!(**args)
12513
+ end
12514
+ end
12515
+
12365
12516
  # Metadata for UpdateSchema LRO.
12366
12517
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
12367
12518
  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.43.0"
19
+ GEM_VERSION = "0.44.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.14.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240401"
25
+ REVISION = "20240415"
26
26
  end
27
27
  end
28
28
  end
@@ -1060,18 +1060,6 @@ module Google
1060
1060
  include Google::Apis::Core::JsonObjectSupport
1061
1061
  end
1062
1062
 
1063
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata
1064
- class Representation < Google::Apis::Core::JsonRepresentation; end
1065
-
1066
- include Google::Apis::Core::JsonObjectSupport
1067
- end
1068
-
1069
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse
1070
- class Representation < Google::Apis::Core::JsonRepresentation; end
1071
-
1072
- include Google::Apis::Core::JsonObjectSupport
1073
- end
1074
-
1075
1063
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
1076
1064
  class Representation < Google::Apis::Core::JsonRepresentation; end
1077
1065
 
@@ -1258,6 +1246,30 @@ module Google
1258
1246
  include Google::Apis::Core::JsonObjectSupport
1259
1247
  end
1260
1248
 
1249
+ class GoogleCloudDiscoveryengineV1alphaProject
1250
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1251
+
1252
+ include Google::Apis::Core::JsonObjectSupport
1253
+ end
1254
+
1255
+ class GoogleCloudDiscoveryengineV1alphaProjectServiceTerms
1256
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1257
+
1258
+ include Google::Apis::Core::JsonObjectSupport
1259
+ end
1260
+
1261
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata
1262
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1263
+
1264
+ include Google::Apis::Core::JsonObjectSupport
1265
+ end
1266
+
1267
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest
1268
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1269
+
1270
+ include Google::Apis::Core::JsonObjectSupport
1271
+ end
1272
+
1261
1273
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
1262
1274
  class Representation < Google::Apis::Core::JsonRepresentation; end
1263
1275
 
@@ -1402,6 +1414,12 @@ module Google
1402
1414
  include Google::Apis::Core::JsonObjectSupport
1403
1415
  end
1404
1416
 
1417
+ class GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest
1418
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1419
+
1420
+ include Google::Apis::Core::JsonObjectSupport
1421
+ end
1422
+
1405
1423
  class GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
1406
1424
  class Representation < Google::Apis::Core::JsonRepresentation; end
1407
1425
 
@@ -2128,6 +2146,12 @@ module Google
2128
2146
  include Google::Apis::Core::JsonObjectSupport
2129
2147
  end
2130
2148
 
2149
+ class GoogleCloudDiscoveryengineV1betaTuneEngineResponse
2150
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2151
+
2152
+ include Google::Apis::Core::JsonObjectSupport
2153
+ end
2154
+
2131
2155
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
2132
2156
  class Representation < Google::Apis::Core::JsonRepresentation; end
2133
2157
 
@@ -2786,6 +2810,8 @@ module Google
2786
2810
  class Representation < Google::Apis::Core::JsonRepresentation
2787
2811
  property :boost_spec, as: 'boostSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec::Representation
2788
2812
 
2813
+ property :custom_fine_tuning_spec, as: 'customFineTuningSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec::Representation
2814
+
2789
2815
  property :filter, as: 'filter'
2790
2816
  property :max_return_results, as: 'maxReturnResults'
2791
2817
  property :order_by, as: 'orderBy'
@@ -2863,6 +2889,7 @@ module Google
2863
2889
  class Representation < Google::Apis::Core::JsonRepresentation
2864
2890
  property :answer, as: 'answer', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
2865
2891
 
2892
+ property :answer_query_token, as: 'answerQueryToken'
2866
2893
  property :session, as: 'session', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2867
2894
 
2868
2895
  end
@@ -3152,6 +3179,7 @@ module Google
3152
3179
  class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
3153
3180
  # @private
3154
3181
  class Representation < Google::Apis::Core::JsonRepresentation
3182
+ hash :struct_data, as: 'structData'
3155
3183
  property :title, as: 'title'
3156
3184
  property :uri, as: 'uri'
3157
3185
  end
@@ -3739,6 +3767,7 @@ module Google
3739
3767
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
3740
3768
  # @private
3741
3769
  class Representation < Google::Apis::Core::JsonRepresentation
3770
+ collection :advanced_site_search_data_sources, as: 'advancedSiteSearchDataSources'
3742
3771
  property :completable_option, as: 'completableOption'
3743
3772
  property :dynamic_facetable_option, as: 'dynamicFacetableOption'
3744
3773
  property :field_path, as: 'fieldPath'
@@ -3802,24 +3831,6 @@ module Google
3802
3831
  end
3803
3832
  end
3804
3833
 
3805
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata
3806
- # @private
3807
- class Representation < Google::Apis::Core::JsonRepresentation
3808
- property :create_time, as: 'createTime'
3809
- property :update_time, as: 'updateTime'
3810
- end
3811
- end
3812
-
3813
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse
3814
- # @private
3815
- class Representation < Google::Apis::Core::JsonRepresentation
3816
- collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus::Representation
3817
-
3818
- property :failure_count, :numeric_string => true, as: 'failureCount'
3819
- property :success_count, :numeric_string => true, as: 'successCount'
3820
- end
3821
- end
3822
-
3823
3834
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
3824
3835
  # @private
3825
3836
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4121,6 +4132,42 @@ module Google
4121
4132
  end
4122
4133
  end
4123
4134
 
4135
+ class GoogleCloudDiscoveryengineV1alphaProject
4136
+ # @private
4137
+ class Representation < Google::Apis::Core::JsonRepresentation
4138
+ property :create_time, as: 'createTime'
4139
+ property :name, as: 'name'
4140
+ property :provision_completion_time, as: 'provisionCompletionTime'
4141
+ hash :service_terms_map, as: 'serviceTermsMap', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProjectServiceTerms, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProjectServiceTerms::Representation
4142
+
4143
+ end
4144
+ end
4145
+
4146
+ class GoogleCloudDiscoveryengineV1alphaProjectServiceTerms
4147
+ # @private
4148
+ class Representation < Google::Apis::Core::JsonRepresentation
4149
+ property :accept_time, as: 'acceptTime'
4150
+ property :decline_time, as: 'declineTime'
4151
+ property :id, as: 'id'
4152
+ property :state, as: 'state'
4153
+ property :version, as: 'version'
4154
+ end
4155
+ end
4156
+
4157
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata
4158
+ # @private
4159
+ class Representation < Google::Apis::Core::JsonRepresentation
4160
+ end
4161
+ end
4162
+
4163
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest
4164
+ # @private
4165
+ class Representation < Google::Apis::Core::JsonRepresentation
4166
+ property :accept_data_use_terms, as: 'acceptDataUseTerms'
4167
+ property :data_use_terms_version, as: 'dataUseTermsVersion'
4168
+ end
4169
+ end
4170
+
4124
4171
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
4125
4172
  # @private
4126
4173
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4346,6 +4393,15 @@ module Google
4346
4393
  end
4347
4394
  end
4348
4395
 
4396
+ class GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest
4397
+ # @private
4398
+ class Representation < Google::Apis::Core::JsonRepresentation
4399
+ property :consent_change_action, as: 'consentChangeAction'
4400
+ property :service_term_id, as: 'serviceTermId'
4401
+ property :service_term_version, as: 'serviceTermVersion'
4402
+ end
4403
+ end
4404
+
4349
4405
  class GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
4350
4406
  # @private
4351
4407
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5591,6 +5647,12 @@ module Google
5591
5647
  end
5592
5648
  end
5593
5649
 
5650
+ class GoogleCloudDiscoveryengineV1betaTuneEngineResponse
5651
+ # @private
5652
+ class Representation < Google::Apis::Core::JsonRepresentation
5653
+ end
5654
+ end
5655
+
5594
5656
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
5595
5657
  # @private
5596
5658
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -192,6 +192,110 @@ module Google
192
192
  execute_or_queue_command(command, &block)
193
193
  end
194
194
 
195
+ # Gets a Project. Returns NOT_FOUND when the project is not yet created.
196
+ # @param [String] name
197
+ # Required. Full resource name of a Project, such as `projects/`
198
+ # project_id_or_number``.
199
+ # @param [String] fields
200
+ # Selector specifying which fields to include in a partial response.
201
+ # @param [String] quota_user
202
+ # Available to use for quota purposes for server-side applications. Can be any
203
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
204
+ # @param [Google::Apis::RequestOptions] options
205
+ # Request-specific options
206
+ #
207
+ # @yield [result, err] Result & error if block supplied
208
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject] parsed result object
209
+ # @yieldparam err [StandardError] error object if request failed
210
+ #
211
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject]
212
+ #
213
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
214
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
215
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
216
+ def get_project(name, fields: nil, quota_user: nil, options: nil, &block)
217
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
218
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject::Representation
219
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject
220
+ command.params['name'] = name unless name.nil?
221
+ command.query['fields'] = fields unless fields.nil?
222
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
223
+ execute_or_queue_command(command, &block)
224
+ end
225
+
226
+ # Provisions the project resource. During the process, related systems will get
227
+ # prepared and initialized. Caller must read the [Terms for data use](https://
228
+ # cloud.google.com/retail/data-use-terms), and optionally specify in request to
229
+ # provide consent to that service terms.
230
+ # @param [String] name
231
+ # Required. Full resource name of a Project, such as `projects/`
232
+ # project_id_or_number``.
233
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest] google_cloud_discoveryengine_v1alpha_provision_project_request_object
234
+ # @param [String] fields
235
+ # Selector specifying which fields to include in a partial response.
236
+ # @param [String] quota_user
237
+ # Available to use for quota purposes for server-side applications. Can be any
238
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
239
+ # @param [Google::Apis::RequestOptions] options
240
+ # Request-specific options
241
+ #
242
+ # @yield [result, err] Result & error if block supplied
243
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
244
+ # @yieldparam err [StandardError] error object if request failed
245
+ #
246
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
247
+ #
248
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
249
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
250
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
251
+ def provision_project(name, google_cloud_discoveryengine_v1alpha_provision_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
252
+ command = make_simple_command(:post, 'v1alpha/{+name}:provision', options)
253
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest::Representation
254
+ command.request_object = google_cloud_discoveryengine_v1alpha_provision_project_request_object
255
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
256
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
257
+ command.params['name'] = name unless name.nil?
258
+ command.query['fields'] = fields unless fields.nil?
259
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
260
+ execute_or_queue_command(command, &block)
261
+ end
262
+
263
+ # Updates service terms for this project. This method can be used to
264
+ # retroactively accept the latest terms. Terms available for update: * [Terms
265
+ # for data use](https://cloud.google.com/retail/data-use-terms)
266
+ # @param [String] project
267
+ # Required. Full resource name of a Project, such as `projects/`
268
+ # project_id_or_number``.
269
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest] google_cloud_discoveryengine_v1alpha_report_consent_change_request_object
270
+ # @param [String] fields
271
+ # Selector specifying which fields to include in a partial response.
272
+ # @param [String] quota_user
273
+ # Available to use for quota purposes for server-side applications. Can be any
274
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
275
+ # @param [Google::Apis::RequestOptions] options
276
+ # Request-specific options
277
+ #
278
+ # @yield [result, err] Result & error if block supplied
279
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject] parsed result object
280
+ # @yieldparam err [StandardError] error object if request failed
281
+ #
282
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject]
283
+ #
284
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
285
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
286
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
287
+ def report_project_consent_change(project, google_cloud_discoveryengine_v1alpha_report_consent_change_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
288
+ command = make_simple_command(:post, 'v1alpha/{+project}:reportConsentChange', options)
289
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest::Representation
290
+ command.request_object = google_cloud_discoveryengine_v1alpha_report_consent_change_request_object
291
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject::Representation
292
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject
293
+ command.params['project'] = project unless project.nil?
294
+ command.query['fields'] = fields unless fields.nil?
295
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
296
+ execute_or_queue_command(command, &block)
297
+ end
298
+
195
299
  # Estimates the data size to be used by a customer.
196
300
  # @param [String] location
197
301
  # Required. Full resource name of the location, such as `projects/`project`/
@@ -1439,9 +1543,9 @@ module Google
1439
1543
  # Updates a Conversation. Conversation action type cannot be changed. If the
1440
1544
  # Conversation to update does not exist, a NOT_FOUND error is returned.
1441
1545
  # @param [String] name
1442
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
1443
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
1444
- # collections/`collection`/engines/*/conversations/*`.
1546
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
1547
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
1548
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
1445
1549
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
1446
1550
  # @param [String] update_mask
1447
1551
  # Indicates which fields in the provided Conversation to update. The following
@@ -2258,8 +2362,8 @@ module Google
2258
2362
  # Updates a Session. Session action type cannot be changed. If the Session to
2259
2363
  # update does not exist, a NOT_FOUND error is returned.
2260
2364
  # @param [String] name
2261
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
2262
- # collection`/engines/`engine`/sessions/*`
2365
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
2366
+ # collections/`collection`/engines/`engine`/sessions/*`
2263
2367
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
2264
2368
  # @param [String] update_mask
2265
2369
  # Indicates which fields in the provided Session to update. The following are
@@ -3068,8 +3172,12 @@ module Google
3068
3172
 
3069
3173
  # Writes a single user event.
3070
3174
  # @param [String] parent
3071
- # Required. The parent DataStore resource name, such as `projects/`project`/
3072
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
3175
+ # Required. The parent resource name. If the write user event action is applied
3176
+ # in DataStore level, the format is: `projects/`project`/locations/`location`/
3177
+ # collections/`collection`/dataStores/`data_store``. If the write user event
3178
+ # action is applied in Location level, for example, the event with Document
3179
+ # across multiple DataStore, the format is: `projects/`project`/locations/`
3180
+ # location``.
3073
3181
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
3074
3182
  # @param [String] fields
3075
3183
  # Selector specifying which fields to include in a partial response.
@@ -3583,9 +3691,9 @@ module Google
3583
3691
  # Updates a Conversation. Conversation action type cannot be changed. If the
3584
3692
  # Conversation to update does not exist, a NOT_FOUND error is returned.
3585
3693
  # @param [String] name
3586
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
3587
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
3588
- # collections/`collection`/engines/*/conversations/*`.
3694
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
3695
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
3696
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
3589
3697
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
3590
3698
  # @param [String] update_mask
3591
3699
  # Indicates which fields in the provided Conversation to update. The following
@@ -4073,8 +4181,8 @@ module Google
4073
4181
  # Updates a Session. Session action type cannot be changed. If the Session to
4074
4182
  # update does not exist, a NOT_FOUND error is returned.
4075
4183
  # @param [String] name
4076
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
4077
- # collection`/engines/`engine`/sessions/*`
4184
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
4185
+ # collections/`collection`/engines/`engine`/sessions/*`
4078
4186
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
4079
4187
  # @param [String] update_mask
4080
4188
  # Indicates which fields in the provided Session to update. The following are
@@ -5251,9 +5359,9 @@ module Google
5251
5359
  # Updates a Conversation. Conversation action type cannot be changed. If the
5252
5360
  # Conversation to update does not exist, a NOT_FOUND error is returned.
5253
5361
  # @param [String] name
5254
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
5255
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
5256
- # collections/`collection`/engines/*/conversations/*`.
5362
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
5363
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
5364
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
5257
5365
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
5258
5366
  # @param [String] update_mask
5259
5367
  # Indicates which fields in the provided Conversation to update. The following
@@ -5999,8 +6107,8 @@ module Google
5999
6107
  # Updates a Session. Session action type cannot be changed. If the Session to
6000
6108
  # update does not exist, a NOT_FOUND error is returned.
6001
6109
  # @param [String] name
6002
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
6003
- # collection`/engines/`engine`/sessions/*`
6110
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
6111
+ # collections/`collection`/engines/`engine`/sessions/*`
6004
6112
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
6005
6113
  # @param [String] update_mask
6006
6114
  # Indicates which fields in the provided Session to update. The following are
@@ -6586,8 +6694,12 @@ module Google
6586
6694
 
6587
6695
  # Writes a single user event.
6588
6696
  # @param [String] parent
6589
- # Required. The parent DataStore resource name, such as `projects/`project`/
6590
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
6697
+ # Required. The parent resource name. If the write user event action is applied
6698
+ # in DataStore level, the format is: `projects/`project`/locations/`location`/
6699
+ # collections/`collection`/dataStores/`data_store``. If the write user event
6700
+ # action is applied in Location level, for example, the event with Document
6701
+ # across multiple DataStore, the format is: `projects/`project`/locations/`
6702
+ # location``.
6591
6703
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
6592
6704
  # @param [String] fields
6593
6705
  # Selector specifying which fields to include in a partial response.
@@ -6788,6 +6900,75 @@ module Google
6788
6900
  execute_or_queue_command(command, &block)
6789
6901
  end
6790
6902
 
6903
+ # Gets the latest state of a long-running operation. Clients can use this method
6904
+ # to poll the operation result at intervals as recommended by the API service.
6905
+ # @param [String] name
6906
+ # The name of the operation resource.
6907
+ # @param [String] fields
6908
+ # Selector specifying which fields to include in a partial response.
6909
+ # @param [String] quota_user
6910
+ # Available to use for quota purposes for server-side applications. Can be any
6911
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6912
+ # @param [Google::Apis::RequestOptions] options
6913
+ # Request-specific options
6914
+ #
6915
+ # @yield [result, err] Result & error if block supplied
6916
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
6917
+ # @yieldparam err [StandardError] error object if request failed
6918
+ #
6919
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
6920
+ #
6921
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6922
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6923
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6924
+ def get_project_location_sample_query_set_operation(name, fields: nil, quota_user: nil, options: nil, &block)
6925
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
6926
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
6927
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
6928
+ command.params['name'] = name unless name.nil?
6929
+ command.query['fields'] = fields unless fields.nil?
6930
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6931
+ execute_or_queue_command(command, &block)
6932
+ end
6933
+
6934
+ # Writes a single user event.
6935
+ # @param [String] parent
6936
+ # Required. The parent resource name. If the write user event action is applied
6937
+ # in DataStore level, the format is: `projects/`project`/locations/`location`/
6938
+ # collections/`collection`/dataStores/`data_store``. If the write user event
6939
+ # action is applied in Location level, for example, the event with Document
6940
+ # across multiple DataStore, the format is: `projects/`project`/locations/`
6941
+ # location``.
6942
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
6943
+ # @param [String] fields
6944
+ # Selector specifying which fields to include in a partial response.
6945
+ # @param [String] quota_user
6946
+ # Available to use for quota purposes for server-side applications. Can be any
6947
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6948
+ # @param [Google::Apis::RequestOptions] options
6949
+ # Request-specific options
6950
+ #
6951
+ # @yield [result, err] Result & error if block supplied
6952
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] parsed result object
6953
+ # @yieldparam err [StandardError] error object if request failed
6954
+ #
6955
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
6956
+ #
6957
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6958
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6959
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6960
+ def write_project_location_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6961
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
6962
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6963
+ command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
6964
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6965
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
6966
+ command.params['parent'] = parent unless parent.nil?
6967
+ command.query['fields'] = fields unless fields.nil?
6968
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6969
+ execute_or_queue_command(command, &block)
6970
+ end
6971
+
6791
6972
  # Gets the latest state of a long-running operation. Clients can use this method
6792
6973
  # to poll the operation result at intervals as recommended by the API service.
6793
6974
  # @param [String] name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.43.0
4
+ version: 0.44.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-07 00:00:00.000000000 Z
11
+ date: 2024-04-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.43.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.44.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []