google-apis-discoveryengine_v1 0.3.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -51,6 +51,43 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
+ # Provisions the project resource. During the process, related systems will get
55
+ # prepared and initialized. Caller must read the [Terms for data use](https://
56
+ # cloud.google.com/retail/data-use-terms), and optionally specify in request to
57
+ # provide consent to that service terms.
58
+ # @param [String] name
59
+ # Required. Full resource name of a Project, such as `projects/`
60
+ # project_id_or_number``.
61
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProvisionProjectRequest] google_cloud_discoveryengine_v1_provision_project_request_object
62
+ # @param [String] fields
63
+ # Selector specifying which fields to include in a partial response.
64
+ # @param [String] quota_user
65
+ # Available to use for quota purposes for server-side applications. Can be any
66
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
67
+ # @param [Google::Apis::RequestOptions] options
68
+ # Request-specific options
69
+ #
70
+ # @yield [result, err] Result & error if block supplied
71
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
72
+ # @yieldparam err [StandardError] error object if request failed
73
+ #
74
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
75
+ #
76
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
77
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
78
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
79
+ def provision_project(name, google_cloud_discoveryengine_v1_provision_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
80
+ command = make_simple_command(:post, 'v1/{+name}:provision', options)
81
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProvisionProjectRequest::Representation
82
+ command.request_object = google_cloud_discoveryengine_v1_provision_project_request_object
83
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
84
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
85
+ command.params['name'] = name unless name.nil?
86
+ command.query['fields'] = fields unless fields.nil?
87
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
88
+ execute_or_queue_command(command, &block)
89
+ end
90
+
54
91
  # Gets the latest state of a long-running operation. Clients can use this method
55
92
  # to poll the operation result at intervals as recommended by the API service.
56
93
  # @param [String] name
@@ -342,8 +379,8 @@ module Google
342
379
  # permission to list DataStores under this location, regardless of whether or
343
380
  # not this data store exists, a PERMISSION_DENIED error is returned.
344
381
  # @param [String] filter
345
- # Filter by solution type . For example: filter = 'solution_type:
346
- # SOLUTION_TYPE_SEARCH'
382
+ # Filter by solution type . For example: `filter = 'solution_type:
383
+ # SOLUTION_TYPE_SEARCH'`
347
384
  # @param [Fixnum] page_size
348
385
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
349
386
  # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
@@ -430,14 +467,14 @@ module Google
430
467
  # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
431
468
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
432
469
  # @param [String] document_id
433
- # Required. The ID to use for the Document, which will become the final
434
- # component of the Document.name. If the caller does not have permission to
435
- # create the Document, regardless of whether or not it exists, a `
436
- # PERMISSION_DENIED` error is returned. This field must be unique among all
437
- # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
438
- # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
439
- # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
440
- # INVALID_ARGUMENT` error is returned.
470
+ # Required. The ID to use for the Document, which becomes the final component of
471
+ # the Document.name. If the caller does not have permission to create the
472
+ # Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
473
+ # is returned. This field must be unique among all Documents with the same
474
+ # parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
475
+ # conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
476
+ # length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
477
+ # returned.
441
478
  # @param [String] fields
442
479
  # Selector specifying which fields to include in a partial response.
443
480
  # @param [String] quota_user
@@ -539,8 +576,8 @@ module Google
539
576
  end
540
577
 
541
578
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
542
- # existing items will be created. Note: It is possible for a subset of the
543
- # Documents to be successfully updated.
579
+ # existing items are created. Note: It is possible for a subset of the Documents
580
+ # to be successfully updated.
544
581
  # @param [String] parent
545
582
  # Required. The parent branch resource name, such as `projects/`project`/
546
583
  # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -585,8 +622,8 @@ module Google
585
622
  # PERMISSION_DENIED` error is returned.
586
623
  # @param [Fixnum] page_size
587
624
  # Maximum number of Documents to return. If unspecified, defaults to 100. The
588
- # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
589
- # this field is negative, an `INVALID_ARGUMENT` error is returned.
625
+ # maximum allowed value is 1000. Values above 1000 are set to 1000. If this
626
+ # field is negative, an `INVALID_ARGUMENT` error is returned.
590
627
  # @param [String] page_token
591
628
  # A page token ListDocumentsResponse.next_page_token, received from a previous
592
629
  # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -630,10 +667,10 @@ module Google
630
667
  # with a length limit of 1024 characters.
631
668
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
632
669
  # @param [Boolean] allow_missing
633
- # If set to true, and the Document is not found, a new Document will be created.
670
+ # If set to `true` and the Document is not found, a new Document is be created.
634
671
  # @param [String] update_mask
635
672
  # Indicates which fields in the provided imported 'document' to update. If not
636
- # set, will by default update all fields.
673
+ # set, by default updates all fields.
637
674
  # @param [String] fields
638
675
  # Selector specifying which fields to include in a partial response.
639
676
  # @param [String] quota_user
@@ -815,6 +852,197 @@ module Google
815
852
  execute_or_queue_command(command, &block)
816
853
  end
817
854
 
855
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
856
+ # request can be submitted to adjust this limit. If the Control to create
857
+ # already exists, an ALREADY_EXISTS error is returned.
858
+ # @param [String] parent
859
+ # Required. Full resource name of parent data store. Format: `projects/`
860
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
861
+ # `data_store_id``
862
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
863
+ # @param [String] control_id
864
+ # Required. The ID to use for the Control, which will become the final component
865
+ # of the Control's resource name. This value must be within 1-63 characters.
866
+ # Valid characters are /a-z-_/.
867
+ # @param [String] fields
868
+ # Selector specifying which fields to include in a partial response.
869
+ # @param [String] quota_user
870
+ # Available to use for quota purposes for server-side applications. Can be any
871
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
872
+ # @param [Google::Apis::RequestOptions] options
873
+ # Request-specific options
874
+ #
875
+ # @yield [result, err] Result & error if block supplied
876
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
877
+ # @yieldparam err [StandardError] error object if request failed
878
+ #
879
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
880
+ #
881
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
882
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
883
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
884
+ def create_project_location_collection_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
885
+ command = make_simple_command(:post, 'v1/{+parent}/controls', options)
886
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
887
+ command.request_object = google_cloud_discoveryengine_v1_control_object
888
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
889
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
890
+ command.params['parent'] = parent unless parent.nil?
891
+ command.query['controlId'] = control_id unless control_id.nil?
892
+ command.query['fields'] = fields unless fields.nil?
893
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
894
+ execute_or_queue_command(command, &block)
895
+ end
896
+
897
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
898
+ # is returned.
899
+ # @param [String] name
900
+ # Required. The resource name of the Control to delete. Format: `projects/`
901
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
902
+ # `data_store_id`/controls/`control_id``
903
+ # @param [String] fields
904
+ # Selector specifying which fields to include in a partial response.
905
+ # @param [String] quota_user
906
+ # Available to use for quota purposes for server-side applications. Can be any
907
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
908
+ # @param [Google::Apis::RequestOptions] options
909
+ # Request-specific options
910
+ #
911
+ # @yield [result, err] Result & error if block supplied
912
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
913
+ # @yieldparam err [StandardError] error object if request failed
914
+ #
915
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
916
+ #
917
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
918
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
919
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
920
+ def delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
921
+ command = make_simple_command(:delete, 'v1/{+name}', options)
922
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
923
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
924
+ command.params['name'] = name unless name.nil?
925
+ command.query['fields'] = fields unless fields.nil?
926
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
927
+ execute_or_queue_command(command, &block)
928
+ end
929
+
930
+ # Gets a Control.
931
+ # @param [String] name
932
+ # Required. The resource name of the Control to get. Format: `projects/`
933
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
934
+ # `data_store_id`/controls/`control_id``
935
+ # @param [String] fields
936
+ # Selector specifying which fields to include in a partial response.
937
+ # @param [String] quota_user
938
+ # Available to use for quota purposes for server-side applications. Can be any
939
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
940
+ # @param [Google::Apis::RequestOptions] options
941
+ # Request-specific options
942
+ #
943
+ # @yield [result, err] Result & error if block supplied
944
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
945
+ # @yieldparam err [StandardError] error object if request failed
946
+ #
947
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
948
+ #
949
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
950
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
951
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
952
+ def get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
953
+ command = make_simple_command(:get, 'v1/{+name}', options)
954
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
955
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
956
+ command.params['name'] = name unless name.nil?
957
+ command.query['fields'] = fields unless fields.nil?
958
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
959
+ execute_or_queue_command(command, &block)
960
+ end
961
+
962
+ # Lists all Controls by their parent DataStore.
963
+ # @param [String] parent
964
+ # Required. The data store resource name. Format: `projects/`project_number`/
965
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
966
+ # @param [String] filter
967
+ # Optional. A filter to apply on the list results. Supported features: * List
968
+ # all the products under the parent branch if filter is unset. Currently this
969
+ # field is unsupported.
970
+ # @param [Fixnum] page_size
971
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
972
+ # Max allowed value is 1000.
973
+ # @param [String] page_token
974
+ # Optional. A page token, received from a previous `ListControls` call. Provide
975
+ # this to retrieve the subsequent page.
976
+ # @param [String] fields
977
+ # Selector specifying which fields to include in a partial response.
978
+ # @param [String] quota_user
979
+ # Available to use for quota purposes for server-side applications. Can be any
980
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
981
+ # @param [Google::Apis::RequestOptions] options
982
+ # Request-specific options
983
+ #
984
+ # @yield [result, err] Result & error if block supplied
985
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse] parsed result object
986
+ # @yieldparam err [StandardError] error object if request failed
987
+ #
988
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse]
989
+ #
990
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
991
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
992
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
993
+ def list_project_location_collection_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
994
+ command = make_simple_command(:get, 'v1/{+parent}/controls', options)
995
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
996
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
997
+ command.params['parent'] = parent unless parent.nil?
998
+ command.query['filter'] = filter unless filter.nil?
999
+ command.query['pageSize'] = page_size unless page_size.nil?
1000
+ command.query['pageToken'] = page_token unless page_token.nil?
1001
+ command.query['fields'] = fields unless fields.nil?
1002
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1003
+ execute_or_queue_command(command, &block)
1004
+ end
1005
+
1006
+ # Updates a Control. Control action type cannot be changed. If the Control to
1007
+ # update does not exist, a NOT_FOUND error is returned.
1008
+ # @param [String] name
1009
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
1010
+ # controls/*`
1011
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
1012
+ # @param [String] update_mask
1013
+ # Optional. Indicates which fields in the provided Control to update. The
1014
+ # following are NOT supported: * Control.name * Control.solution_type If not set
1015
+ # or empty, all supported fields are updated.
1016
+ # @param [String] fields
1017
+ # Selector specifying which fields to include in a partial response.
1018
+ # @param [String] quota_user
1019
+ # Available to use for quota purposes for server-side applications. Can be any
1020
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1021
+ # @param [Google::Apis::RequestOptions] options
1022
+ # Request-specific options
1023
+ #
1024
+ # @yield [result, err] Result & error if block supplied
1025
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
1026
+ # @yieldparam err [StandardError] error object if request failed
1027
+ #
1028
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
1029
+ #
1030
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1031
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1032
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1033
+ def patch_project_location_collection_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1034
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1035
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
1036
+ command.request_object = google_cloud_discoveryengine_v1_control_object
1037
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
1038
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
1039
+ command.params['name'] = name unless name.nil?
1040
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1041
+ command.query['fields'] = fields unless fields.nil?
1042
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1043
+ execute_or_queue_command(command, &block)
1044
+ end
1045
+
818
1046
  # Converses a conversation.
