google-apis-discoveryengine_v1alpha 0.25.0 → 0.27.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -252,6 +252,211 @@ module Google
252
252
  execute_or_queue_command(command, &block)
253
253
  end
254
254
 
255
+ # Creates a DataStore. DataStore is for storing Documents. To serve these
256
+ # documents for Search, or Recommendation use case, an Engine needs to be
257
+ # created separately.
258
+ # @param [String] parent
259
+ # Required. The parent resource name, such as `projects/`project`/locations/`
260
+ # location`/collections/`collection``.
261
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
262
+ # @param [Boolean] create_advanced_site_search
263
+ # A boolean flag indicating whether user want to directly create an advanced
264
+ # data store for site search. If the data store is not configured as site search
265
+ # (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be
266
+ # ignored.
267
+ # @param [String] data_store_id
268
+ # Required. The ID to use for the DataStore, which will become the final
269
+ # component of the DataStore's resource name. This field must conform to [RFC-
270
+ # 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
271
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned.
272
+ # @param [String] fields
273
+ # Selector specifying which fields to include in a partial response.
274
+ # @param [String] quota_user
275
+ # Available to use for quota purposes for server-side applications. Can be any
276
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
277
+ # @param [Google::Apis::RequestOptions] options
278
+ # Request-specific options
279
+ #
280
+ # @yield [result, err] Result & error if block supplied
281
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
282
+ # @yieldparam err [StandardError] error object if request failed
283
+ #
284
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
285
+ #
286
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
287
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
288
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
289
+ def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1alpha_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
290
+ command = make_simple_command(:post, 'v1alpha/{+parent}/dataStores', options)
291
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
292
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
293
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
294
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
295
+ command.params['parent'] = parent unless parent.nil?
296
+ command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
297
+ command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
298
+ command.query['fields'] = fields unless fields.nil?
299
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
300
+ execute_or_queue_command(command, &block)
301
+ end
302
+
303
+ # Deletes a DataStore.
304
+ # @param [String] name
305
+ # Required. Full resource name of DataStore, such as `projects/`project`/
306
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
307
+ # If the caller does not have permission to delete the DataStore, regardless of
308
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
309
+ # DataStore to delete does not exist, a NOT_FOUND error is returned.
310
+ # @param [String] fields
311
+ # Selector specifying which fields to include in a partial response.
312
+ # @param [String] quota_user
313
+ # Available to use for quota purposes for server-side applications. Can be any
314
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
315
+ # @param [Google::Apis::RequestOptions] options
316
+ # Request-specific options
317
+ #
318
+ # @yield [result, err] Result & error if block supplied
319
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
320
+ # @yieldparam err [StandardError] error object if request failed
321
+ #
322
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
323
+ #
324
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
325
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
326
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
327
+ def delete_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
328
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
329
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
330
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
331
+ command.params['name'] = name unless name.nil?
332
+ command.query['fields'] = fields unless fields.nil?
333
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
334
+ execute_or_queue_command(command, &block)
335
+ end
336
+
337
+ # Gets a DataStore.
338
+ # @param [String] name
339
+ # Required. Full resource name of DataStore, such as `projects/`project`/
340
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
341
+ # If the caller does not have permission to access the DataStore, regardless of
342
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
343
+ # requested DataStore does not exist, a NOT_FOUND error is returned.
344
+ # @param [String] fields
345
+ # Selector specifying which fields to include in a partial response.
346
+ # @param [String] quota_user
347
+ # Available to use for quota purposes for server-side applications. Can be any
348
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
349
+ # @param [Google::Apis::RequestOptions] options
350
+ # Request-specific options
351
+ #
352
+ # @yield [result, err] Result & error if block supplied
353
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
354
+ # @yieldparam err [StandardError] error object if request failed
355
+ #
356
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
357
+ #
358
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
359
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
360
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
361
+ def get_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
362
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
363
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
364
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
365
+ command.params['name'] = name unless name.nil?
366
+ command.query['fields'] = fields unless fields.nil?
367
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
368
+ execute_or_queue_command(command, &block)
369
+ end
370
+
371
+ # Lists all the DataStores associated with the project.
372
+ # @param [String] parent
373
+ # Required. The parent branch resource name, such as `projects/`project`/
374
+ # locations/`location`/collections/`collection_id``. If the caller does not have
375
+ # permission to list DataStoress under this location, regardless of whether or
376
+ # not this data store exists, a PERMISSION_DENIED error is returned.
377
+ # @param [String] filter
378
+ # Filter by solution type. For example: filter = 'solution_type:
379
+ # SOLUTION_TYPE_SEARCH'
380
+ # @param [Fixnum] page_size
381
+ # Maximum number of DataStores to return. If unspecified, defaults to 10. The
382
+ # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
383
+ # field is negative, an INVALID_ARGUMENT is returned.
384
+ # @param [String] page_token
385
+ # A page token ListDataStoresResponse.next_page_token, received from a previous
386
+ # DataStoreService.ListDataStores call. Provide this to retrieve the subsequent
387
+ # page. When paginating, all other parameters provided to DataStoreService.
388
+ # ListDataStores must match the call that provided the page token. Otherwise, an
389
+ # INVALID_ARGUMENT error is returned.
390
+ # @param [String] fields
391
+ # Selector specifying which fields to include in a partial response.
392
+ # @param [String] quota_user
393
+ # Available to use for quota purposes for server-side applications. Can be any
394
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
395
+ # @param [Google::Apis::RequestOptions] options
396
+ # Request-specific options
397
+ #
398
+ # @yield [result, err] Result & error if block supplied
399
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse] parsed result object
400
+ # @yieldparam err [StandardError] error object if request failed
401
+ #
402
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse]
403
+ #
404
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
405
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
406
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
407
+ def list_project_location_collection_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
408
+ command = make_simple_command(:get, 'v1alpha/{+parent}/dataStores', options)
409
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse::Representation
410
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
411
+ command.params['parent'] = parent unless parent.nil?
412
+ command.query['filter'] = filter unless filter.nil?
413
+ command.query['pageSize'] = page_size unless page_size.nil?
414
+ command.query['pageToken'] = page_token unless page_token.nil?
415
+ command.query['fields'] = fields unless fields.nil?
416
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
417
+ execute_or_queue_command(command, &block)
418
+ end
419
+
420
+ # Updates a DataStore
421
+ # @param [String] name
422
+ # Immutable. The full resource name of the data store. Format: `projects/`
423
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
424
+ # data_store_id``. This field must be a UTF-8 encoded string with a length limit
425
+ # of 1024 characters.
426
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
427
+ # @param [String] update_mask
428
+ # Indicates which fields in the provided DataStore to update. If an unsupported
429
+ # or unknown field is provided, an INVALID_ARGUMENT error is returned.
430
+ # @param [String] fields
431
+ # Selector specifying which fields to include in a partial response.
432
+ # @param [String] quota_user
433
+ # Available to use for quota purposes for server-side applications. Can be any
434
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
435
+ # @param [Google::Apis::RequestOptions] options
436
+ # Request-specific options
437
+ #
438
+ # @yield [result, err] Result & error if block supplied
439
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
440
+ # @yieldparam err [StandardError] error object if request failed
441
+ #
442
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
443
+ #
444
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
445
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
446
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
447
+ def patch_project_location_collection_data_store(name, google_cloud_discoveryengine_v1alpha_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
448
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
449
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
450
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
451
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
452
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
453
+ command.params['name'] = name unless name.nil?
454
+ command.query['updateMask'] = update_mask unless update_mask.nil?
455
+ command.query['fields'] = fields unless fields.nil?
456
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
457
+ execute_or_queue_command(command, &block)
458
+ end
459
+
255
460
  # Creates a Document.
256
461
  # @param [String] parent
257
462
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -1228,10 +1433,14 @@ module Google
1228
1433
 
1229
1434
  # Makes a recommendation, which requires a contextual user event.
1230
1435
  # @param [String] serving_config
1231
- # Required. Full resource name of the format: `projects/*/locations/global/
1232
- # collections/*/dataStores/*/servingConfigs/*` Before you can request
1233
- # recommendations from your model, you must create at least one serving config
1234
- # for it.
1436
+ # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
1437
+ # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
1438
+ # collections/*/dataStores/*/servingConfigs/*` One default serving config is
1439
+ # created along with your recommendation engine creation. The engine ID will be
1440
+ # used as the ID of the default serving config. For example, for Engine `
1441
+ # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
1442
+ # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
1443
+ # engine` for your Recommend requests.
1235
1444
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
1236
1445
  # @param [String] fields
1237
1446
  # Selector specifying which fields to include in a partial response.
@@ -1265,9 +1474,11 @@ module Google
1265
1474
  # Performs a search.
1266
1475
  # @param [String] serving_config
1267
1476
  # Required. The resource name of the Search serving config, such as `projects/*/
1268
- # locations/global/collections/default_collection/dataStores/default_data_store/
1269
- # servingConfigs/default_serving_config`. This field is used to identify the
1270
- # serving configuration name, set of models used to make the search.
1477
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
1478
+ # default_serving_config`, or `projects/*/locations/global/collections/
1479
+ # default_collection/dataStores/default_data_store/servingConfigs/
1480
+ # default_serving_config`. This field is used to identify the serving
1481
+ # configuration name, set of models used to make the search.
1271
1482
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
1272
1483
  # @param [String] fields
1273
1484
  # Selector specifying which fields to include in a partial response.
@@ -1632,6 +1843,299 @@ module Google
1632
1843
  execute_or_queue_command(command, &block)
1633
1844
  end
1634
1845
 
1846
+ # Creates a Engine.
1847
+ # @param [String] parent
1848
+ # Required. The parent resource name, such as `projects/`project`/locations/`
1849
+ # location`/collections/`collection``.
1850
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
1851
+ # @param [String] engine_id
1852
+ # Required. The ID to use for the Engine, which will become the final component
1853
+ # of the Engine's resource name. This field must conform to [RFC-1034](https://
1854
+ # tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
1855
+ # Otherwise, an INVALID_ARGUMENT error is returned.
1856
+ # @param [String] fields
1857
+ # Selector specifying which fields to include in a partial response.
1858
+ # @param [String] quota_user
1859
+ # Available to use for quota purposes for server-side applications. Can be any
1860
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1861
+ # @param [Google::Apis::RequestOptions] options
1862
+ # Request-specific options
1863
+ #
1864
+ # @yield [result, err] Result & error if block supplied
1865
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1866
+ # @yieldparam err [StandardError] error object if request failed
1867
+ #
1868
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1869
+ #
1870
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1871
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1872
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1873
+ def create_project_location_collection_engine(parent, google_cloud_discoveryengine_v1alpha_engine_object = nil, engine_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1874
+ command = make_simple_command(:post, 'v1alpha/{+parent}/engines', options)
1875
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
1876
+ command.request_object = google_cloud_discoveryengine_v1alpha_engine_object
1877
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1878
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1879
+ command.params['parent'] = parent unless parent.nil?
1880
+ command.query['engineId'] = engine_id unless engine_id.nil?
1881
+ command.query['fields'] = fields unless fields.nil?
1882
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1883
+ execute_or_queue_command(command, &block)
1884
+ end
1885
+
1886
+ # Deletes a Engine.
1887
+ # @param [String] name
1888
+ # Required. Full resource name of Engine, such as `projects/`project`/locations/`
1889
+ # location`/collections/`collection_id`/engines/`engine_id``. If the caller does
1890
+ # not have permission to delete the Engine, regardless of whether or not it
1891
+ # exists, a PERMISSION_DENIED error is returned. If the Engine to delete does
1892
+ # not exist, a NOT_FOUND error is returned.
1893
+ # @param [String] fields
1894
+ # Selector specifying which fields to include in a partial response.
1895
+ # @param [String] quota_user
1896
+ # Available to use for quota purposes for server-side applications. Can be any
1897
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1898
+ # @param [Google::Apis::RequestOptions] options
1899
+ # Request-specific options
1900
+ #
1901
+ # @yield [result, err] Result & error if block supplied
1902
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
1903
+ # @yieldparam err [StandardError] error object if request failed
1904
+ #
1905
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
1906
+ #
1907
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1908
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1909
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1910
+ def delete_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
1911
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1912
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
1913
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
1914
+ command.params['name'] = name unless name.nil?
1915
+ command.query['fields'] = fields unless fields.nil?
1916
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1917
+ execute_or_queue_command(command, &block)
1918
+ end
1919
+
1920
+ # Gets a Engine.
1921
+ # @param [String] name
1922
+ # Required. Full resource name of Engine, such as `projects/`project`/locations/`
1923
+ # location`/collections/`collection_id`/engines/`engine_id``.
1924
+ # @param [String] fields
1925
+ # Selector specifying which fields to include in a partial response.
1926
+ # @param [String] quota_user
1927
+ # Available to use for quota purposes for server-side applications. Can be any
1928
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1929
+ # @param [Google::Apis::RequestOptions] options
1930
+ # Request-specific options
1931
+ #
1932
+ # @yield [result, err] Result & error if block supplied
1933
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
1934
+ # @yieldparam err [StandardError] error object if request failed
1935
+ #
1936
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
1937
+ #
1938
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1939
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1940
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1941
+ def get_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
1942
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1943
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
1944
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
1945
+ command.params['name'] = name unless name.nil?
1946
+ command.query['fields'] = fields unless fields.nil?
1947
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1948
+ execute_or_queue_command(command, &block)
1949
+ end
1950
+
1951
+ # Lists all the Engines associated with the project.
1952
+ # @param [String] parent
1953
+ # Required. The parent resource name, such as `projects/`project`/locations/`
1954
+ # location`/collections/`collection_id``.
1955
+ # @param [String] filter
1956
+ # Optional. Filter by solution type. For example: solution_type=
1957
+ # SOLUTION_TYPE_SEARCH
1958
+ # @param [Fixnum] page_size
1959
+ # Optional. Not supported.
1960
+ # @param [String] page_token
1961
+ # Optional. Not supported.
1962
+ # @param [String] fields
1963
+ # Selector specifying which fields to include in a partial response.
1964
+ # @param [String] quota_user
1965
+ # Available to use for quota purposes for server-side applications. Can be any
1966
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1967
+ # @param [Google::Apis::RequestOptions] options
1968
+ # Request-specific options
1969
+ #
1970
+ # @yield [result, err] Result & error if block supplied
1971
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse] parsed result object
1972
+ # @yieldparam err [StandardError] error object if request failed
1973
+ #
1974
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse]
1975
+ #
1976
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1977
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1978
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1979
+ def list_project_location_collection_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1980
+ command = make_simple_command(:get, 'v1alpha/{+parent}/engines', options)
1981
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse::Representation
1982
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse
1983
+ command.params['parent'] = parent unless parent.nil?
1984
+ command.query['filter'] = filter unless filter.nil?
1985
+ command.query['pageSize'] = page_size unless page_size.nil?
1986
+ command.query['pageToken'] = page_token unless page_token.nil?
1987
+ command.query['fields'] = fields unless fields.nil?
1988
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1989
+ execute_or_queue_command(command, &block)
1990
+ end
1991
+
1992
+ # Updates an Engine
1993
+ # @param [String] name
1994
+ # Immutable. The fully qualified resource name of the engine. This field must be
1995
+ # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
1996
+ # projects/`project_number`/locations/`location`/collections/`collection`/
1997
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
1998
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
1999
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
2000
+ # @param [String] update_mask
2001
+ # Indicates which fields in the provided Engine to update. If an unsupported or
2002
+ # unknown field is provided, an INVALID_ARGUMENT error is returned.
2003
+ # @param [String] fields
2004
+ # Selector specifying which fields to include in a partial response.
2005
+ # @param [String] quota_user
2006
+ # Available to use for quota purposes for server-side applications. Can be any
2007
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2008
+ # @param [Google::Apis::RequestOptions] options
2009
+ # Request-specific options
2010
+ #
2011
+ # @yield [result, err] Result & error if block supplied
2012
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
2013
+ # @yieldparam err [StandardError] error object if request failed
2014
+ #
2015
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
2016
+ #
2017
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2018
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2019
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2020
+ def patch_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2021
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2022
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2023
+ command.request_object = google_cloud_discoveryengine_v1alpha_engine_object
2024
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2025
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
2026
+ command.params['name'] = name unless name.nil?
2027
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2028
+ command.query['fields'] = fields unless fields.nil?
2029
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2030
+ execute_or_queue_command(command, &block)
2031
+ end
2032
+
2033
+ # Pauses the training of an existing engine. Only applicable if solution_type is
2034
+ # SOLUTION_TYPE_RECOMMENDATION.
2035
+ # @param [String] name
2036
+ # Required. The name of the engine to pause. Format: `projects/`project_number`/
2037
+ # locations/`location_id`/collections/`collection_id`/engines/`engine_id``
2038
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPauseEngineRequest] google_cloud_discoveryengine_v1alpha_pause_engine_request_object
2039
+ # @param [String] fields
2040
+ # Selector specifying which fields to include in a partial response.
2041
+ # @param [String] quota_user
2042
+ # Available to use for quota purposes for server-side applications. Can be any
2043
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2044
+ # @param [Google::Apis::RequestOptions] options
2045
+ # Request-specific options
2046
+ #
2047
+ # @yield [result, err] Result & error if block supplied
2048
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
2049
+ # @yieldparam err [StandardError] error object if request failed
2050
+ #
2051
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
2052
+ #
2053
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2054
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2055
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2056
+ def pause_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_pause_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2057
+ command = make_simple_command(:post, 'v1alpha/{+name}:pause', options)
2058
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPauseEngineRequest::Representation
2059
+ command.request_object = google_cloud_discoveryengine_v1alpha_pause_engine_request_object
2060
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2061
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
2062
+ command.params['name'] = name unless name.nil?
2063
+ command.query['fields'] = fields unless fields.nil?
2064
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2065
+ execute_or_queue_command(command, &block)
2066
+ end
2067
+
2068
+ # Resumes the training of an existing engine. Only applicable if solution_type
2069
+ # is SOLUTION_TYPE_RECOMMENDATION.
2070
+ # @param [String] name
2071
+ # Required. The name of the engine to resume. Format: `projects/`project_number`/
2072
+ # locations/`location_id`/collections/`collection_id`/engines/`engine_id``
2073
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaResumeEngineRequest] google_cloud_discoveryengine_v1alpha_resume_engine_request_object
2074
+ # @param [String] fields
2075
+ # Selector specifying which fields to include in a partial response.
2076
+ # @param [String] quota_user
2077
+ # Available to use for quota purposes for server-side applications. Can be any
2078
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2079
+ # @param [Google::Apis::RequestOptions] options
2080
+ # Request-specific options
2081
+ #
2082
+ # @yield [result, err] Result & error if block supplied
2083
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
2084
+ # @yieldparam err [StandardError] error object if request failed
2085
+ #
2086
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
2087
+ #
2088
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2089
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2090
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2091
+ def resume_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_resume_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2092
+ command = make_simple_command(:post, 'v1alpha/{+name}:resume', options)
2093
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaResumeEngineRequest::Representation
2094
+ command.request_object = google_cloud_discoveryengine_v1alpha_resume_engine_request_object
2095
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2096
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
2097
+ command.params['name'] = name unless name.nil?
2098
+ command.query['fields'] = fields unless fields.nil?
2099
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2100
+ execute_or_queue_command(command, &block)
2101
+ end
2102
+
2103
+ # Tunes an existing engine. Only applicable if solution_type is
2104
+ # SOLUTION_TYPE_RECOMMENDATION.
2105
+ # @param [String] name
2106
+ # Required. The resource name of the engine to tune. Format: `projects/`
2107
+ # project_number`/locations/`location_id`/collections/`collection_id`/engines/`
2108
+ # engine_id``
2109
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest] google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2110
+ # @param [String] fields
2111
+ # Selector specifying which fields to include in a partial response.
2112
+ # @param [String] quota_user
2113
+ # Available to use for quota purposes for server-side applications. Can be any
2114
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2115
+ # @param [Google::Apis::RequestOptions] options
2116
+ # Request-specific options
2117
+ #
2118
+ # @yield [result, err] Result & error if block supplied
2119
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2120
+ # @yieldparam err [StandardError] error object if request failed
2121
+ #
2122
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2123
+ #
2124
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2125
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2126
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2127
+ def tune_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_tune_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2128
+ command = make_simple_command(:post, 'v1alpha/{+name}:tune', options)
2129
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest::Representation
2130
+ command.request_object = google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2131
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2132
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2133
+ command.params['name'] = name unless name.nil?
2134
+ command.query['fields'] = fields unless fields.nil?
2135
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2136
+ execute_or_queue_command(command, &block)
2137
+ end
2138
+
1635
2139
  # Gets the latest state of a long-running operation. Clients can use this method