819
1047
  # @param [String] name
820
1048
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -1192,8 +1420,8 @@ module Google
1192
1420
  # .
1193
1421
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
1194
1422
  # @param [String] schema_id
1195
- # Required. The ID to use for the Schema, which will become the final component
1196
- # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
1423
+ # Required. The ID to use for the Schema, which becomes the final component of
1424
+ # the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
1197
1425
  # org/html/rfc1034) standard with a length limit of 63 characters.
1198
1426
  # @param [String] fields
1199
1427
  # Selector specifying which fields to include in a partial response.
@@ -1296,8 +1524,8 @@ module Google
1296
1524
  # .
1297
1525
  # @param [Fixnum] page_size
1298
1526
  # The maximum number of Schemas to return. The service may return fewer than
1299
- # this value. If unspecified, at most 100 Schemas will be returned. The maximum
1300
- # value is 1000; values above 1000 will be coerced to 1000.
1527
+ # this value. If unspecified, at most 100 Schemas are returned. The maximum
1528
+ # value is 1000; values above 1000 are set to 1000.
1301
1529
  # @param [String] page_token
1302
1530
  # A page token, received from a previous SchemaService.ListSchemas call. Provide
1303
1531
  # this to retrieve the subsequent page. When paginating, all other parameters
@@ -1340,8 +1568,8 @@ module Google
1340
1568
  # limit of 1024 characters.
1341
1569
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
1342
1570
  # @param [Boolean] allow_missing
1343
- # If set to true, and the Schema is not found, a new Schema will be created. In
1344
- # this situation, `update_mask` is ignored.
1571
+ # If set to true, and the Schema is not found, a new Schema is created. In this
1572
+ # situation, `update_mask` is ignored.
1345
1573
  # @param [String] fields
1346
1574
  # Selector specifying which fields to include in a partial response.
1347
1575
  # @param [String] quota_user
@@ -1443,16 +1671,54 @@ module Google
1443
1671
  execute_or_queue_command(command, &block)
1444
1672
  end
1445
1673
 
1674
+ # Answer query method.
1675
+ # @param [String] serving_config
1676
+ # Required. The resource name of the Search serving config, such as `projects/*/
1677
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
1678
+ # default_serving_config`, or `projects/*/locations/global/collections/
1679
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
1680
+ # field is used to identify the serving configuration name, set of models used
1681
+ # to make the search.
1682
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
1683
+ # @param [String] fields
1684
+ # Selector specifying which fields to include in a partial response.
1685
+ # @param [String] quota_user
1686
+ # Available to use for quota purposes for server-side applications. Can be any
1687
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1688
+ # @param [Google::Apis::RequestOptions] options
1689
+ # Request-specific options
1690
+ #
1691
+ # @yield [result, err] Result & error if block supplied
1692
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
1693
+ # @yieldparam err [StandardError] error object if request failed
1694
+ #
1695
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
1696
+ #
1697
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1698
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1699
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1700
+ def answer_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1701
+ command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
1702
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
1703
+ command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
1704
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
1705
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
1706
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1707
+ command.query['fields'] = fields unless fields.nil?
1708
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1709
+ execute_or_queue_command(command, &block)
1710
+ end
1711
+
1446
1712
  # Makes a recommendation, which requires a contextual user event.
1447
1713
  # @param [String] serving_config
1448
1714
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
1449
1715
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
1450
1716
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
1451
- # created along with your recommendation engine creation. The engine ID will be
1452
- # used as the ID of the default serving config. For example, for Engine `
1453
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
1454
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
1455
- # engine` for your RecommendationService.Recommend requests.
1717
+ # created along with your recommendation engine creation. The engine ID is used
1718
+ # as the ID of the default serving config. For example, for Engine `projects/*/
1719
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
1720
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
1721
+ # your RecommendationService.Recommend requests.
1456
1722
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest] google_cloud_discoveryengine_v1_recommend_request_object
1457
1723
  # @param [String] fields
1458
1724
  # Selector specifying which fields to include in a partial response.
@@ -1521,13 +1787,13 @@ module Google
1521
1787
  execute_or_queue_command(command, &block)
1522
1788
  end
1523
1789
 
1524
- # Verify target sites' ownership and validity. This API sends all the target
1525
- # sites under site search engine for verification.
1790
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
1791
+ # error is returned.
1526
1792
  # @param [String] parent
1527
- # Required. The parent resource shared by all TargetSites being verified. `
1528
- # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
1529
- # data_store`/siteSearchEngine`.
1530
- # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest] google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object
1793
+ # Required. Full resource name of parent data store. Format: `projects/`
1794
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1795
+ # data_store_id``
1796
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
1531
1797
  # @param [String] fields
1532
1798
  # Selector specifying which fields to include in a partial response.
1533
1799
  # @param [String] quota_user
@@ -1537,31 +1803,32 @@ module Google
1537
1803
  # Request-specific options
1538
1804
  #
1539
1805
  # @yield [result, err] Result & error if block supplied
1540
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
1806
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
1541
1807
  # @yieldparam err [StandardError] error object if request failed
1542
1808
  #
1543
- # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
1809
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
1544
1810
  #
1545
1811
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1546
1812
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1547
1813
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1548
- def batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1549
- command = make_simple_command(:post, 'v1/{+parent}:batchVerifyTargetSites', options)
1550
- command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest::Representation
1551
- command.request_object = google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object
1552
- command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
1553
- command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
1814
+ def create_project_location_collection_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1815
+ command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
1816
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
1817
+ command.request_object = google_cloud_discoveryengine_v1_session_object
1818
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
1819
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
1554
1820
  command.params['parent'] = parent unless parent.nil?
1555
1821
  command.query['fields'] = fields unless fields.nil?
1556
1822
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1557
1823
  execute_or_queue_command(command, &block)
1558
1824
  end
1559
1825
 
1560
- # Downgrade from advanced site search to basic site search.
1561
- # @param [String] site_search_engine
1562
- # Required. Full resource name of the SiteSearchEngine, such as `projects/`
1563
- # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
1564
- # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object
1826
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
1827
+ # is returned.
1828
+ # @param [String] name
1829
+ # Required. The resource name of the Session to delete. Format: `projects/`
1830
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1831
+ # data_store_id`/sessions/`session_id``
1565
1832
  # @param [String] fields
1566
1833
  # Selector specifying which fields to include in a partial response.
1567
1834
  # @param [String] quota_user
@@ -1571,31 +1838,29 @@ module Google
1571
1838
  # Request-specific options
1572
1839
  #
1573
1840
  # @yield [result, err] Result & error if block supplied
1574
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
1841
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
1575
1842
  # @yieldparam err [StandardError] error object if request failed
1576
1843
  #
1577
- # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
1844
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
1578
1845
  #
1579
1846
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1580
1847
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1581
1848
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1582
- def disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1583
- command = make_simple_command(:post, 'v1/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
1584
- command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest::Representation
1585
- command.request_object = google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object
1586
- command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
1587
- command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
1588
- command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1849
+ def delete_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
1850
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1851
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
1852
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
1853
+ command.params['name'] = name unless name.nil?
1589
1854
  command.query['fields'] = fields unless fields.nil?
1590
1855
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1591
1856
  execute_or_queue_command(command, &block)
1592
1857
  end
1593
1858
 
1594
- # Upgrade from basic site search to advanced site search.
1595
- # @param [String] site_search_engine
1596
- # Required. Full resource name of the SiteSearchEngine, such as `projects/`
1597
- # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
1598
- # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object
1859
+ # Gets a Session.
1860
+ # @param [String] name
1861
+ # Required. The resource name of the Session to get. Format: `projects/`
1862
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1863
+ # data_store_id`/sessions/`session_id``
1599
1864
  # @param [String] fields
1600
1865
  # Selector specifying which fields to include in a partial response.
1601
1866
  # @param [String] quota_user
@@ -1605,38 +1870,260 @@ module Google
1605
1870
  # Request-specific options
1606
1871
  #
1607
1872
  # @yield [result, err] Result & error if block supplied
1608
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
1873
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
1609
1874
  # @yieldparam err [StandardError] error object if request failed
1610
1875
  #
1611
- # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
1876
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
1612
1877
  #
1613
1878
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1614
1879
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1615
1880
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1616
- def enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1617
- command = make_simple_command(:post, 'v1/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
1618
- command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest::Representation
1619
- command.request_object = google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object
1620
- command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
1621
- command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
1622
- command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1881
+ def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
1882
+ command = make_simple_command(:get, 'v1/{+name}', options)
1883
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
1884
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
1885
+ command.params['name'] = name unless name.nil?
1623
1886
  command.query['fields'] = fields unless fields.nil?
1624
1887
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1625
1888
  execute_or_queue_command(command, &block)
1626
1889
  end
1627
1890
 
1628
- # Returns list of target sites with its domain verification status. This method
1629
- # can only be called under data store with BASIC_SITE_SEARCH state at the moment.
1630
- # @param [String] site_search_engine
1631
- # Required. The site search engine resource under which we fetch all the domain
1632
- # verification status. `projects/`project`/locations/`location`/collections/`
1633
- # collection`/dataStores/`data_store`/siteSearchEngine`.
1891
+ # Lists all Sessions by their parent DataStore.
1892
+ # @param [String] parent
1893
+ # Required. The data store resource name. Format: `projects/`project_number`/
1894
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
1895
+ # @param [String] filter
1896
+ # A filter to apply on the list results. The supported features are:
1897
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
1898
+ # @param [String] order_by
1899
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
1900
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
1901
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
1634
1902
  # @param [Fixnum] page_size
1635
- # Requested page size. Server may return fewer items than requested. If
1636
- # unspecified, server will pick an appropriate default. The maximum value is
1637
- # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
1638
- # INVALID_ARGUMENT error is returned.
1639
- # @param [String] page_token
1903
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
1904
+ # allowed value is 1000.
1905
+ # @param [String] page_token
1906
+ # A page token, received from a previous `ListSessions` call. Provide this to
1907
+ # retrieve the subsequent page.
1908
+ # @param [String] fields
1909
+ # Selector specifying which fields to include in a partial response.
1910
+ # @param [String] quota_user
1911
+ # Available to use for quota purposes for server-side applications. Can be any
1912
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1913
+ # @param [Google::Apis::RequestOptions] options
1914
+ # Request-specific options
1915
+ #
1916
+ # @yield [result, err] Result & error if block supplied
1917
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse] parsed result object
1918
+ # @yieldparam err [StandardError] error object if request failed
1919
+ #
1920
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse]
1921
+ #
1922
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1923
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1924
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1925
+ def list_project_location_collection_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1926
+ command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
1927
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
1928
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
1929
+ command.params['parent'] = parent unless parent.nil?
1930
+ command.query['filter'] = filter unless filter.nil?
1931
+ command.query['orderBy'] = order_by unless order_by.nil?
1932
+ command.query['pageSize'] = page_size unless page_size.nil?
1933
+ command.query['pageToken'] = page_token unless page_token.nil?
1934
+ command.query['fields'] = fields unless fields.nil?
1935
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1936
+ execute_or_queue_command(command, &block)
1937
+ end
1938
+
1939
+ # Updates a Session. Session action type cannot be changed. If the Session to
1940
+ # update does not exist, a NOT_FOUND error is returned.
1941
+ # @param [String] name
1942
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
1943
+ # collections/`collection`/engines/`engine`/sessions/*`
1944
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
1945
+ # @param [String] update_mask
1946
+ # Indicates which fields in the provided Session to update. The following are
1947
+ # NOT supported: * Session.name If not set or empty, all supported fields are
1948
+ # updated.
1949
+ # @param [String] fields
1950
+ # Selector specifying which fields to include in a partial response.
1951
+ # @param [String] quota_user
1952
+ # Available to use for quota purposes for server-side applications. Can be any
1953
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1954
+ # @param [Google::Apis::RequestOptions] options
1955
+ # Request-specific options
1956
+ #
1957
+ # @yield [result, err] Result & error if block supplied
1958
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
1959
+ # @yieldparam err [StandardError] error object if request failed
1960
+ #
1961
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
1962
+ #
1963
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1964
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1965
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1966
+ def patch_project_location_collection_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1967
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1968
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
1969
+ command.request_object = google_cloud_discoveryengine_v1_session_object
1970
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
1971
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
1972
+ command.params['name'] = name unless name.nil?
1973
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1974
+ command.query['fields'] = fields unless fields.nil?
1975
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1976
+ execute_or_queue_command(command, &block)
1977
+ end
1978
+
1979
+ # Gets a Answer.
1980
+ # @param [String] name
1981
+ # Required. The resource name of the Answer to get. Format: `projects/`
1982
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
1983
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
1984
+ # @param [String] fields
1985
+ # Selector specifying which fields to include in a partial response.
1986
+ # @param [String] quota_user
1987
+ # Available to use for quota purposes for server-side applications. Can be any
1988
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1989
+ # @param [Google::Apis::RequestOptions] options
1990
+ # Request-specific options
1991
+ #
1992
+ # @yield [result, err] Result & error if block supplied
1993
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer] parsed result object
1994
+ # @yieldparam err [StandardError] error object if request failed
1995
+ #
1996
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
1997
+ #
1998
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1999
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2000
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2001
+ def get_project_location_collection_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
2002
+ command = make_simple_command(:get, 'v1/{+name}', options)
2003
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
2004
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
2005
+ command.params['name'] = name unless name.nil?
2006
+ command.query['fields'] = fields unless fields.nil?
2007
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2008
+ execute_or_queue_command(command, &block)
2009
+ end
2010
+
2011
+ # Verify target sites' ownership and validity. This API sends all the target
2012
+ # sites under site search engine for verification.
2013
+ # @param [String] parent
2014
+ # Required. The parent resource shared by all TargetSites being verified. `
2015
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
2016
+ # data_store`/siteSearchEngine`.
2017
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest] google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object
2018
+ # @param [String] fields
2019
+ # Selector specifying which fields to include in a partial response.
2020
+ # @param [String] quota_user
2021
+ # Available to use for quota purposes for server-side applications. Can be any
2022
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2023
+ # @param [Google::Apis::RequestOptions] options
2024
+ # Request-specific options
2025
+ #
2026
+ # @yield [result, err] Result & error if block supplied
2027
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
2028
+ # @yieldparam err [StandardError] error object if request failed
2029
+ #
2030
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
2031
+ #
2032
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2033
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2034
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2035
+ def batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2036
+ command = make_simple_command(:post, 'v1/{+parent}:batchVerifyTargetSites', options)
2037
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest::Representation
2038
+ command.request_object = google_cloud_discoveryengine_v1_batch_verify_target_sites_request_object
2039
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
2040
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
2041
+ command.params['parent'] = parent unless parent.nil?
2042
+ command.query['fields'] = fields unless fields.nil?
2043
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2044
+ execute_or_queue_command(command, &block)
2045
+ end
2046
+
2047
+ # Downgrade from advanced site search to basic site search.
2048
+ # @param [String] site_search_engine
2049
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
2050
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
2051
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object
2052
+ # @param [String] fields
2053
+ # Selector specifying which fields to include in a partial response.
2054
+ # @param [String] quota_user
2055
+ # Available to use for quota purposes for server-side applications. Can be any
2056
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2057
+ # @param [Google::Apis::RequestOptions] options
2058
+ # Request-specific options
2059
+ #
2060
+ # @yield [result, err] Result & error if block supplied
2061
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
2062
+ # @yieldparam err [StandardError] error object if request failed
2063
+ #
2064
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
2065
+ #
2066
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2067
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2068
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2069
+ def disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2070
+ command = make_simple_command(:post, 'v1/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
2071
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest::Representation
2072
+ command.request_object = google_cloud_discoveryengine_v1_disable_advanced_site_search_request_object
2073
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
2074
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
2075
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2076
+ command.query['fields'] = fields unless fields.nil?
2077
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2078
+ execute_or_queue_command(command, &block)
2079
+ end
2080
+
2081
+ # Upgrade from basic site search to advanced site search.
2082
+ # @param [String] site_search_engine
2083
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
2084
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
2085
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object
2086
+ # @param [String] fields
2087
+ # Selector specifying which fields to include in a partial response.
2088
+ # @param [String] quota_user
2089
+ # Available to use for quota purposes for server-side applications. Can be any
2090
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2091
+ # @param [Google::Apis::RequestOptions] options
2092
+ # Request-specific options
2093
+ #
2094
+ # @yield [result, err] Result & error if block supplied
2095
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
2096
+ # @yieldparam err [StandardError] error object if request failed
2097
+ #
2098
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
2099
+ #
2100
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2101
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2102
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2103
+ def enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2104
+ command = make_simple_command(:post, 'v1/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
2105
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest::Representation
2106
+ command.request_object = google_cloud_discoveryengine_v1_enable_advanced_site_search_request_object
2107
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
2108
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
2109
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2110
+ command.query['fields'] = fields unless fields.nil?
2111
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2112
+ execute_or_queue_command(command, &block)
2113
+ end
2114
+
2115
+ # Returns list of target sites with its domain verification status. This method
2116
+ # can only be called under data store with BASIC_SITE_SEARCH state at the moment.
2117
+ # @param [String] site_search_engine
2118
+ # Required. The site search engine resource under which we fetch all the domain
2119
+ # verification status. `projects/`project`/locations/`location`/collections/`
2120
+ # collection`/dataStores/`data_store`/siteSearchEngine`.
2121
+ # @param [Fixnum] page_size
2122
+ # Requested page size. Server may return fewer items than requested. If
2123
+ # unspecified, server will pick an appropriate default. The maximum value is
2124
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
2125
+ # INVALID_ARGUMENT error is returned.
2126
+ # @param [String] page_token
1640
2127
  # A page token, received from a previous `FetchDomainVerificationStatus` call.
1641
2128
  # Provide this to retrieve the subsequent page. When paginating, all other
1642
2129
  # parameters provided to `FetchDomainVerificationStatus` must match the call
@@ -2184,7 +2671,7 @@ module Google
2184
2671
  execute_or_queue_command(command, &block)
2185
2672
  end
2186
2673
 
2187
- # Bulk import of User events. Request processing might be synchronous. Events
2674
+ # Bulk import of user events. Request processing might be synchronous. Events
2188
2675
  # that already exist are skipped. Use this method for backfilling historical
2189
2676
  # user events. Operation.response is of type ImportResponse. Note that it is
2190
2677
  # possible for a subset of the items to be successfully inserted. Operation.
@@ -2231,6 +2718,9 @@ module Google
2231
2718
  # across multiple DataStore, the format is: `projects/`project`/locations/`
2232
2719
  # location``.
2233
2720
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent] google_cloud_discoveryengine_v1_user_event_object
2721
+ # @param [Boolean] write_async
2722
+ # If set to true, the user event is written asynchronously after validation, and
2723
+ # the API responds without waiting for the write.
2234
2724
  # @param [String] fields
2235
2725
  # Selector specifying which fields to include in a partial response.
2236
2726
  # @param [String] quota_user
@@ -2248,13 +2738,14 @@ module Google
2248
2738
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2249
2739
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2250
2740
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2251
- def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2741
+ def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
2252
2742
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
2253
2743
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
2254
2744
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
2255
2745
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
2256
2746
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
2257
2747
  command.params['parent'] = parent unless parent.nil?
2748
+ command.query['writeAsync'] = write_async unless write_async.nil?
2258
2749
  command.query['fields'] = fields unless fields.nil?
2259
2750
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2260
2751
  execute_or_queue_command(command, &block)
@@ -2447,51 +2938,18 @@ module Google
2447
2938
  execute_or_queue_command(command, &block)
2448
2939
  end
2449
2940
 
2450
- # Converses a conversation.
2451
- # @param [String] name
2452
- # Required. The resource name of the Conversation to get. Format: `projects/`
2453
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2454
- # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
2455
- # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
2456
- # conversations/-` to activate auto session mode, which automatically creates a
2457
- # new conversation inside a ConverseConversation session.
2458
- # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest] google_cloud_discoveryengine_v1_converse_conversation_request_object
2459
- # @param [String] fields
2460
- # Selector specifying which fields to include in a partial response.
2461
- # @param [String] quota_user
2462
- # Available to use for quota purposes for server-side applications. Can be any
2463
- # arbitrary string assigned to a user, but should not exceed 40 characters.
2464
- # @param [Google::Apis::RequestOptions] options
2465
- # Request-specific options
2466
- #
2467
- # @yield [result, err] Result & error if block supplied
2468
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse] parsed result object
2469
- # @yieldparam err [StandardError] error object if request failed
2470
- #
2471
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse]
2472
- #
2473
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2474
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2475
- # @raise [Google::Apis::AuthorizationError] Authorization is required
2476
- def converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2477
- command = make_simple_command(:post, 'v1/{+name}:converse', options)
2478
- command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest::Representation
2479
- command.request_object = google_cloud_discoveryengine_v1_converse_conversation_request_object
2480
- command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse::Representation
2481
- command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse
2482
- command.params['name'] = name unless name.nil?
2483
- command.query['fields'] = fields unless fields.nil?
2484
- command.query['quotaUser'] = quota_user unless quota_user.nil?
2485
- execute_or_queue_command(command, &block)
2486
- end
2487
-
2488
- # Creates a Conversation. If the Conversation to create already exists, an
2489
- # ALREADY_EXISTS error is returned.
2941
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
2942
+ # request can be submitted to adjust this limit. If the Control to create
2943
+ # already exists, an ALREADY_EXISTS error is returned.
2490
2944
  # @param [String] parent