1636
2140
  # to poll the operation result at intervals as recommended by the API service.
1637
2141
  # @param [String] name
@@ -1705,10 +2209,14 @@ module Google
1705
2209
 
1706
2210
  # Makes a recommendation, which requires a contextual user event.
1707
2211
  # @param [String] serving_config
1708
- # Required. Full resource name of the format: `projects/*/locations/global/
1709
- # collections/*/dataStores/*/servingConfigs/*` Before you can request
1710
- # recommendations from your model, you must create at least one serving config
1711
- # for it.
2212
+ # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
2213
+ # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
2214
+ # collections/*/dataStores/*/servingConfigs/*` One default serving config is
2215
+ # created along with your recommendation engine creation. The engine ID will be
2216
+ # used as the ID of the default serving config. For example, for Engine `
2217
+ # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
2218
+ # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
2219
+ # engine` for your Recommend requests.
1712
2220
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
1713
2221
  # @param [String] fields
1714
2222
  # Selector specifying which fields to include in a partial response.
@@ -1742,9 +2250,11 @@ module Google
1742
2250
  # Performs a search.
1743
2251
  # @param [String] serving_config
1744
2252
  # Required. The resource name of the Search serving config, such as `projects/*/
1745
- # locations/global/collections/default_collection/dataStores/default_data_store/
1746
- # servingConfigs/default_serving_config`. This field is used to identify the
1747
- # serving configuration name, set of models used to make the search.
2253
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
2254
+ # default_serving_config`, or `projects/*/locations/global/collections/
2255
+ # default_collection/dataStores/default_data_store/servingConfigs/
2256
+ # default_serving_config`. This field is used to identify the serving
2257
+ # configuration name, set of models used to make the search.
1748
2258
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
1749
2259
  # @param [String] fields