2491
2945
  # Required. Full resource name of parent data store. Format: `projects/`
2492
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2493
- # data_store_id``
2494
- # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation] google_cloud_discoveryengine_v1_conversation_object
2946
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
2947
+ # `data_store_id``
2948
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
2949
+ # @param [String] control_id
2950
+ # Required. The ID to use for the Control, which will become the final component
2951
+ # of the Control's resource name. This value must be within 1-63 characters.
2952
+ # Valid characters are /a-z-_/.
2495
2953
  # @param [String] fields
2496
2954
  # Selector specifying which fields to include in a partial response.
2497
2955
  # @param [String] quota_user
@@ -2501,32 +2959,33 @@ module Google
2501
2959
  # Request-specific options
2502
2960
  #
2503
2961
  # @yield [result, err] Result & error if block supplied
2504
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation] parsed result object
2962
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
2505
2963
  # @yieldparam err [StandardError] error object if request failed
2506
2964
  #
2507
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation]
2965
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
2508
2966
  #
2509
2967
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2510
2968
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2511
2969
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2512
- def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2513
- command = make_simple_command(:post, 'v1/{+parent}/conversations', options)
2514
- command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
2515
- command.request_object = google_cloud_discoveryengine_v1_conversation_object
2516
- command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
2517
- command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
2970
+ def create_project_location_collection_engine_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2971
+ command = make_simple_command(:post, 'v1/{+parent}/controls', options)
2972
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
2973
+ command.request_object = google_cloud_discoveryengine_v1_control_object
2974
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
2975
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
2518
2976
  command.params['parent'] = parent unless parent.nil?
2977
+ command.query['controlId'] = control_id unless control_id.nil?
2519
2978
  command.query['fields'] = fields unless fields.nil?
2520
2979
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2521
2980
  execute_or_queue_command(command, &block)
2522
2981
  end
2523
2982
 
2524
- # Deletes a Conversation. If the Conversation to delete does not exist, a
2525
- # NOT_FOUND error is returned.
2983
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
2984
+ # is returned.
2526
2985
  # @param [String] name
2527
- # Required. The resource name of the Conversation to delete. Format: `projects/`
2528
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2529
- # data_store_id`/conversations/`conversation_id``
2986
+ # Required. The resource name of the Control to delete. Format: `projects/`
2987
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
2988
+ # `data_store_id`/controls/`control_id``
2530
2989
  # @param [String] fields
2531
2990
  # Selector specifying which fields to include in a partial response.
2532
2991
  # @param [String] quota_user
@@ -2544,7 +3003,7 @@ module Google
2544
3003
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2545
3004
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2546
3005
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2547
- def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
3006
+ def delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
2548
3007
  command = make_simple_command(:delete, 'v1/{+name}', options)
2549
3008
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
2550
3009
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
@@ -2554,11 +3013,11 @@ module Google
2554
3013
  execute_or_queue_command(command, &block)
2555
3014
  end
2556
3015
 
2557
- # Gets a Conversation.
3016
+ # Gets a Control.
2558
3017
  # @param [String] name
2559
- # Required. The resource name of the Conversation to get. Format: `projects/`
2560
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2561
- # data_store_id`/conversations/`conversation_id``
3018
+ # Required. The resource name of the Control to get. Format: `projects/`
3019
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3020
+ # `data_store_id`/controls/`control_id``
2562
3021
  # @param [String] fields
2563
3022
  # Selector specifying which fields to include in a partial response.
2564
3023
  # @param [String] quota_user
@@ -2568,10 +3027,233 @@ module Google
2568
3027
  # Request-specific options
2569
3028
  #
2570
3029
  # @yield [result, err] Result & error if block supplied
2571
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation] parsed result object
3030
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
2572
3031
  # @yieldparam err [StandardError] error object if request failed
2573
3032
  #
2574
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation]
3033
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
3034
+ #
3035
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3036
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3037
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3038
+ def get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3039
+ command = make_simple_command(:get, 'v1/{+name}', options)
3040
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
3041
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
3042
+ command.params['name'] = name unless name.nil?
3043
+ command.query['fields'] = fields unless fields.nil?
3044
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3045
+ execute_or_queue_command(command, &block)
3046
+ end
3047
+
3048
+ # Lists all Controls by their parent DataStore.
3049
+ # @param [String] parent
3050
+ # Required. The data store resource name. Format: `projects/`project_number`/
3051
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3052
+ # @param [String] filter
3053
+ # Optional. A filter to apply on the list results. Supported features: * List
3054
+ # all the products under the parent branch if filter is unset. Currently this
3055
+ # field is unsupported.
3056
+ # @param [Fixnum] page_size
3057
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
3058
+ # Max allowed value is 1000.
3059
+ # @param [String] page_token
3060
+ # Optional. A page token, received from a previous `ListControls` call. Provide
3061
+ # this to retrieve the subsequent page.
3062
+ # @param [String] fields
3063
+ # Selector specifying which fields to include in a partial response.
3064
+ # @param [String] quota_user
3065
+ # Available to use for quota purposes for server-side applications. Can be any
3066
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3067
+ # @param [Google::Apis::RequestOptions] options
3068
+ # Request-specific options
3069
+ #
3070
+ # @yield [result, err] Result & error if block supplied
3071
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse] parsed result object
3072
+ # @yieldparam err [StandardError] error object if request failed
3073
+ #
3074
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse]
3075
+ #
3076
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3077
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3078
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3079
+ def list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3080
+ command = make_simple_command(:get, 'v1/{+parent}/controls', options)
3081
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
3082
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
3083
+ command.params['parent'] = parent unless parent.nil?
3084
+ command.query['filter'] = filter unless filter.nil?
3085
+ command.query['pageSize'] = page_size unless page_size.nil?
3086
+ command.query['pageToken'] = page_token unless page_token.nil?
3087
+ command.query['fields'] = fields unless fields.nil?
3088
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3089
+ execute_or_queue_command(command, &block)
3090
+ end
3091
+
3092
+ # Updates a Control. Control action type cannot be changed. If the Control to
3093
+ # update does not exist, a NOT_FOUND error is returned.
3094
+ # @param [String] name
3095
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
3096
+ # controls/*`
3097
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
3098
+ # @param [String] update_mask
3099
+ # Optional. Indicates which fields in the provided Control to update. The
3100
+ # following are NOT supported: * Control.name * Control.solution_type If not set
3101
+ # or empty, all supported fields are updated.
3102
+ # @param [String] fields
3103
+ # Selector specifying which fields to include in a partial response.
3104
+ # @param [String] quota_user
3105
+ # Available to use for quota purposes for server-side applications. Can be any
3106
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3107
+ # @param [Google::Apis::RequestOptions] options
3108
+ # Request-specific options
3109
+ #
3110
+ # @yield [result, err] Result & error if block supplied
3111
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
3112
+ # @yieldparam err [StandardError] error object if request failed
3113
+ #
3114
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
3115
+ #
3116
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3117
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3118
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3119
+ def patch_project_location_collection_engine_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3120
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3121
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
3122
+ command.request_object = google_cloud_discoveryengine_v1_control_object
3123
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
3124
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
3125
+ command.params['name'] = name unless name.nil?
3126
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3127
+ command.query['fields'] = fields unless fields.nil?
3128
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3129
+ execute_or_queue_command(command, &block)
3130
+ end
3131
+
3132
+ # Converses a conversation.
3133
+ # @param [String] name
3134
+ # Required. The resource name of the Conversation to get. Format: `projects/`
3135
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3136
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
3137
+ # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
3138
+ # conversations/-` to activate auto session mode, which automatically creates a
3139
+ # new conversation inside a ConverseConversation session.
3140
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest] google_cloud_discoveryengine_v1_converse_conversation_request_object
3141
+ # @param [String] fields
3142
+ # Selector specifying which fields to include in a partial response.
3143
+ # @param [String] quota_user
3144
+ # Available to use for quota purposes for server-side applications. Can be any
3145
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3146
+ # @param [Google::Apis::RequestOptions] options
3147
+ # Request-specific options
3148
+ #
3149
+ # @yield [result, err] Result & error if block supplied
3150
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse] parsed result object
3151
+ # @yieldparam err [StandardError] error object if request failed
3152
+ #
3153
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse]
3154
+ #
3155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3158
+ def converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3159
+ command = make_simple_command(:post, 'v1/{+name}:converse', options)
3160
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationRequest::Representation
3161
+ command.request_object = google_cloud_discoveryengine_v1_converse_conversation_request_object
3162
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse::Representation
3163
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ConverseConversationResponse
3164
+ command.params['name'] = name unless name.nil?
3165
+ command.query['fields'] = fields unless fields.nil?
3166
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3167
+ execute_or_queue_command(command, &block)
3168
+ end
3169
+
3170
+ # Creates a Conversation. If the Conversation to create already exists, an
3171
+ # ALREADY_EXISTS error is returned.
3172
+ # @param [String] parent
3173
+ # Required. Full resource name of parent data store. Format: `projects/`
3174
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3175
+ # data_store_id``
3176
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation] google_cloud_discoveryengine_v1_conversation_object
3177
+ # @param [String] fields
3178
+ # Selector specifying which fields to include in a partial response.
3179
+ # @param [String] quota_user
3180
+ # Available to use for quota purposes for server-side applications. Can be any
3181
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3182
+ # @param [Google::Apis::RequestOptions] options
3183
+ # Request-specific options
3184
+ #
3185
+ # @yield [result, err] Result & error if block supplied
3186
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation] parsed result object
3187
+ # @yieldparam err [StandardError] error object if request failed
3188
+ #
3189
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation]
3190
+ #
3191
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3192
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3193
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3194
+ def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3195
+ command = make_simple_command(:post, 'v1/{+parent}/conversations', options)
3196
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
3197
+ command.request_object = google_cloud_discoveryengine_v1_conversation_object
3198
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation::Representation
3199
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation
3200
+ command.params['parent'] = parent unless parent.nil?
3201
+ command.query['fields'] = fields unless fields.nil?
3202
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3203
+ execute_or_queue_command(command, &block)
3204
+ end
3205
+
3206
+ # Deletes a Conversation. If the Conversation to delete does not exist, a
3207
+ # NOT_FOUND error is returned.
3208
+ # @param [String] name
3209
+ # Required. The resource name of the Conversation to delete. Format: `projects/`
3210
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3211
+ # data_store_id`/conversations/`conversation_id``
3212
+ # @param [String] fields
3213
+ # Selector specifying which fields to include in a partial response.
3214
+ # @param [String] quota_user
3215
+ # Available to use for quota purposes for server-side applications. Can be any
3216
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3217
+ # @param [Google::Apis::RequestOptions] options
3218
+ # Request-specific options
3219
+ #
3220
+ # @yield [result, err] Result & error if block supplied
3221
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
3222
+ # @yieldparam err [StandardError] error object if request failed
3223
+ #
3224
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
3225
+ #
3226
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3227
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3228
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3229
+ def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
3230
+ command = make_simple_command(:delete, 'v1/{+name}', options)
3231
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
3232
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
3233
+ command.params['name'] = name unless name.nil?
3234
+ command.query['fields'] = fields unless fields.nil?
3235
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3236
+ execute_or_queue_command(command, &block)
3237
+ end
3238
+
3239
+ # Gets a Conversation.
3240
+ # @param [String] name
3241
+ # Required. The resource name of the Conversation to get. Format: `projects/`
3242
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3243
+ # data_store_id`/conversations/`conversation_id``
3244
+ # @param [String] fields
3245
+ # Selector specifying which fields to include in a partial response.
3246
+ # @param [String] quota_user
3247
+ # Available to use for quota purposes for server-side applications. Can be any
3248
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3249
+ # @param [Google::Apis::RequestOptions] options
3250
+ # Request-specific options
3251
+ #
3252
+ # @yield [result, err] Result & error if block supplied
3253
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation] parsed result object
3254
+ # @yieldparam err [StandardError] error object if request failed
3255
+ #
3256
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Conversation]
2575
3257
  #