1750
2260
  # Selector specifying which fields to include in a partial response.
@@ -1908,6 +2418,211 @@ module Google
1908
2418
  execute_or_queue_command(command, &block)
1909
2419
  end
1910
2420
 
2421
+ # Creates a DataStore. DataStore is for storing Documents. To serve these
2422
+ # documents for Search, or Recommendation use case, an Engine needs to be
2423
+ # created separately.
2424
+ # @param [String] parent
2425
+ # Required. The parent resource name, such as `projects/`project`/locations/`
2426
+ # location`/collections/`collection``.
2427
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
2428
+ # @param [Boolean] create_advanced_site_search
2429
+ # A boolean flag indicating whether user want to directly create an advanced
2430
+ # data store for site search. If the data store is not configured as site search
2431
+ # (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be
2432
+ # ignored.
2433
+ # @param [String] data_store_id
2434
+ # Required. The ID to use for the DataStore, which will become the final
2435
+ # component of the DataStore's resource name. This field must conform to [RFC-
2436
+ # 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
2437
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned.
2438
+ # @param [String] fields
2439
+ # Selector specifying which fields to include in a partial response.
2440
+ # @param [String] quota_user
2441
+ # Available to use for quota purposes for server-side applications. Can be any
2442
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2443
+ # @param [Google::Apis::RequestOptions] options
2444
+ # Request-specific options
2445
+ #
2446
+ # @yield [result, err] Result & error if block supplied
2447
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2448
+ # @yieldparam err [StandardError] error object if request failed
2449
+ #
2450
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2451
+ #
2452
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2453
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2454
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2455
+ def create_project_location_data_store(parent, google_cloud_discoveryengine_v1alpha_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2456
+ command = make_simple_command(:post, 'v1alpha/{+parent}/dataStores', options)
2457
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2458
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
2459
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2460
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2461
+ command.params['parent'] = parent unless parent.nil?
2462
+ command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
2463
+ command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
2464
+ command.query['fields'] = fields unless fields.nil?
2465
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2466
+ execute_or_queue_command(command, &block)
2467
+ end
2468
+
2469
+ # Deletes a DataStore.
2470
+ # @param [String] name
2471
+ # Required. Full resource name of DataStore, such as `projects/`project`/
2472
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
2473
+ # If the caller does not have permission to delete the DataStore, regardless of
2474
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
2475
+ # DataStore to delete does not exist, a NOT_FOUND error is returned.
2476
+ # @param [String] fields
2477
+ # Selector specifying which fields to include in a partial response.
2478
+ # @param [String] quota_user
2479
+ # Available to use for quota purposes for server-side applications. Can be any
2480
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2481
+ # @param [Google::Apis::RequestOptions] options
2482
+ # Request-specific options
2483
+ #
2484
+ # @yield [result, err] Result & error if block supplied
2485
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2486
+ # @yieldparam err [StandardError] error object if request failed
2487
+ #
2488
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2489
+ #
2490
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2491
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2492
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2493
+ def delete_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
2494
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2495
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2496
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2497
+ command.params['name'] = name unless name.nil?
2498
+ command.query['fields'] = fields unless fields.nil?
2499
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2500
+ execute_or_queue_command(command, &block)
2501
+ end
2502
+
2503
+ # Gets a DataStore.
2504
+ # @param [String] name
2505
+ # Required. Full resource name of DataStore, such as `projects/`project`/
2506
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
2507
+ # If the caller does not have permission to access the DataStore, regardless of
2508
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
2509
+ # requested DataStore does not exist, a NOT_FOUND error is returned.
2510
+ # @param [String] fields
2511
+ # Selector specifying which fields to include in a partial response.
2512
+ # @param [String] quota_user
2513
+ # Available to use for quota purposes for server-side applications. Can be any
2514
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2515
+ # @param [Google::Apis::RequestOptions] options
2516
+ # Request-specific options
2517
+ #
2518
+ # @yield [result, err] Result & error if block supplied
2519
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
2520
+ # @yieldparam err [StandardError] error object if request failed
2521
+ #
2522
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
2523
+ #
2524
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2525
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2526
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2527
+ def get_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
2528
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2529
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2530
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
2531
+ command.params['name'] = name unless name.nil?
2532
+ command.query['fields'] = fields unless fields.nil?
2533
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2534
+ execute_or_queue_command(command, &block)
2535
+ end
2536
+
2537
+ # Lists all the DataStores associated with the project.
2538
+ # @param [String] parent
2539
+ # Required. The parent branch resource name, such as `projects/`project`/
2540
+ # locations/`location`/collections/`collection_id``. If the caller does not have
2541
+ # permission to list DataStoress under this location, regardless of whether or
2542
+ # not this data store exists, a PERMISSION_DENIED error is returned.
2543
+ # @param [String] filter
2544
+ # Filter by solution type. For example: filter = 'solution_type:
2545
+ # SOLUTION_TYPE_SEARCH'
2546
+ # @param [Fixnum] page_size
2547
+ # Maximum number of DataStores to return. If unspecified, defaults to 10. The
2548
+ # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
2549
+ # field is negative, an INVALID_ARGUMENT is returned.
2550
+ # @param [String] page_token
2551
+ # A page token ListDataStoresResponse.next_page_token, received from a previous
2552
+ # DataStoreService.ListDataStores call. Provide this to retrieve the subsequent
2553
+ # page. When paginating, all other parameters provided to DataStoreService.
2554
+ # ListDataStores must match the call that provided the page token. Otherwise, an
2555
+ # INVALID_ARGUMENT error is returned.
2556
+ # @param [String] fields
2557
+ # Selector specifying which fields to include in a partial response.
2558
+ # @param [String] quota_user
2559
+ # Available to use for quota purposes for server-side applications. Can be any
2560
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2561
+ # @param [Google::Apis::RequestOptions] options
2562
+ # Request-specific options
2563
+ #
2564
+ # @yield [result, err] Result & error if block supplied
2565
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse] parsed result object
2566
+ # @yieldparam err [StandardError] error object if request failed
2567
+ #
2568
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse]
2569
+ #
2570
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2571
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2572
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2573
+ def list_project_location_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2574
+ command = make_simple_command(:get, 'v1alpha/{+parent}/dataStores', options)
2575
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse::Representation
2576
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
2577
+ command.params['parent'] = parent unless parent.nil?
2578
+ command.query['filter'] = filter unless filter.nil?
2579
+ command.query['pageSize'] = page_size unless page_size.nil?
2580
+ command.query['pageToken'] = page_token unless page_token.nil?
2581
+ command.query['fields'] = fields unless fields.nil?
2582
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2583
+ execute_or_queue_command(command, &block)
2584
+ end
2585
+
2586
+ # Updates a DataStore
2587
+ # @param [String] name
2588
+ # Immutable. The full resource name of the data store. Format: `projects/`
2589
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
2590
+ # data_store_id``. This field must be a UTF-8 encoded string with a length limit
2591
+ # of 1024 characters.
2592
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
2593
+ # @param [String] update_mask
2594
+ # Indicates which fields in the provided DataStore to update. If an unsupported
2595
+ # or unknown field is provided, an INVALID_ARGUMENT error is returned.
2596
+ # @param [String] fields
2597
+ # Selector specifying which fields to include in a partial response.
2598
+ # @param [String] quota_user
2599
+ # Available to use for quota purposes for server-side applications. Can be any
2600
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2601
+ # @param [Google::Apis::RequestOptions] options
2602
+ # Request-specific options
2603
+ #
2604
+ # @yield [result, err] Result & error if block supplied
2605
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
2606
+ # @yieldparam err [StandardError] error object if request failed
2607
+ #
2608
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
2609
+ #
2610
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2611
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2612
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2613
+ def patch_project_location_data_store(name, google_cloud_discoveryengine_v1alpha_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2614
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2615
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2616
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
2617
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2618
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
2619
+ command.params['name'] = name unless name.nil?
2620
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2621
+ command.query['fields'] = fields unless fields.nil?
2622
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2623
+ execute_or_queue_command(command, &block)
2624
+ end
2625
+
1911
2626
  # Creates a Document.
1912
2627
  # @param [String] parent
1913
2628
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -2813,10 +3528,14 @@ module Google
2813
3528
 
2814
3529
  # Makes a recommendation, which requires a contextual user event.
2815
3530
  # @param [String] serving_config
2816
- # Required. Full resource name of the format: `projects/*/locations/global/
2817
- # collections/*/dataStores/*/servingConfigs/*` Before you can request
2818
- # recommendations from your model, you must create at least one serving config
2819
- # for it.
3531
+ # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
3532
+ # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
3533
+ # collections/*/dataStores/*/servingConfigs/*` One default serving config is
3534
+ # created along with your recommendation engine creation. The engine ID will be
3535
+ # used as the ID of the default serving config. For example, for Engine `
3536
+ # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
3537
+ # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
3538
+ # engine` for your Recommend requests.
2820
3539
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
2821
3540
  # @param [String] fields
2822
3541
  # Selector specifying which fields to include in a partial response.
@@ -2850,9 +3569,11 @@ module Google
2850
3569
  # Performs a search.
2851
3570
  # @param [String] serving_config
2852
3571
  # Required. The resource name of the Search serving config, such as `projects/*/
2853
- # locations/global/collections/default_collection/dataStores/default_data_store/
2854
- # servingConfigs/default_serving_config`. This field is used to identify the
2855
- # serving configuration name, set of models used to make the search.
3572
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
3573
+ # default_serving_config`, or `projects/*/locations/global/collections/
3574
+ # default_collection/dataStores/default_data_store/servingConfigs/
3575
+ # default_serving_config`. This field is used to identify the serving
3576
+ # configuration name, set of models used to make the search.
2856
3577
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
2857
3578
  # @param [String] fields
2858
3579
  # Selector specifying which fields to include in a partial response.