2576
3258
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2577
3259
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
@@ -2746,16 +3428,54 @@ module Google
2746
3428
  execute_or_queue_command(command, &block)
2747
3429
  end
2748
3430
 
3431
+ # Answer query method.
3432
+ # @param [String] serving_config
3433
+ # Required. The resource name of the Search serving config, such as `projects/*/
3434
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
3435
+ # default_serving_config`, or `projects/*/locations/global/collections/
3436
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
3437
+ # field is used to identify the serving configuration name, set of models used
3438
+ # to make the search.
3439
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
3440
+ # @param [String] fields
3441
+ # Selector specifying which fields to include in a partial response.
3442
+ # @param [String] quota_user
3443
+ # Available to use for quota purposes for server-side applications. Can be any
3444
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3445
+ # @param [Google::Apis::RequestOptions] options
3446
+ # Request-specific options
3447
+ #
3448
+ # @yield [result, err] Result & error if block supplied
3449
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
3450
+ # @yieldparam err [StandardError] error object if request failed
3451
+ #
3452
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
3453
+ #
3454
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3455
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3456
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3457
+ def answer_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3458
+ command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
3459
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
3460
+ command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
3461
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
3462
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
3463
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
3464
+ command.query['fields'] = fields unless fields.nil?
3465
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3466
+ execute_or_queue_command(command, &block)
3467
+ end
3468
+
2749
3469
  # Makes a recommendation, which requires a contextual user event.
2750
3470
  # @param [String] serving_config
2751
3471
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
2752
3472
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
2753
3473
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
2754
- # created along with your recommendation engine creation. The engine ID will be
2755
- # used as the ID of the default serving config. For example, for Engine `
2756
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
2757
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
2758
- # engine` for your RecommendationService.Recommend requests.
3474
+ # created along with your recommendation engine creation. The engine ID is used
3475
+ # as the ID of the default serving config. For example, for Engine `projects/*/
3476
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
3477
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
3478
+ # your RecommendationService.Recommend requests.
2759
3479
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest] google_cloud_discoveryengine_v1_recommend_request_object
2760
3480
  # @param [String] fields
2761
3481
  # Selector specifying which fields to include in a partial response.
@@ -2824,6 +3544,227 @@ module Google
2824
3544
  execute_or_queue_command(command, &block)
2825
3545
  end
2826
3546
 
3547
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
3548
+ # error is returned.
3549
+ # @param [String] parent
3550
+ # Required. Full resource name of parent data store. Format: `projects/`
3551
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3552
+ # data_store_id``
3553
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
3554
+ # @param [String] fields
3555
+ # Selector specifying which fields to include in a partial response.
3556
+ # @param [String] quota_user
3557
+ # Available to use for quota purposes for server-side applications. Can be any
3558
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3559
+ # @param [Google::Apis::RequestOptions] options
3560
+ # Request-specific options
3561
+ #
3562
+ # @yield [result, err] Result & error if block supplied
3563
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
3564
+ # @yieldparam err [StandardError] error object if request failed
3565
+ #
3566
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
3567
+ #
3568
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3569
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3570
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3571
+ def create_project_location_collection_engine_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3572
+ command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
3573
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
3574
+ command.request_object = google_cloud_discoveryengine_v1_session_object
3575
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
3576
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
3577
+ command.params['parent'] = parent unless parent.nil?
3578
+ command.query['fields'] = fields unless fields.nil?
3579
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3580
+ execute_or_queue_command(command, &block)
3581
+ end
3582
+
3583
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
3584
+ # is returned.
3585
+ # @param [String] name
3586
+ # Required. The resource name of the Session to delete. Format: `projects/`
3587
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3588
+ # data_store_id`/sessions/`session_id``
3589
+ # @param [String] fields
3590
+ # Selector specifying which fields to include in a partial response.
3591
+ # @param [String] quota_user
3592
+ # Available to use for quota purposes for server-side applications. Can be any
3593
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3594
+ # @param [Google::Apis::RequestOptions] options
3595
+ # Request-specific options
3596
+ #
3597
+ # @yield [result, err] Result & error if block supplied
3598
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
3599
+ # @yieldparam err [StandardError] error object if request failed
3600
+ #
3601
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
3602
+ #
3603
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3604
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3605
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3606
+ def delete_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
3607
+ command = make_simple_command(:delete, 'v1/{+name}', options)
3608
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
3609
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
3610
+ command.params['name'] = name unless name.nil?
3611
+ command.query['fields'] = fields unless fields.nil?
3612
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3613
+ execute_or_queue_command(command, &block)
3614
+ end
3615
+
3616
+ # Gets a Session.
3617
+ # @param [String] name
3618
+ # Required. The resource name of the Session to get. Format: `projects/`
3619
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3620
+ # data_store_id`/sessions/`session_id``
3621
+ # @param [String] fields
3622
+ # Selector specifying which fields to include in a partial response.
3623
+ # @param [String] quota_user
3624
+ # Available to use for quota purposes for server-side applications. Can be any
3625
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3626
+ # @param [Google::Apis::RequestOptions] options
3627
+ # Request-specific options
3628
+ #
3629
+ # @yield [result, err] Result & error if block supplied
3630
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
3631
+ # @yieldparam err [StandardError] error object if request failed
3632
+ #
3633
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
3634
+ #
3635
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3636
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3637
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3638
+ def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
3639
+ command = make_simple_command(:get, 'v1/{+name}', options)
3640
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
3641
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
3642
+ command.params['name'] = name unless name.nil?
3643
+ command.query['fields'] = fields unless fields.nil?
3644
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3645
+ execute_or_queue_command(command, &block)
3646
+ end
3647
+
3648
+ # Lists all Sessions by their parent DataStore.
3649
+ # @param [String] parent
3650
+ # Required. The data store resource name. Format: `projects/`project_number`/
3651
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
3652
+ # @param [String] filter
3653
+ # A filter to apply on the list results. The supported features are:
3654
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
3655
+ # @param [String] order_by
3656
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
3657
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
3658
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
3659
+ # @param [Fixnum] page_size
3660
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
3661
+ # allowed value is 1000.
3662
+ # @param [String] page_token
3663
+ # A page token, received from a previous `ListSessions` call. Provide this to
3664
+ # retrieve the subsequent page.
3665
+ # @param [String] fields
3666
+ # Selector specifying which fields to include in a partial response.
3667
+ # @param [String] quota_user
3668
+ # Available to use for quota purposes for server-side applications. Can be any
3669
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3670
+ # @param [Google::Apis::RequestOptions] options
3671
+ # Request-specific options
3672
+ #
3673
+ # @yield [result, err] Result & error if block supplied
3674
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse] parsed result object
3675
+ # @yieldparam err [StandardError] error object if request failed
3676
+ #
3677
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse]
3678
+ #
3679
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3680
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3681
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3682
+ def list_project_location_collection_engine_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3683
+ command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
3684
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
3685
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
3686
+ command.params['parent'] = parent unless parent.nil?
3687
+ command.query['filter'] = filter unless filter.nil?
3688
+ command.query['orderBy'] = order_by unless order_by.nil?
3689
+ command.query['pageSize'] = page_size unless page_size.nil?
3690
+ command.query['pageToken'] = page_token unless page_token.nil?
3691
+ command.query['fields'] = fields unless fields.nil?
3692
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3693
+ execute_or_queue_command(command, &block)
3694
+ end
3695
+
3696
+ # Updates a Session. Session action type cannot be changed. If the Session to
3697
+ # update does not exist, a NOT_FOUND error is returned.
3698
+ # @param [String] name
3699
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
3700
+ # collections/`collection`/engines/`engine`/sessions/*`
3701
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
3702
+ # @param [String] update_mask
3703
+ # Indicates which fields in the provided Session to update. The following are
3704
+ # NOT supported: * Session.name If not set or empty, all supported fields are
3705
+ # updated.
3706
+ # @param [String] fields
3707
+ # Selector specifying which fields to include in a partial response.
3708
+ # @param [String] quota_user
3709
+ # Available to use for quota purposes for server-side applications. Can be any
3710
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3711
+ # @param [Google::Apis::RequestOptions] options
3712
+ # Request-specific options
3713
+ #
3714
+ # @yield [result, err] Result & error if block supplied
3715
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
3716
+ # @yieldparam err [StandardError] error object if request failed
3717
+ #
3718
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
3719
+ #
3720
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3721
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3722
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3723
+ def patch_project_location_collection_engine_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3724
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3725
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
3726
+ command.request_object = google_cloud_discoveryengine_v1_session_object
3727
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
3728
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
3729
+ command.params['name'] = name unless name.nil?
3730
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3731
+ command.query['fields'] = fields unless fields.nil?
3732
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3733
+ execute_or_queue_command(command, &block)
3734
+ end
3735
+
3736
+ # Gets a Answer.
3737
+ # @param [String] name
3738
+ # Required. The resource name of the Answer to get. Format: `projects/`
3739
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
3740
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
3741
+ # @param [String] fields
3742
+ # Selector specifying which fields to include in a partial response.
3743
+ # @param [String] quota_user
3744
+ # Available to use for quota purposes for server-side applications. Can be any
3745
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3746
+ # @param [Google::Apis::RequestOptions] options
3747
+ # Request-specific options
3748
+ #
3749
+ # @yield [result, err] Result & error if block supplied
3750
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer] parsed result object
3751
+ # @yieldparam err [StandardError] error object if request failed
3752
+ #
3753
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
3754
+ #
3755
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3756
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3757
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3758
+ def get_project_location_collection_engine_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
3759
+ command = make_simple_command(:get, 'v1/{+name}', options)
3760
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
3761
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
3762
+ command.params['name'] = name unless name.nil?
3763
+ command.query['fields'] = fields unless fields.nil?
3764
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3765
+ execute_or_queue_command(command, &block)
3766
+ end
3767
+
2827
3768
  # Gets the latest state of a long-running operation. Clients can use this method
2828
3769
  # to poll the operation result at intervals as recommended by the API service.
2829
3770
  # @param [String] name
@@ -3115,8 +4056,8 @@ module Google
3115
4056
  # permission to list DataStores under this location, regardless of whether or
3116
4057
  # not this data store exists, a PERMISSION_DENIED error is returned.
3117
4058
  # @param [String] filter
3118
- # Filter by solution type . For example: filter = 'solution_type:
3119
- # SOLUTION_TYPE_SEARCH'
4059
+ # Filter by solution type . For example: `filter = 'solution_type:
4060
+ # SOLUTION_TYPE_SEARCH'`
3120
4061
  # @param [Fixnum] page_size
3121
4062
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
3122
4063
  # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
@@ -3203,14 +4144,14 @@ module Google
3203
4144
  # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
3204
4145
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
3205
4146
  # @param [String] document_id
3206
- # Required. The ID to use for the Document, which will become the final
3207
- # component of the Document.name. If the caller does not have permission to
3208
- # create the Document, regardless of whether or not it exists, a `
3209
- # PERMISSION_DENIED` error is returned. This field must be unique among all
3210
- # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
3211
- # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
3212
- # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
3213
- # INVALID_ARGUMENT` error is returned.
4147
+ # Required. The ID to use for the Document, which becomes the final component of
4148
+ # the Document.name. If the caller does not have permission to create the
4149
+ # Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
4150
+ # is returned. This field must be unique among all Documents with the same
4151
+ # parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
4152
+ # conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
4153
+ # length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
4154
+ # returned.
3214
4155
  # @param [String] fields
3215
4156
  # Selector specifying which fields to include in a partial response.
3216
4157
  # @param [String] quota_user
@@ -3312,8 +4253,8 @@ module Google
3312
4253
  end
3313
4254
 
3314
4255
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
3315
- # existing items will be created. Note: It is possible for a subset of the
3316
- # Documents to be successfully updated.
4256
+ # existing items are created. Note: It is possible for a subset of the Documents
4257
+ # to be successfully updated.
3317
4258
  # @param [String] parent
3318
4259
  # Required. The parent branch resource name, such as `projects/`project`/
3319
4260
  # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -3358,8 +4299,8 @@ module Google
3358
4299
  # PERMISSION_DENIED` error is returned.
3359
4300
  # @param [Fixnum] page_size
3360
4301
  # Maximum number of Documents to return. If unspecified, defaults to 100. The
3361
- # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
3362
- # this field is negative, an `INVALID_ARGUMENT` error is returned.
4302
+ # maximum allowed value is 1000. Values above 1000 are set to 1000. If this
4303
+ # field is negative, an `INVALID_ARGUMENT` error is returned.
3363
4304
  # @param [String] page_token
3364
4305
  # A page token ListDocumentsResponse.next_page_token, received from a previous
3365
4306
  # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -3403,10 +4344,10 @@ module Google
3403
4344
  # with a length limit of 1024 characters.
3404
4345
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
3405
4346
  # @param [Boolean] allow_missing
3406
- # If set to true, and the Document is not found, a new Document will be created.
4347
+ # If set to `true` and the Document is not found, a new Document is be created.
3407
4348
  # @param [String] update_mask
3408
4349
  # Indicates which fields in the provided imported 'document' to update. If not
3409
- # set, will by default update all fields.
4350
+ # set, by default updates all fields.
3410
4351
  # @param [String] fields
3411
4352
  # Selector specifying which fields to include in a partial response.
3412
4353
  # @param [String] quota_user
@@ -3530,34 +4471,185 @@ module Google
3530
4471
  # Request-specific options
3531
4472
  #
3532
4473
  # @yield [result, err] Result & error if block supplied
3533
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
4474
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
4475
+ # @yieldparam err [StandardError] error object if request failed
4476
+ #
4477
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
4478
+ #
4479
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4480
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4481
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4482
+ def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
4483
+ command = make_simple_command(:get, 'v1/{+name}', options)
4484
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
4485
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
4486
+ command.params['name'] = name unless name.nil?
4487
+ command.query['fields'] = fields unless fields.nil?
4488
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4489
+ execute_or_queue_command(command, &block)
4490
+ end
4491
+
4492
+ # Lists operations that match the specified filter in the request. If the server
4493
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
4494
+ # @param [String] name
4495
+ # The name of the operation's parent resource.
4496
+ # @param [String] filter
4497
+ # The standard list filter.
4498
+ # @param [Fixnum] page_size
4499
+ # The standard list page size.
4500
+ # @param [String] page_token
4501
+ # The standard list page token.
4502
+ # @param [String] fields
4503
+ # Selector specifying which fields to include in a partial response.
4504
+ # @param [String] quota_user
4505
+ # Available to use for quota purposes for server-side applications. Can be any
4506
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4507
+ # @param [Google::Apis::RequestOptions] options
4508
+ # Request-specific options
4509
+ #
4510
+ # @yield [result, err] Result & error if block supplied
4511
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse] parsed result object
4512
+ # @yieldparam err [StandardError] error object if request failed
4513
+ #
4514
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse]
4515
+ #
4516
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4517
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4518
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4519
+ def list_project_location_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4520
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
4521
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
4522
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
4523
+ command.params['name'] = name unless name.nil?
4524
+ command.query['filter'] = filter unless filter.nil?
4525
+ command.query['pageSize'] = page_size unless page_size.nil?
4526
+ command.query['pageToken'] = page_token unless page_token.nil?
4527
+ command.query['fields'] = fields unless fields.nil?
4528
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4529
+ execute_or_queue_command(command, &block)
4530
+ end
4531
+
4532
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
4533
+ # request can be submitted to adjust this limit. If the Control to create
4534
+ # already exists, an ALREADY_EXISTS error is returned.
4535
+ # @param [String] parent
4536
+ # Required. Full resource name of parent data store. Format: `projects/`
4537
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4538
+ # `data_store_id``
4539
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
4540
+ # @param [String] control_id
4541
+ # Required. The ID to use for the Control, which will become the final component
4542
+ # of the Control's resource name. This value must be within 1-63 characters.
4543
+ # Valid characters are /a-z-_/.
4544
+ # @param [String] fields
4545
+ # Selector specifying which fields to include in a partial response.
4546
+ # @param [String] quota_user
4547
+ # Available to use for quota purposes for server-side applications. Can be any
4548
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4549
+ # @param [Google::Apis::RequestOptions] options
4550
+ # Request-specific options
4551
+ #
4552
+ # @yield [result, err] Result & error if block supplied
4553
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
4554
+ # @yieldparam err [StandardError] error object if request failed
4555
+ #
4556
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
4557
+ #
4558
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4559
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4560
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4561
+ def create_project_location_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4562
+ command = make_simple_command(:post, 'v1/{+parent}/controls', options)
4563
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4564
+ command.request_object = google_cloud_discoveryengine_v1_control_object
4565
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4566
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
4567
+ command.params['parent'] = parent unless parent.nil?
4568
+ command.query['controlId'] = control_id unless control_id.nil?
4569
+ command.query['fields'] = fields unless fields.nil?
4570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4571
+ execute_or_queue_command(command, &block)
4572
+ end
4573
+
4574
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
4575
+ # is returned.
4576
+ # @param [String] name
4577
+ # Required. The resource name of the Control to delete. Format: `projects/`
4578
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4579
+ # `data_store_id`/controls/`control_id``
4580
+ # @param [String] fields
4581
+ # Selector specifying which fields to include in a partial response.
4582
+ # @param [String] quota_user
4583
+ # Available to use for quota purposes for server-side applications. Can be any
4584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4585
+ # @param [Google::Apis::RequestOptions] options
4586
+ # Request-specific options
4587
+ #
4588
+ # @yield [result, err] Result & error if block supplied
4589
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
4590
+ # @yieldparam err [StandardError] error object if request failed
4591
+ #
4592
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
4593
+ #
4594
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4595
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4596
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4597
+ def delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
4598
+ command = make_simple_command(:delete, 'v1/{+name}', options)
4599
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
4600
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
4601
+ command.params['name'] = name unless name.nil?
4602
+ command.query['fields'] = fields unless fields.nil?
4603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4604
+ execute_or_queue_command(command, &block)
4605
+ end
4606
+
4607
+ # Gets a Control.
4608
+ # @param [String] name
4609
+ # Required. The resource name of the Control to get. Format: `projects/`
4610
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4611
+ # `data_store_id`/controls/`control_id``
4612
+ # @param [String] fields
4613
+ # Selector specifying which fields to include in a partial response.
4614
+ # @param [String] quota_user
4615
+ # Available to use for quota purposes for server-side applications. Can be any
4616
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4617
+ # @param [Google::Apis::RequestOptions] options
4618
+ # Request-specific options
4619
+ #
4620
+ # @yield [result, err] Result & error if block supplied
4621
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
3534
4622
  # @yieldparam err [StandardError] error object if request failed
3535
4623
  #
3536
- # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
4624
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
3537
4625
  #
3538
4626
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3539
4627
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3540
4628
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3541
- def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
4629
+ def get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
3542
4630
  command = make_simple_command(:get, 'v1/{+name}', options)
3543
- command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
3544
- command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
4631
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4632
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
3545
4633
  command.params['name'] = name unless name.nil?
3546
4634
  command.query['fields'] = fields unless fields.nil?
3547
4635
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3548
4636
  execute_or_queue_command(command, &block)
3549
4637
  end
3550
4638
 
3551
- # Lists operations that match the specified filter in the request. If the server
3552
- # doesn't support this method, it returns `UNIMPLEMENTED`.
3553
- # @param [String] name
3554
- # The name of the operation's parent resource.
4639
+ # Lists all Controls by their parent DataStore.
4640
+ # @param [String] parent
4641
+ # Required. The data store resource name. Format: `projects/`project_number`/
4642
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3555
4643
  # @param [String] filter
3556
- # The standard list filter.
4644
+ # Optional. A filter to apply on the list results. Supported features: * List
4645
+ # all the products under the parent branch if filter is unset. Currently this
4646
+ # field is unsupported.
3557
4647
  # @param [Fixnum] page_size
3558
- # The standard list page size.
4648
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
4649
+ # Max allowed value is 1000.
3559
4650
  # @param [String] page_token
3560
- # The standard list page token.
4651
+ # Optional. A page token, received from a previous `ListControls` call. Provide
4652
+ # this to retrieve the subsequent page.
3561
4653
  # @param [String] fields
3562
4654
  # Selector specifying which fields to include in a partial response.
3563
4655
  # @param [String] quota_user
@@ -3567,19 +4659,19 @@ module Google
3567
4659
  # Request-specific options
3568
4660
  #
3569
4661
  # @yield [result, err] Result & error if block supplied
3570
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse] parsed result object
4662
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse] parsed result object
3571
4663
  # @yieldparam err [StandardError] error object if request failed
3572
4664
  #
3573
- # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse]
4665
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse]
3574
4666
  #
3575
4667
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3576
4668
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3577
4669
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3578
- def list_project_location_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3579
- command = make_simple_command(:get, 'v1/{+name}/operations', options)
3580
- command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
3581
- command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
3582
- command.params['name'] = name unless name.nil?
4670
+ def list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4671
+ command = make_simple_command(:get, 'v1/{+parent}/controls', options)
4672
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
4673
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
4674
+ command.params['parent'] = parent unless parent.nil?
3583
4675
  command.query['filter'] = filter unless filter.nil?
3584
4676
  command.query['pageSize'] = page_size unless page_size.nil?
3585
4677
  command.query['pageToken'] = page_token unless page_token.nil?
@@ -3588,6 +4680,46 @@ module Google
3588
4680
  execute_or_queue_command(command, &block)
3589
4681
  end
3590
4682
 
4683
+ # Updates a Control. Control action type cannot be changed. If the Control to
4684
+ # update does not exist, a NOT_FOUND error is returned.
4685
+ # @param [String] name
4686
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
4687
+ # controls/*`
4688
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
4689
+ # @param [String] update_mask
4690
+ # Optional. Indicates which fields in the provided Control to update. The
4691
+ # following are NOT supported: * Control.name * Control.solution_type If not set
4692
+ # or empty, all supported fields are updated.
4693
+ # @param [String] fields
4694
+ # Selector specifying which fields to include in a partial response.
4695
+ # @param [String] quota_user
4696
+ # Available to use for quota purposes for server-side applications. Can be any
4697
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4698
+ # @param [Google::Apis::RequestOptions] options
4699
+ # Request-specific options
4700
+ #
4701
+ # @yield [result, err] Result & error if block supplied
4702
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
4703
+ # @yieldparam err [StandardError] error object if request failed
4704
+ #
4705
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
4706
+ #
4707
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4708
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4709
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4710
+ def patch_project_location_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4711
+ command = make_simple_command(:patch, 'v1/{+name}', options)
4712
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4713
+ command.request_object = google_cloud_discoveryengine_v1_control_object
4714
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4715
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
4716
+ command.params['name'] = name unless name.nil?
4717
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4718
+ command.query['fields'] = fields unless fields.nil?
4719
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4720
+ execute_or_queue_command(command, &block)
4721
+ end
4722
+
3591
4723
  # Converses a conversation.
3592
4724
  # @param [String] name
3593
4725
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -3965,8 +5097,8 @@ module Google
3965
5097
  # .
3966
5098
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
3967
5099
  # @param [String] schema_id
3968
- # Required. The ID to use for the Schema, which will become the final component
3969
- # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
5100
+ # Required. The ID to use for the Schema, which becomes the final component of
5101
+ # the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
3970
5102
  # org/html/rfc1034) standard with a length limit of 63 characters.
3971
5103
  # @param [String] fields
3972
5104
  # Selector specifying which fields to include in a partial response.
@@ -4069,8 +5201,8 @@ module Google
4069
5201
  # .
4070
5202
  # @param [Fixnum] page_size
4071
5203
  # The maximum number of Schemas to return. The service may return fewer than
4072
- # this value. If unspecified, at most 100 Schemas will be returned. The maximum
4073
- # value is 1000; values above 1000 will be coerced to 1000.
5204
+ # this value. If unspecified, at most 100 Schemas are returned. The maximum
5205
+ # value is 1000; values above 1000 are set to 1000.
4074
5206
  # @param [String] page_token
4075
5207
  # A page token, received from a previous SchemaService.ListSchemas call. Provide
4076
5208
  # this to retrieve the subsequent page. When paginating, all other parameters
@@ -4113,8 +5245,8 @@ module Google
4113
5245
  # limit of 1024 characters.
4114
5246
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
4115
5247
  # @param [Boolean] allow_missing
4116
- # If set to true, and the Schema is not found, a new Schema will be created. In
4117
- # this situation, `update_mask` is ignored.
5248
+ # If set to true, and the Schema is not found, a new Schema is created. In this
5249
+ # situation, `update_mask` is ignored.
4118
5250
  # @param [String] fields
4119
5251
  # Selector specifying which fields to include in a partial response.
4120
5252
  # @param [String] quota_user
@@ -4145,16 +5277,54 @@ module Google
4145
5277
  execute_or_queue_command(command, &block)
4146
5278
  end
4147
5279
 
5280
+ # Answer query method.
5281
+ # @param [String] serving_config
5282
+ # Required. The resource name of the Search serving config, such as `projects/*/
5283
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
5284
+ # default_serving_config`, or `projects/*/locations/global/collections/
5285
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
5286
+ # field is used to identify the serving configuration name, set of models used
5287
+ # to make the search.
5288
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
5289
+ # @param [String] fields
5290
+ # Selector specifying which fields to include in a partial response.
5291
+ # @param [String] quota_user
5292
+ # Available to use for quota purposes for server-side applications. Can be any
5293
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5294
+ # @param [Google::Apis::RequestOptions] options
5295
+ # Request-specific options
5296
+ #
5297
+ # @yield [result, err] Result & error if block supplied
5298
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
5299
+ # @yieldparam err [StandardError] error object if request failed
5300
+ #
5301
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
5302
+ #
5303
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5304
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5305
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5306
+ def answer_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5307
+ command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
5308
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
5309
+ command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
5310
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
5311
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
5312
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
5313
+ command.query['fields'] = fields unless fields.nil?
5314
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5315
+ execute_or_queue_command(command, &block)
5316
+ end
5317
+
4148
5318
  # Makes a recommendation, which requires a contextual user event.
4149
5319
  # @param [String] serving_config
4150
5320
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
4151
5321
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
4152
5322
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
4153
- # created along with your recommendation engine creation. The engine ID will be
4154
- # used as the ID of the default serving config. For example, for Engine `
4155
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
4156
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
4157
- # engine` for your RecommendationService.Recommend requests.
5323
+ # created along with your recommendation engine creation. The engine ID is used
5324
+ # as the ID of the default serving config. For example, for Engine `projects/*/
5325
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
5326
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
5327
+ # your RecommendationService.Recommend requests.
4158
5328
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest] google_cloud_discoveryengine_v1_recommend_request_object
4159
5329
  # @param [String] fields
4160
5330
  # Selector specifying which fields to include in a partial response.
@@ -4223,6 +5393,227 @@ module Google
4223
5393
  execute_or_queue_command(command, &block)
4224
5394
  end
4225
5395
 
5396
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
5397
+ # error is returned.
5398
+ # @param [String] parent
5399
+ # Required. Full resource name of parent data store. Format: `projects/`
5400
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5401
+ # data_store_id``
5402
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
5403
+ # @param [String] fields
5404
+ # Selector specifying which fields to include in a partial response.
5405
+ # @param [String] quota_user
5406
+ # Available to use for quota purposes for server-side applications. Can be any
5407
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5408
+ # @param [Google::Apis::RequestOptions] options
5409
+ # Request-specific options
5410
+ #
5411
+ # @yield [result, err] Result & error if block supplied
5412
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
5413
+ # @yieldparam err [StandardError] error object if request failed
5414
+ #
5415
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
5416
+ #
5417
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5418
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5419
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5420
+ def create_project_location_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5421
+ command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
5422
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
5423
+ command.request_object = google_cloud_discoveryengine_v1_session_object
5424
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
5425
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
5426
+ command.params['parent'] = parent unless parent.nil?
5427
+ command.query['fields'] = fields unless fields.nil?
5428
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5429
+ execute_or_queue_command(command, &block)
5430
+ end
5431
+
5432
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
5433
+ # is returned.
5434
+ # @param [String] name
5435
+ # Required. The resource name of the Session to delete. Format: `projects/`
5436
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5437
+ # data_store_id`/sessions/`session_id``
5438
+ # @param [String] fields
5439
+ # Selector specifying which fields to include in a partial response.
5440
+ # @param [String] quota_user
5441
+ # Available to use for quota purposes for server-side applications. Can be any
5442
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5443
+ # @param [Google::Apis::RequestOptions] options
5444
+ # Request-specific options
5445
+ #
5446
+ # @yield [result, err] Result & error if block supplied
5447
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
5448
+ # @yieldparam err [StandardError] error object if request failed
5449
+ #
5450
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
5451
+ #
5452
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5453
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5454
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5455
+ def delete_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
5456
+ command = make_simple_command(:delete, 'v1/{+name}', options)
5457
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
5458
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
5459
+ command.params['name'] = name unless name.nil?
5460
+ command.query['fields'] = fields unless fields.nil?
5461
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5462
+ execute_or_queue_command(command, &block)
5463
+ end
5464
+
5465
+ # Gets a Session.
5466
+ # @param [String] name
5467
+ # Required. The resource name of the Session to get. Format: `projects/`
5468
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5469
+ # data_store_id`/sessions/`session_id``
5470
+ # @param [String] fields
5471
+ # Selector specifying which fields to include in a partial response.
5472
+ # @param [String] quota_user
5473
+ # Available to use for quota purposes for server-side applications. Can be any
5474
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5475
+ # @param [Google::Apis::RequestOptions] options
5476
+ # Request-specific options
5477
+ #
5478
+ # @yield [result, err] Result & error if block supplied
5479
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
5480
+ # @yieldparam err [StandardError] error object if request failed
5481
+ #
5482
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
5483
+ #
5484
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5485
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5486
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5487
+ def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
5488
+ command = make_simple_command(:get, 'v1/{+name}', options)
5489
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
5490
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
5491
+ command.params['name'] = name unless name.nil?
5492
+ command.query['fields'] = fields unless fields.nil?
5493
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5494
+ execute_or_queue_command(command, &block)
5495
+ end
5496
+
5497
+ # Lists all Sessions by their parent DataStore.
5498
+ # @param [String] parent
5499
+ # Required. The data store resource name. Format: `projects/`project_number`/
5500
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
5501
+ # @param [String] filter
5502
+ # A filter to apply on the list results. The supported features are:
5503
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
5504
+ # @param [String] order_by
5505
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
5506
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
5507
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
5508
+ # @param [Fixnum] page_size
5509
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
5510
+ # allowed value is 1000.
5511
+ # @param [String] page_token
5512
+ # A page token, received from a previous `ListSessions` call. Provide this to
5513
+ # retrieve the subsequent page.
5514
+ # @param [String] fields
5515
+ # Selector specifying which fields to include in a partial response.
5516
+ # @param [String] quota_user
5517
+ # Available to use for quota purposes for server-side applications. Can be any
5518
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5519
+ # @param [Google::Apis::RequestOptions] options
5520
+ # Request-specific options
5521
+ #
5522
+ # @yield [result, err] Result & error if block supplied
5523
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse] parsed result object
5524
+ # @yieldparam err [StandardError] error object if request failed
5525
+ #
5526
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse]
5527
+ #
5528
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5529
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5530
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5531
+ def list_project_location_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5532
+ command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
5533
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
5534
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
5535
+ command.params['parent'] = parent unless parent.nil?
5536
+ command.query['filter'] = filter unless filter.nil?
5537
+ command.query['orderBy'] = order_by unless order_by.nil?
5538
+ command.query['pageSize'] = page_size unless page_size.nil?
5539
+ command.query['pageToken'] = page_token unless page_token.nil?
5540
+ command.query['fields'] = fields unless fields.nil?
5541
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5542
+ execute_or_queue_command(command, &block)
5543
+ end
5544
+
5545
+ # Updates a Session. Session action type cannot be changed. If the Session to
5546
+ # update does not exist, a NOT_FOUND error is returned.
5547
+ # @param [String] name
5548
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
5549
+ # collections/`collection`/engines/`engine`/sessions/*`
5550
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
5551
+ # @param [String] update_mask
5552
+ # Indicates which fields in the provided Session to update. The following are
5553
+ # NOT supported: * Session.name If not set or empty, all supported fields are
5554
+ # updated.
5555
+ # @param [String] fields
5556
+ # Selector specifying which fields to include in a partial response.
5557
+ # @param [String] quota_user
5558
+ # Available to use for quota purposes for server-side applications. Can be any
5559
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5560
+ # @param [Google::Apis::RequestOptions] options
5561
+ # Request-specific options
5562
+ #
5563
+ # @yield [result, err] Result & error if block supplied
5564
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
5565
+ # @yieldparam err [StandardError] error object if request failed
5566
+ #
5567
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
5568
+ #
5569
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5570
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5571
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5572
+ def patch_project_location_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5573
+ command = make_simple_command(:patch, 'v1/{+name}', options)
5574
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
5575
+ command.request_object = google_cloud_discoveryengine_v1_session_object
5576
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
5577
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
5578
+ command.params['name'] = name unless name.nil?
5579
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5580
+ command.query['fields'] = fields unless fields.nil?
5581
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5582
+ execute_or_queue_command(command, &block)
5583
+ end
5584
+
5585
+ # Gets a Answer.
5586
+ # @param [String] name
5587
+ # Required. The resource name of the Answer to get. Format: `projects/`
5588
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
5589
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
5590
+ # @param [String] fields
5591
+ # Selector specifying which fields to include in a partial response.
5592
+ # @param [String] quota_user
5593
+ # Available to use for quota purposes for server-side applications. Can be any
5594
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5595
+ # @param [Google::Apis::RequestOptions] options
5596
+ # Request-specific options
5597
+ #
5598
+ # @yield [result, err] Result & error if block supplied
5599
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer] parsed result object
5600
+ # @yieldparam err [StandardError] error object if request failed
5601
+ #
5602
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
5603
+ #
5604
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5605
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5606
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5607
+ def get_project_location_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
5608
+ command = make_simple_command(:get, 'v1/{+name}', options)
5609
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
5610
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
5611
+ command.params['name'] = name unless name.nil?
5612
+ command.query['fields'] = fields unless fields.nil?
5613
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5614
+ execute_or_queue_command(command, &block)
5615
+ end
5616
+
4226
5617
  # Downgrade from advanced site search to basic site search.
4227
5618
  # @param [String] site_search_engine
4228
5619
  # Required. Full resource name of the SiteSearchEngine, such as `projects/`
@@ -4663,7 +6054,7 @@ module Google
4663
6054
  execute_or_queue_command(command, &block)
4664
6055
  end
4665
6056
 
4666
- # Bulk import of User events. Request processing might be synchronous. Events
6057
+ # Bulk import of user events. Request processing might be synchronous. Events
4667
6058
  # that already exist are skipped. Use this method for backfilling historical
4668
6059
  # user events. Operation.response is of type ImportResponse. Note that it is
4669
6060
  # possible for a subset of the items to be successfully inserted. Operation.
@@ -4710,6 +6101,9 @@ module Google
4710
6101
  # across multiple DataStore, the format is: `projects/`project`/locations/`
4711
6102
  # location``.
4712
6103
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent] google_cloud_discoveryengine_v1_user_event_object
6104
+ # @param [Boolean] write_async
6105
+ # If set to true, the user event is written asynchronously after validation, and
6106
+ # the API responds without waiting for the write.
4713
6107
  # @param [String] fields
4714
6108
  # Selector specifying which fields to include in a partial response.
4715
6109
  # @param [String] quota_user
@@ -4727,13 +6121,14 @@ module Google
4727
6121
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4728
6122
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4729
6123
  # @raise [Google::Apis::AuthorizationError] Authorization is required
4730
- def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6124
+ def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
4731
6125
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
4732
6126
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
4733
6127
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
4734
6128
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
4735
6129
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
4736
6130
  command.params['parent'] = parent unless parent.nil?
6131
+ command.query['writeAsync'] = write_async unless write_async.nil?
4737
6132
  command.query['fields'] = fields unless fields.nil?
4738
6133
  command.query['quotaUser'] = quota_user unless quota_user.nil?
4739
6134
  execute_or_queue_command(command, &block)
@@ -4844,6 +6239,40 @@ module Google
4844
6239
  execute_or_queue_command(command, &block)
4845
6240
  end
4846
6241
 
6242
+ # Ranks a list of text records based on the given input query.
6243
+ # @param [String] ranking_config
6244
+ # Required. The resource name of the rank service config, such as `projects/`
6245
+ # project_num`/locations/`location_id`/rankingConfigs/default_ranking_config`.
6246
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankRequest] google_cloud_discoveryengine_v1_rank_request_object
6247
+ # @param [String] fields
6248
+ # Selector specifying which fields to include in a partial response.
6249
+ # @param [String] quota_user
6250
+ # Available to use for quota purposes for server-side applications. Can be any
6251
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6252
+ # @param [Google::Apis::RequestOptions] options
6253
+ # Request-specific options
6254
+ #
6255
+ # @yield [result, err] Result & error if block supplied
6256
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse] parsed result object
6257
+ # @yieldparam err [StandardError] error object if request failed
6258
+ #
6259
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse]
6260
+ #
6261
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6262
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6263
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6264
+ def rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1_rank_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6265
+ command = make_simple_command(:post, 'v1/{+rankingConfig}:rank', options)
6266
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankRequest::Representation
6267
+ command.request_object = google_cloud_discoveryengine_v1_rank_request_object
6268
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse::Representation
6269
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse
6270
+ command.params['rankingConfig'] = ranking_config unless ranking_config.nil?
6271
+ command.query['fields'] = fields unless fields.nil?
6272
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6273
+ execute_or_queue_command(command, &block)
6274
+ end
6275
+
4847
6276
  # Writes a single user event.
4848
6277
  # @param [String] parent
4849
6278
  # Required. The parent resource name. If the write user event action is applied
@@ -4853,6 +6282,9 @@ module Google
4853
6282
  # across multiple DataStore, the format is: `projects/`project`/locations/`
4854
6283
  # location``.
4855
6284
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent] google_cloud_discoveryengine_v1_user_event_object
6285
+ # @param [Boolean] write_async
6286
+ # If set to true, the user event is written asynchronously after validation, and
6287
+ # the API responds without waiting for the write.
4856
6288
  # @param [String] fields
4857
6289
  # Selector specifying which fields to include in a partial response.
4858
6290
  # @param [String] quota_user
@@ -4870,13 +6302,14 @@ module Google
4870
6302
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4871
6303
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4872
6304
  # @raise [Google::Apis::AuthorizationError] Authorization is required
4873
- def write_project_location_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6305
+ def write_project_location_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
4874
6306
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
4875
6307
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
4876
6308
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
4877
6309
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
4878
6310
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
4879
6311
  command.params['parent'] = parent unless parent.nil?
6312
+ command.query['writeAsync'] = write_async unless write_async.nil?
4880
6313
  command.query['fields'] = fields unless fields.nil?
4881
6314
  command.query['quotaUser'] = quota_user unless quota_user.nil?
4882
6315
  execute_or_queue_command(command, &block)