google-apis-discoveryengine_v1beta 0.19.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -49,6 +49,68 @@ module Google
49
49
  @batch_path = 'batch'
50
50
  end
51
51
 
52
+ # Completes the specified user input with keyword suggestions.
53
+ # @param [String] data_store
54
+ # Required. The parent data store resource name for which the completion is
55
+ # performed, such as `projects/*/locations/global/collections/default_collection/
56
+ # dataStores/default_data_store`.
57
+ # @param [Boolean] include_tail_suggestions
58
+ # Indicates if tail suggestions should be returned if there are no suggestions
59
+ # that match the full query. Even if set to true, if there are suggestions that
60
+ # match the full query, those are returned and no tail suggestions are returned.
61
+ # @param [String] query
62
+ # Required. The typeahead input used to fetch suggestions. Maximum length is 128
63
+ # characters.
64
+ # @param [String] query_model
65
+ # Selects data model of query suggestions for serving. Currently supported
66
+ # values: * `document` - Using suggestions generated from user-imported
67
+ # documents. * `search-history` - Using suggestions generated from the past
68
+ # history of SearchService.Search API calls. Do not use it when there is no
69
+ # traffic for Search API. * `user-event` - Using suggestions generated from user-
70
+ # imported search events. * `document-completable` - Using suggestions taken
71
+ # directly from user-imported document fields marked as completable. Default
72
+ # values: * `document` is the default model for regular dataStores. * `search-
73
+ # history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
74
+ # @param [String] user_pseudo_id
75
+ # A unique identifier for tracking visitors. For example, this could be
76
+ # implemented with an HTTP cookie, which should be able to uniquely identify a
77
+ # visitor on a single device. This unique identifier should not change if the
78
+ # visitor logs in or out of the website. This field should NOT have a fixed
79
+ # value such as `unknown_visitor`. This should be the same identifier as
80
+ # UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
81
+ # UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
82
+ # INVALID_ARGUMENT` error is returned.
83
+ # @param [String] fields
84
+ # Selector specifying which fields to include in a partial response.
85
+ # @param [String] quota_user
86
+ # Available to use for quota purposes for server-side applications. Can be any
87
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
88
+ # @param [Google::Apis::RequestOptions] options
89
+ # Request-specific options
90
+ #
91
+ # @yield [result, err] Result & error if block supplied
92
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse] parsed result object
93
+ # @yieldparam err [StandardError] error object if request failed
94
+ #
95
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse]
96
+ #
97
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
98
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
99
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
100
+ def complete_project_location_collection_data_store_query(data_store, include_tail_suggestions: nil, query: nil, query_model: nil, user_pseudo_id: nil, fields: nil, quota_user: nil, options: nil, &block)
101
+ command = make_simple_command(:get, 'v1beta/{+dataStore}:completeQuery', options)
102
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse::Representation
103
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse
104
+ command.params['dataStore'] = data_store unless data_store.nil?
105
+ command.query['includeTailSuggestions'] = include_tail_suggestions unless include_tail_suggestions.nil?
106
+ command.query['query'] = query unless query.nil?
107
+ command.query['queryModel'] = query_model unless query_model.nil?
108
+ command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
109
+ command.query['fields'] = fields unless fields.nil?
110
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
111
+ execute_or_queue_command(command, &block)
112
+ end
113
+
52
114
  # Creates a Document.
53
115
  # @param [String] parent
54
116
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -396,47 +458,15 @@ module Google
396
458
  execute_or_queue_command(command, &block)
397
459
  end
398
460
 
399
- # Gets the latest state of a long-running operation. Clients can use this method
400
- # to poll the operation result at intervals as recommended by the API service.
401
- # @param [String] name
402
- # The name of the operation resource.
403
- # @param [String] fields
404
- # Selector specifying which fields to include in a partial response.
405
- # @param [String] quota_user
406
- # Available to use for quota purposes for server-side applications. Can be any
407
- # arbitrary string assigned to a user, but should not exceed 40 characters.
408
- # @param [Google::Apis::RequestOptions] options
409
- # Request-specific options
410
- #
411
- # @yield [result, err] Result & error if block supplied
412
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
413
- # @yieldparam err [StandardError] error object if request failed
414
- #
415
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
416
- #
417
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
418
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
419
- # @raise [Google::Apis::AuthorizationError] Authorization is required
420
- def get_project_location_collection_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
421
- command = make_simple_command(:get, 'v1beta/{+name}', options)
422
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
423
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
424
- command.params['name'] = name unless name.nil?
425
- command.query['fields'] = fields unless fields.nil?
426
- command.query['quotaUser'] = quota_user unless quota_user.nil?
427
- execute_or_queue_command(command, &block)
428
- end
429
-
430
- # Lists operations that match the specified filter in the request. If the server
431
- # doesn't support this method, it returns `UNIMPLEMENTED`.
461
+ # Converses a conversation.
432
462
  # @param [String] name
433
- # The name of the operation's parent resource.
434
- # @param [String] filter
435
- # The standard list filter.
436
- # @param [Fixnum] page_size
437
- # The standard list page size.
438
- # @param [String] page_token
439
- # The standard list page token.
463
+ # Required. The resource name of the Conversation to get. Format: `projects/`
464
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
465
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
466
+ # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
467
+ # conversations/-` to activate auto session mode, which automatically creates a
468
+ # new conversation inside a ConverseConversation session.
469
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
440
470
  # @param [String] fields
441
471
  # Selector specifying which fields to include in a partial response.
442
472
  # @param [String] quota_user
@@ -446,31 +476,33 @@ module Google
446
476
  # Request-specific options
447
477
  #
448
478
  # @yield [result, err] Result & error if block supplied
449
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
479
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse] parsed result object
450
480
  # @yieldparam err [StandardError] error object if request failed
451
481
  #
452
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
482
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse]
453
483
  #
454
484
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
455
485
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
456
486
  # @raise [Google::Apis::AuthorizationError] Authorization is required
457
- def list_project_location_collection_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
458
- command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
459
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
460
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
487
+ def converse_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1beta_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
488
+ command = make_simple_command(:post, 'v1beta/{+name}:converse', options)
489
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest::Representation
490
+ command.request_object = google_cloud_discoveryengine_v1beta_converse_conversation_request_object
491
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse::Representation
492
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse
461
493
  command.params['name'] = name unless name.nil?
462
- command.query['filter'] = filter unless filter.nil?
463
- command.query['pageSize'] = page_size unless page_size.nil?
464
- command.query['pageToken'] = page_token unless page_token.nil?
465
494
  command.query['fields'] = fields unless fields.nil?
466
495
  command.query['quotaUser'] = quota_user unless quota_user.nil?
467
496
  execute_or_queue_command(command, &block)
468
497
  end
469
498
 
470
- # Gets the latest state of a long-running operation. Clients can use this method
471
- # to poll the operation result at intervals as recommended by the API service.
472
- # @param [String] name
473
- # The name of the operation resource.
499
+ # Creates a Conversation. If the Conversation to create already exists, an
500
+ # ALREADY_EXISTS error is returned.
501
+ # @param [String] parent
502
+ # Required. Full resource name of parent data store. Format: `projects/`
503
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
504
+ # data_store_id``
505
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
474
506
  # @param [String] fields
475
507
  # Selector specifying which fields to include in a partial response.
476
508
  # @param [String] quota_user
@@ -480,34 +512,32 @@ module Google
480
512
  # Request-specific options
481
513
  #
482
514
  # @yield [result, err] Result & error if block supplied
483
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
515
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
484
516
  # @yieldparam err [StandardError] error object if request failed
485
517
  #
486
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
518
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
487
519
  #
488
520
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
489
521
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
490
522
  # @raise [Google::Apis::AuthorizationError] Authorization is required
491
- def get_project_location_collection_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
492
- command = make_simple_command(:get, 'v1beta/{+name}', options)
493
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
494
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
495
- command.params['name'] = name unless name.nil?
523
+ def create_project_location_collection_data_store_conversation(parent, google_cloud_discoveryengine_v1beta_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
524
+ command = make_simple_command(:post, 'v1beta/{+parent}/conversations', options)
525
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
526
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
527
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
528
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
529
+ command.params['parent'] = parent unless parent.nil?
496
530
  command.query['fields'] = fields unless fields.nil?
497
531
  command.query['quotaUser'] = quota_user unless quota_user.nil?
498
532
  execute_or_queue_command(command, &block)
499
533
  end
500
534
 
501
- # Lists operations that match the specified filter in the request. If the server
502
- # doesn't support this method, it returns `UNIMPLEMENTED`.
535
+ # Deletes a Conversation. If the Conversation to delete does not exist, a
536
+ # NOT_FOUND error is returned.
503
537
  # @param [String] name
504
- # The name of the operation's parent resource.
505
- # @param [String] filter
506
- # The standard list filter.
507
- # @param [Fixnum] page_size
508
- # The standard list page size.
509
- # @param [String] page_token
510
- # The standard list page token.
538
+ # Required. The resource name of the Conversation to delete. Format: `projects/`
539
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
540
+ # data_store_id`/conversations/`conversation_id``
511
541
  # @param [String] fields
512
542
  # Selector specifying which fields to include in a partial response.
513
543
  # @param [String] quota_user
@@ -517,31 +547,29 @@ module Google
517
547
  # Request-specific options
518
548
  #
519
549
  # @yield [result, err] Result & error if block supplied
520
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
550
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
521
551
  # @yieldparam err [StandardError] error object if request failed
522
552
  #
523
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
553
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
524
554
  #
525
555
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
526
556
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
527
557
  # @raise [Google::Apis::AuthorizationError] Authorization is required
528
- def list_project_location_collection_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
529
- command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
530
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
531
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
558
+ def delete_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
559
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
560
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
561
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
532
562
  command.params['name'] = name unless name.nil?
533
- command.query['filter'] = filter unless filter.nil?
534
- command.query['pageSize'] = page_size unless page_size.nil?
535
- command.query['pageToken'] = page_token unless page_token.nil?
536
563
  command.query['fields'] = fields unless fields.nil?
537
564
  command.query['quotaUser'] = quota_user unless quota_user.nil?
538
565
  execute_or_queue_command(command, &block)
539
566
  end
540
567
 
541
- # Gets the latest state of a long-running operation. Clients can use this method
542
- # to poll the operation result at intervals as recommended by the API service.
568
+ # Gets a Conversation.
543
569
  # @param [String] name
544
- # The name of the operation resource.
570
+ # Required. The resource name of the Conversation to get. Format: `projects/`
571
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
572
+ # data_store_id`/conversations/`conversation_id``
545
573
  # @param [String] fields
546
574
  # Selector specifying which fields to include in a partial response.
547
575
  # @param [String] quota_user
@@ -551,34 +579,41 @@ module Google
551
579
  # Request-specific options
552
580
  #
553
581
  # @yield [result, err] Result & error if block supplied
554
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
582
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
555
583
  # @yieldparam err [StandardError] error object if request failed
556
584
  #
557
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
585
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
558
586
  #
559
587
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
560
588
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
561
589
  # @raise [Google::Apis::AuthorizationError] Authorization is required
562
- def get_project_location_collection_data_store_schema_operation(name, fields: nil, quota_user: nil, options: nil, &block)
590
+ def get_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
563
591
  command = make_simple_command(:get, 'v1beta/{+name}', options)
564
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
565
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
592
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
593
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
566
594
  command.params['name'] = name unless name.nil?
567
595
  command.query['fields'] = fields unless fields.nil?
568
596
  command.query['quotaUser'] = quota_user unless quota_user.nil?
569
597
  execute_or_queue_command(command, &block)
570
598
  end
571
599
 
572
- # Lists operations that match the specified filter in the request. If the server
573
- # doesn't support this method, it returns `UNIMPLEMENTED`.
574
- # @param [String] name
575
- # The name of the operation's parent resource.
600
+ # Lists all Conversations by their parent DataStore.
601
+ # @param [String] parent
602
+ # Required. The data store resource name. Format: `projects/`project_number`/
603
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
576
604
  # @param [String] filter
577
- # The standard list filter.
605
+ # A filter to apply on the list results. The supported features are:
606
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
607
+ # @param [String] order_by
608
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
609
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
610
+ # create_time` * `conversation_name` Example: "update_time desc" "create_time"
578
611
  # @param [Fixnum] page_size
579
- # The standard list page size.
612
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
613
+ # allowed value is 1000.
580
614
  # @param [String] page_token
581
- # The standard list page token.
615
+ # A page token, received from a previous `ListConversations` call. Provide this
616
+ # to retrieve the subsequent page.
582
617
  # @param [String] fields
583
618
  # Selector specifying which fields to include in a partial response.
584
619
  # @param [String] quota_user
@@ -588,20 +623,21 @@ module Google
588
623
  # Request-specific options
589
624
  #
590
625
  # @yield [result, err] Result & error if block supplied
591
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
626
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse] parsed result object
592
627
  # @yieldparam err [StandardError] error object if request failed
593
628
  #
594
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
629
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse]
595
630
  #
596
631
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
597
632
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
598
633
  # @raise [Google::Apis::AuthorizationError] Authorization is required
599
- def list_project_location_collection_data_store_schema_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
600
- command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
601
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
602
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
603
- command.params['name'] = name unless name.nil?
634
+ def list_project_location_collection_data_store_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
635
+ command = make_simple_command(:get, 'v1beta/{+parent}/conversations', options)
636
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse::Representation
637
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse
638
+ command.params['parent'] = parent unless parent.nil?
604
639
  command.query['filter'] = filter unless filter.nil?
640
+ command.query['orderBy'] = order_by unless order_by.nil?
605
641
  command.query['pageSize'] = page_size unless page_size.nil?
606
642
  command.query['pageToken'] = page_token unless page_token.nil?
607
643
  command.query['fields'] = fields unless fields.nil?
@@ -609,13 +645,16 @@ module Google
609
645
  execute_or_queue_command(command, &block)
610
646
  end
611
647
 
612
- # Makes a recommendation, which requires a contextual user event.
613
- # @param [String] serving_config
614
- # Required. Full resource name of the format: `projects/*/locations/global/
615
- # collections/*/dataStores/*/servingConfigs/*` Before you can request
616
- # recommendations from your model, you must create at least one serving config
617
- # for it.
618
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
648
+ # Updates a Conversation. Conversation action type cannot be changed. If the
649
+ # Conversation to update does not exist, a NOT_FOUND error is returned.
650
+ # @param [String] name
651
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
652
+ # collection`/dataStore/*/conversations/*`
653
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
654
+ # @param [String] update_mask
655
+ # Indicates which fields in the provided Conversation to update. The following
656
+ # are NOT supported: * conversation.name If not set or empty, all supported
657
+ # fields are updated.
619
658
  # @param [String] fields
620
659
  # Selector specifying which fields to include in a partial response.
621
660
  # @param [String] quota_user
@@ -625,21 +664,22 @@ module Google
625
664
  # Request-specific options
626
665
  #
627
666
  # @yield [result, err] Result & error if block supplied
628
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
667
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
629
668
  # @yieldparam err [StandardError] error object if request failed
630
669
  #
631
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
670
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
632
671
  #
633
672
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
634
673
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
635
674
  # @raise [Google::Apis::AuthorizationError] Authorization is required
636
- def recommend_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1beta_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
637
- command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
638
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
639
- command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
640
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
641
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
642
- command.params['servingConfig'] = serving_config unless serving_config.nil?
675
+ def patch_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1beta_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
676
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
677
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
678
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
679
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
680
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
681
+ command.params['name'] = name unless name.nil?
682
+ command.query['updateMask'] = update_mask unless update_mask.nil?
643
683
  command.query['fields'] = fields unless fields.nil?
644
684
  command.query['quotaUser'] = quota_user unless quota_user.nil?
645
685
  execute_or_queue_command(command, &block)
@@ -666,7 +706,7 @@ module Google
666
706
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
667
707
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
668
708
  # @raise [Google::Apis::AuthorizationError] Authorization is required
669
- def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
709
+ def get_project_location_collection_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
670
710
  command = make_simple_command(:get, 'v1beta/{+name}', options)
671
711
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
672
712
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
@@ -703,7 +743,7 @@ module Google
703
743
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
704
744
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
705
745
  # @raise [Google::Apis::AuthorizationError] Authorization is required
706
- def list_project_location_collection_data_store_site_search_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
746
+ def list_project_location_collection_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
707
747
  command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
708
748
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
709
749
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
@@ -737,7 +777,7 @@ module Google
737
777
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
738
778
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
739
779
  # @raise [Google::Apis::AuthorizationError] Authorization is required
740
- def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
780
+ def get_project_location_collection_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
741
781
  command = make_simple_command(:get, 'v1beta/{+name}', options)
742
782
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
743
783
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
@@ -774,7 +814,7 @@ module Google
774
814
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
775
815
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
776
816
  # @raise [Google::Apis::AuthorizationError] Authorization is required
777
- def list_project_location_collection_data_store_site_search_engine_target_site_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
817
+ def list_project_location_collection_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
778
818
  command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
779
819
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
780
820
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
@@ -787,24 +827,16 @@ module Google
787
827
  execute_or_queue_command(command, &block)
788
828
  end
789
829
 
790
- # Writes a single user event from the browser. This uses a GET request to due to
791
- # browser restriction of POST-ing to a third-party domain. This method is used
792
- # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
793
- # Users should not call this method directly.
830
+ # Creates a Schema.
794
831
  # @param [String] parent
795
- # Required. The parent DataStore resource name, such as `projects/`project`/
796
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
797
- # @param [Fixnum] ets
798
- # The event timestamp in milliseconds. This prevents browser caching of
799
- # otherwise identical get requests. The name is abbreviated to reduce the
800
- # payload bytes.
801
- # @param [String] uri
802
- # The URL including cgi-parameters but excluding the hash fragment with a length
803
- # limit of 5,000 characters. This is often more useful than the referer URL,
804
- # because many browsers only send the domain for third-party requests.
805
- # @param [String] user_event
806
- # Required. URL encoded UserEvent proto with a length limit of 2,000,000
807
- # characters.
832
+ # Required. The parent data store resource name, in the format of `projects/`
833
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store``
834
+ # .
835
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
836
+ # @param [String] schema_id
837
+ # Required. The ID to use for the Schema, which will become the final component
838
+ # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
839
+ # org/html/rfc1034) standard with a length limit of 63 characters.
808
840
  # @param [String] fields
809
841
  # Selector specifying which fields to include in a partial response.
810
842
  # @param [String] quota_user
@@ -814,36 +846,32 @@ module Google
814
846
  # Request-specific options
815
847
  #
816
848
  # @yield [result, err] Result & error if block supplied
817
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody] parsed result object
849
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
818
850
  # @yieldparam err [StandardError] error object if request failed
819
851
  #
820
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody]
852
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
821
853
  #
822
854
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
823
855
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
824
856
  # @raise [Google::Apis::AuthorizationError] Authorization is required
825
- def collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
826
- command = make_simple_command(:get, 'v1beta/{+parent}/userEvents:collect', options)
827
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody::Representation
828
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody
857
+ def create_project_location_collection_data_store_schema(parent, google_cloud_discoveryengine_v1beta_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
858
+ command = make_simple_command(:post, 'v1beta/{+parent}/schemas', options)
859
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
860
+ command.request_object = google_cloud_discoveryengine_v1beta_schema_object
861
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
862
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
829
863
  command.params['parent'] = parent unless parent.nil?
830
- command.query['ets'] = ets unless ets.nil?
831
- command.query['uri'] = uri unless uri.nil?
832
- command.query['userEvent'] = user_event unless user_event.nil?
864
+ command.query['schemaId'] = schema_id unless schema_id.nil?
833
865
  command.query['fields'] = fields unless fields.nil?
834
866
  command.query['quotaUser'] = quota_user unless quota_user.nil?
835
867
  execute_or_queue_command(command, &block)
836
868
  end
837
869
 
838
- # Bulk import of User events. Request processing might be synchronous. Events
839
- # that already exist are skipped. Use this method for backfilling historical
840
- # user events. Operation.response is of type ImportResponse. Note that it is
841
- # possible for a subset of the items to be successfully inserted. Operation.
842
- # metadata is of type ImportMetadata.
843
- # @param [String] parent
844
- # Required. Parent DataStore resource name, of the form `projects/`project`/
845
- # locations/`location`/collections/`collection`/dataStores/`data_store``
846
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest] google_cloud_discoveryengine_v1beta_import_user_events_request_object
870
+ # Deletes a Schema.
871
+ # @param [String] name
872
+ # Required. The full resource name of the schema, in the format of `projects/`
873
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
874
+ # schemas/`schema``.
847
875
  # @param [String] fields
848
876
  # Selector specifying which fields to include in a partial response.
849
877
  # @param [String] quota_user
@@ -861,23 +889,21 @@ module Google
861
889
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
862
890
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
863
891
  # @raise [Google::Apis::AuthorizationError] Authorization is required
864
- def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
865
- command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:import', options)
866
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest::Representation
867
- command.request_object = google_cloud_discoveryengine_v1beta_import_user_events_request_object
892
+ def delete_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
893
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
868
894
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
869
895
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
870
- command.params['parent'] = parent unless parent.nil?
896
+ command.params['name'] = name unless name.nil?
871
897
  command.query['fields'] = fields unless fields.nil?
872
898
  command.query['quotaUser'] = quota_user unless quota_user.nil?
873
899
  execute_or_queue_command(command, &block)
874
900
  end
875
901
 
876
- # Writes a single user event.
877
- # @param [String] parent
878
- # Required. The parent DataStore resource name, such as `projects/`project`/
879
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
880
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
902
+ # Gets a Schema.
903
+ # @param [String] name
904
+ # Required. The full resource name of the schema, in the format of `projects/`
905
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
906
+ # schemas/`schema``.
881
907
  # @param [String] fields
882
908
  # Selector specifying which fields to include in a partial response.
883
909
  # @param [String] quota_user
@@ -887,30 +913,38 @@ module Google
887
913
  # Request-specific options
888
914
  #
889
915
  # @yield [result, err] Result & error if block supplied
890
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] parsed result object
916
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] parsed result object
891
917
  # @yieldparam err [StandardError] error object if request failed
892
918
  #
893
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent]
919
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema]
894
920
  #
895
921
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
896
922
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
897
923
  # @raise [Google::Apis::AuthorizationError] Authorization is required
898
- def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
899
- command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
900
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
901
- command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
902
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
903
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
904
- command.params['parent'] = parent unless parent.nil?
924
+ def get_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
925
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
926
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
927
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema
928
+ command.params['name'] = name unless name.nil?
905
929
  command.query['fields'] = fields unless fields.nil?
906
930
  command.query['quotaUser'] = quota_user unless quota_user.nil?
907
931
  execute_or_queue_command(command, &block)
908
932
  end
909
933
 
910
- # Gets the latest state of a long-running operation. Clients can use this method
911
- # to poll the operation result at intervals as recommended by the API service.
912
- # @param [String] name
913
- # The name of the operation resource.
934
+ # Gets a list of Schemas.
935
+ # @param [String] parent
936
+ # Required. The parent data store resource name, in the format of `projects/`
937
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store``
938
+ # .
939
+ # @param [Fixnum] page_size
940
+ # The maximum number of Schemas to return. The service may return fewer than
941
+ # this value. If unspecified, at most 100 Schemas will be returned. The maximum
942
+ # value is 1000; values above 1000 will be coerced to 1000.
943
+ # @param [String] page_token
944
+ # A page token, received from a previous SchemaService.ListSchemas call. Provide
945
+ # this to retrieve the subsequent page. When paginating, all other parameters
946
+ # provided to SchemaService.ListSchemas must match the call that provided the
947
+ # page token.
914
948
  # @param [String] fields
915
949
  # Selector specifying which fields to include in a partial response.
916
950
  # @param [String] quota_user
@@ -920,34 +954,36 @@ module Google
920
954
  # Request-specific options
921
955
  #
922
956
  # @yield [result, err] Result & error if block supplied
923
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
957
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse] parsed result object
924
958
  # @yieldparam err [StandardError] error object if request failed
925
959
  #
926
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
960
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse]
927
961
  #
928
962
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
929
963
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
930
964
  # @raise [Google::Apis::AuthorizationError] Authorization is required
931
- def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
932
- command = make_simple_command(:get, 'v1beta/{+name}', options)
933
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
934
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
935
- command.params['name'] = name unless name.nil?
965
+ def list_project_location_collection_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
966
+ command = make_simple_command(:get, 'v1beta/{+parent}/schemas', options)
967
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse::Representation
968
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse
969
+ command.params['parent'] = parent unless parent.nil?
970
+ command.query['pageSize'] = page_size unless page_size.nil?
971
+ command.query['pageToken'] = page_token unless page_token.nil?
936
972
  command.query['fields'] = fields unless fields.nil?
937
973
  command.query['quotaUser'] = quota_user unless quota_user.nil?
938
974
  execute_or_queue_command(command, &block)
939
975
  end
940
976
 
941
- # Lists operations that match the specified filter in the request. If the server
942
- # doesn't support this method, it returns `UNIMPLEMENTED`.
977
+ # Updates a Schema.
943
978
  # @param [String] name
944
- # The name of the operation's parent resource.
945
- # @param [String] filter
946
- # The standard list filter.
947
- # @param [Fixnum] page_size
948
- # The standard list page size.
949
- # @param [String] page_token
950
- # The standard list page token.
979
+ # Immutable. The full resource name of the schema, in the format of `projects/`
980
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
981
+ # schemas/`schema``. This field must be a UTF-8 encoded string with a length
982
+ # limit of 1024 characters.
983
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
984
+ # @param [Boolean] allow_missing
985
+ # If set to true, and the Schema is not found, a new Schema will be created. In
986
+ # this situation, `update_mask` is ignored.
951
987
  # @param [String] fields
952
988
  # Selector specifying which fields to include in a partial response.
953
989
  # @param [String] quota_user
@@ -957,17 +993,231 @@ module Google
957
993
  # Request-specific options
958
994
  #
959
995
  # @yield [result, err] Result & error if block supplied
960
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
996
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
961
997
  # @yieldparam err [StandardError] error object if request failed
962
998
  #
963
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
999
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
964
1000
  #
965
1001
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
966
1002
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
967
1003
  # @raise [Google::Apis::AuthorizationError] Authorization is required
968
- def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
969
- command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
970
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1004
+ def patch_project_location_collection_data_store_schema(name, google_cloud_discoveryengine_v1beta_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
1005
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1006
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
1007
+ command.request_object = google_cloud_discoveryengine_v1beta_schema_object
1008
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1009
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1010
+ command.params['name'] = name unless name.nil?
1011
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
1012
+ command.query['fields'] = fields unless fields.nil?
1013
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1014
+ execute_or_queue_command(command, &block)
1015
+ end
1016
+
1017
+ # Gets the latest state of a long-running operation. Clients can use this method
1018
+ # to poll the operation result at intervals as recommended by the API service.
1019
+ # @param [String] name
1020
+ # The name of the operation resource.
1021
+ # @param [String] fields
1022
+ # Selector specifying which fields to include in a partial response.
1023
+ # @param [String] quota_user
1024
+ # Available to use for quota purposes for server-side applications. Can be any
1025
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1026
+ # @param [Google::Apis::RequestOptions] options
1027
+ # Request-specific options
1028
+ #
1029
+ # @yield [result, err] Result & error if block supplied
1030
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1031
+ # @yieldparam err [StandardError] error object if request failed
1032
+ #
1033
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1034
+ #
1035
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1036
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1037
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1038
+ def get_project_location_collection_data_store_schema_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1039
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1040
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1041
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1042
+ command.params['name'] = name unless name.nil?
1043
+ command.query['fields'] = fields unless fields.nil?
1044
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1045
+ execute_or_queue_command(command, &block)
1046
+ end
1047
+
1048
+ # Lists operations that match the specified filter in the request. If the server
1049
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
1050
+ # @param [String] name
1051
+ # The name of the operation's parent resource.
1052
+ # @param [String] filter
1053
+ # The standard list filter.
1054
+ # @param [Fixnum] page_size
1055
+ # The standard list page size.
1056
+ # @param [String] page_token
1057
+ # The standard list page token.
1058
+ # @param [String] fields
1059
+ # Selector specifying which fields to include in a partial response.
1060
+ # @param [String] quota_user
1061
+ # Available to use for quota purposes for server-side applications. Can be any
1062
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1063
+ # @param [Google::Apis::RequestOptions] options
1064
+ # Request-specific options
1065
+ #
1066
+ # @yield [result, err] Result & error if block supplied
1067
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
1068
+ # @yieldparam err [StandardError] error object if request failed
1069
+ #
1070
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
1071
+ #
1072
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1073
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1074
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1075
+ def list_project_location_collection_data_store_schema_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1076
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1077
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1078
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
1079
+ command.params['name'] = name unless name.nil?
1080
+ command.query['filter'] = filter unless filter.nil?
1081
+ command.query['pageSize'] = page_size unless page_size.nil?
1082
+ command.query['pageToken'] = page_token unless page_token.nil?
1083
+ command.query['fields'] = fields unless fields.nil?
1084
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1085
+ execute_or_queue_command(command, &block)
1086
+ end
1087
+
1088
+ # Makes a recommendation, which requires a contextual user event.
1089
+ # @param [String] serving_config
1090
+ # Required. Full resource name of the format: `projects/*/locations/global/
1091
+ # collections/*/dataStores/*/servingConfigs/*` Before you can request
1092
+ # recommendations from your model, you must create at least one serving config
1093
+ # for it.
1094
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
1095
+ # @param [String] fields
1096
+ # Selector specifying which fields to include in a partial response.
1097
+ # @param [String] quota_user
1098
+ # Available to use for quota purposes for server-side applications. Can be any
1099
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1100
+ # @param [Google::Apis::RequestOptions] options
1101
+ # Request-specific options
1102
+ #
1103
+ # @yield [result, err] Result & error if block supplied
1104
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
1105
+ # @yieldparam err [StandardError] error object if request failed
1106
+ #
1107
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
1108
+ #
1109
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1110
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1111
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1112
+ def recommend_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1beta_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1113
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
1114
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
1115
+ command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
1116
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
1117
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
1118
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1119
+ command.query['fields'] = fields unless fields.nil?
1120
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1121
+ execute_or_queue_command(command, &block)
1122
+ end
1123
+
1124
+ # Performs a search.
1125
+ # @param [String] serving_config
1126
+ # Required. The resource name of the Search serving config, such as `projects/*/
1127
+ # locations/global/collections/default_collection/dataStores/default_data_store/
1128
+ # servingConfigs/default_serving_config`. This field is used to identify the
1129
+ # serving configuration name, set of models used to make the search.
1130
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
1131
+ # @param [String] fields
1132
+ # Selector specifying which fields to include in a partial response.
1133
+ # @param [String] quota_user
1134
+ # Available to use for quota purposes for server-side applications. Can be any
1135
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1136
+ # @param [Google::Apis::RequestOptions] options
1137
+ # Request-specific options
1138
+ #
1139
+ # @yield [result, err] Result & error if block supplied
1140
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
1141
+ # @yieldparam err [StandardError] error object if request failed
1142
+ #
1143
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
1144
+ #
1145
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1146
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1147
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1148
+ def search_project_location_collection_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1149
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:search', options)
1150
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
1151
+ command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
1152
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
1153
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
1154
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1155
+ command.query['fields'] = fields unless fields.nil?
1156
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1157
+ execute_or_queue_command(command, &block)
1158
+ end
1159
+
1160
+ # Gets the latest state of a long-running operation. Clients can use this method
1161
+ # to poll the operation result at intervals as recommended by the API service.
1162
+ # @param [String] name
1163
+ # The name of the operation resource.
1164
+ # @param [String] fields
1165
+ # Selector specifying which fields to include in a partial response.
1166
+ # @param [String] quota_user
1167
+ # Available to use for quota purposes for server-side applications. Can be any
1168
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1169
+ # @param [Google::Apis::RequestOptions] options
1170
+ # Request-specific options
1171
+ #
1172
+ # @yield [result, err] Result & error if block supplied
1173
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1174
+ # @yieldparam err [StandardError] error object if request failed
1175
+ #
1176
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1177
+ #
1178
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1179
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1180
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1181
+ def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1182
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1183
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1184
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1185
+ command.params['name'] = name unless name.nil?
1186
+ command.query['fields'] = fields unless fields.nil?
1187
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1188
+ execute_or_queue_command(command, &block)
1189
+ end
1190
+
1191
+ # Lists operations that match the specified filter in the request. If the server
1192
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
1193
+ # @param [String] name
1194
+ # The name of the operation's parent resource.
1195
+ # @param [String] filter
1196
+ # The standard list filter.
1197
+ # @param [Fixnum] page_size
1198
+ # The standard list page size.
1199
+ # @param [String] page_token
1200
+ # The standard list page token.
1201
+ # @param [String] fields
1202
+ # Selector specifying which fields to include in a partial response.
1203
+ # @param [String] quota_user
1204
+ # Available to use for quota purposes for server-side applications. Can be any
1205
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1206
+ # @param [Google::Apis::RequestOptions] options
1207
+ # Request-specific options
1208
+ #
1209
+ # @yield [result, err] Result & error if block supplied
1210
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
1211
+ # @yieldparam err [StandardError] error object if request failed
1212
+ #
1213
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
1214
+ #
1215
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1216
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1217
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1218
+ def list_project_location_collection_data_store_site_search_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1219
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1220
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
971
1221
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
972
1222
  command.params['name'] = name unless name.nil?
973
1223
  command.query['filter'] = filter unless filter.nil?
@@ -999,7 +1249,7 @@ module Google
999
1249
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1000
1250
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1001
1251
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1002
- def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1252
+ def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1003
1253
  command = make_simple_command(:get, 'v1beta/{+name}', options)
1004
1254
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1005
1255
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
@@ -1036,7 +1286,7 @@ module Google
1036
1286
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1037
1287
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1038
1288
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1039
- def list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1289
+ def list_project_location_collection_data_store_site_search_engine_target_site_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1040
1290
  command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1041
1291
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1042
1292
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
@@ -1049,20 +1299,24 @@ module Google
1049
1299
  execute_or_queue_command(command, &block)
1050
1300
  end
1051
1301
 
1052
- # Creates a Document.
1302
+ # Writes a single user event from the browser. This uses a GET request to due to
1303
+ # browser restriction of POST-ing to a third-party domain. This method is used
1304
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
1305
+ # Users should not call this method directly.
1053
1306
  # @param [String] parent
1054
- # Required. The parent resource name, such as `projects/`project`/locations/`
1055
- # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
1056
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
1057
- # @param [String] document_id
1058
- # Required. The ID to use for the Document, which will become the final
1059
- # component of the Document.name. If the caller does not have permission to
1060
- # create the Document, regardless of whether or not it exists, a `
1061
- # PERMISSION_DENIED` error is returned. This field must be unique among all
1062
- # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
1063
- # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
1064
- # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
1065
- # INVALID_ARGUMENT` error is returned.
1307
+ # Required. The parent DataStore resource name, such as `projects/`project`/
1308
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
1309
+ # @param [Fixnum] ets
1310
+ # The event timestamp in milliseconds. This prevents browser caching of
1311
+ # otherwise identical get requests. The name is abbreviated to reduce the
1312
+ # payload bytes.
1313
+ # @param [String] uri
1314
+ # The URL including cgi-parameters but excluding the hash fragment with a length
1315
+ # limit of 5,000 characters. This is often more useful than the referer URL,
1316
+ # because many browsers only send the domain for third-party requests.
1317
+ # @param [String] user_event
1318
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
1319
+ # characters.
1066
1320
  # @param [String] fields
1067
1321
  # Selector specifying which fields to include in a partial response.
1068
1322
  # @param [String] quota_user
@@ -1072,31 +1326,351 @@ module Google
1072
1326
  # Request-specific options
1073
1327
  #
1074
1328
  # @yield [result, err] Result & error if block supplied
1075
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
1329
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody] parsed result object
1076
1330
  # @yieldparam err [StandardError] error object if request failed
1077
1331
  #
1078
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
1332
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody]
1079
1333
  #
1080
1334
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1081
1335
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1082
1336
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1083
- def create_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1084
- command = make_simple_command(:post, 'v1beta/{+parent}/documents', options)
1085
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1086
- command.request_object = google_cloud_discoveryengine_v1beta_document_object
1087
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1088
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
1337
+ def collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
1338
+ command = make_simple_command(:get, 'v1beta/{+parent}/userEvents:collect', options)
1339
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody::Representation
1340
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody
1089
1341
  command.params['parent'] = parent unless parent.nil?
1090
- command.query['documentId'] = document_id unless document_id.nil?
1342
+ command.query['ets'] = ets unless ets.nil?
1343
+ command.query['uri'] = uri unless uri.nil?
1344
+ command.query['userEvent'] = user_event unless user_event.nil?
1091
1345
  command.query['fields'] = fields unless fields.nil?
1092
1346
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1093
1347
  execute_or_queue_command(command, &block)
1094
1348
  end
1095
1349
 
1096
- # Deletes a Document.
1097
- # @param [String] name
1098
- # Required. Full resource name of Document, such as `projects/`project`/
1099
- # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1350
+ # Bulk import of User events. Request processing might be synchronous. Events
1351
+ # that already exist are skipped. Use this method for backfilling historical
1352
+ # user events. Operation.response is of type ImportResponse. Note that it is
1353
+ # possible for a subset of the items to be successfully inserted. Operation.
1354
+ # metadata is of type ImportMetadata.
1355
+ # @param [String] parent
1356
+ # Required. Parent DataStore resource name, of the form `projects/`project`/
1357
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
1358
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest] google_cloud_discoveryengine_v1beta_import_user_events_request_object
1359
+ # @param [String] fields
1360
+ # Selector specifying which fields to include in a partial response.
1361
+ # @param [String] quota_user
1362
+ # Available to use for quota purposes for server-side applications. Can be any
1363
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1364
+ # @param [Google::Apis::RequestOptions] options
1365
+ # Request-specific options
1366
+ #
1367
+ # @yield [result, err] Result & error if block supplied
1368
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1369
+ # @yieldparam err [StandardError] error object if request failed
1370
+ #
1371
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1372
+ #
1373
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1374
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1375
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1376
+ def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1377
+ command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:import', options)
1378
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest::Representation
1379
+ command.request_object = google_cloud_discoveryengine_v1beta_import_user_events_request_object
1380
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1381
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1382
+ command.params['parent'] = parent unless parent.nil?
1383
+ command.query['fields'] = fields unless fields.nil?
1384
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1385
+ execute_or_queue_command(command, &block)
1386
+ end
1387
+
1388
+ # Writes a single user event.
1389
+ # @param [String] parent
1390
+ # Required. The parent DataStore resource name, such as `projects/`project`/
1391
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
1392
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
1393
+ # @param [String] fields
1394
+ # Selector specifying which fields to include in a partial response.
1395
+ # @param [String] quota_user
1396
+ # Available to use for quota purposes for server-side applications. Can be any
1397
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1398
+ # @param [Google::Apis::RequestOptions] options
1399
+ # Request-specific options
1400
+ #
1401
+ # @yield [result, err] Result & error if block supplied
1402
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] parsed result object
1403
+ # @yieldparam err [StandardError] error object if request failed
1404
+ #
1405
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent]
1406
+ #
1407
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1408
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1409
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1410
+ def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1411
+ command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
1412
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
1413
+ command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
1414
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
1415
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
1416
+ command.params['parent'] = parent unless parent.nil?
1417
+ command.query['fields'] = fields unless fields.nil?
1418
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1419
+ execute_or_queue_command(command, &block)
1420
+ end
1421
+
1422
+ # Gets the latest state of a long-running operation. Clients can use this method
1423
+ # to poll the operation result at intervals as recommended by the API service.
1424
+ # @param [String] name
1425
+ # The name of the operation resource.
1426
+ # @param [String] fields
1427
+ # Selector specifying which fields to include in a partial response.
1428
+ # @param [String] quota_user
1429
+ # Available to use for quota purposes for server-side applications. Can be any
1430
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1431
+ # @param [Google::Apis::RequestOptions] options
1432
+ # Request-specific options
1433
+ #
1434
+ # @yield [result, err] Result & error if block supplied
1435
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1436
+ # @yieldparam err [StandardError] error object if request failed
1437
+ #
1438
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1439
+ #
1440
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1441
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1442
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1443
+ def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1444
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1445
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1446
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1447
+ command.params['name'] = name unless name.nil?
1448
+ command.query['fields'] = fields unless fields.nil?
1449
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1450
+ execute_or_queue_command(command, &block)
1451
+ end
1452
+
1453
+ # Lists operations that match the specified filter in the request. If the server
1454
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
1455
+ # @param [String] name
1456
+ # The name of the operation's parent resource.
1457
+ # @param [String] filter
1458
+ # The standard list filter.
1459
+ # @param [Fixnum] page_size
1460
+ # The standard list page size.
1461
+ # @param [String] page_token
1462
+ # The standard list page token.
1463
+ # @param [String] fields
1464
+ # Selector specifying which fields to include in a partial response.
1465
+ # @param [String] quota_user
1466
+ # Available to use for quota purposes for server-side applications. Can be any
1467
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1468
+ # @param [Google::Apis::RequestOptions] options
1469
+ # Request-specific options
1470
+ #
1471
+ # @yield [result, err] Result & error if block supplied
1472
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
1473
+ # @yieldparam err [StandardError] error object if request failed
1474
+ #
1475
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
1476
+ #
1477
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1478
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1479
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1480
+ def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1481
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1482
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1483
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
1484
+ command.params['name'] = name unless name.nil?
1485
+ command.query['filter'] = filter unless filter.nil?
1486
+ command.query['pageSize'] = page_size unless page_size.nil?
1487
+ command.query['pageToken'] = page_token unless page_token.nil?
1488
+ command.query['fields'] = fields unless fields.nil?
1489
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1490
+ execute_or_queue_command(command, &block)
1491
+ end
1492
+
1493
+ # Gets the latest state of a long-running operation. Clients can use this method
1494
+ # to poll the operation result at intervals as recommended by the API service.
1495
+ # @param [String] name
1496
+ # The name of the operation resource.
1497
+ # @param [String] fields
1498
+ # Selector specifying which fields to include in a partial response.
1499
+ # @param [String] quota_user
1500
+ # Available to use for quota purposes for server-side applications. Can be any
1501
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1502
+ # @param [Google::Apis::RequestOptions] options
1503
+ # Request-specific options
1504
+ #
1505
+ # @yield [result, err] Result & error if block supplied
1506
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1507
+ # @yieldparam err [StandardError] error object if request failed
1508
+ #
1509
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1510
+ #
1511
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1512
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1513
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1514
+ def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1515
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1516
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1517
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1518
+ command.params['name'] = name unless name.nil?
1519
+ command.query['fields'] = fields unless fields.nil?
1520
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1521
+ execute_or_queue_command(command, &block)
1522
+ end
1523
+
1524
+ # Lists operations that match the specified filter in the request. If the server
1525
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
1526
+ # @param [String] name
1527
+ # The name of the operation's parent resource.
1528
+ # @param [String] filter
1529
+ # The standard list filter.
1530
+ # @param [Fixnum] page_size
1531
+ # The standard list page size.
1532
+ # @param [String] page_token
1533
+ # The standard list page token.
1534
+ # @param [String] fields
1535
+ # Selector specifying which fields to include in a partial response.
1536
+ # @param [String] quota_user
1537
+ # Available to use for quota purposes for server-side applications. Can be any
1538
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1539
+ # @param [Google::Apis::RequestOptions] options
1540
+ # Request-specific options
1541
+ #
1542
+ # @yield [result, err] Result & error if block supplied
1543
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
1544
+ # @yieldparam err [StandardError] error object if request failed
1545
+ #
1546
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
1547
+ #
1548
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1549
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1550
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1551
+ def list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1552
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1553
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1554
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
1555
+ command.params['name'] = name unless name.nil?
1556
+ command.query['filter'] = filter unless filter.nil?
1557
+ command.query['pageSize'] = page_size unless page_size.nil?
1558
+ command.query['pageToken'] = page_token unless page_token.nil?
1559
+ command.query['fields'] = fields unless fields.nil?
1560
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1561
+ execute_or_queue_command(command, &block)
1562
+ end
1563
+
1564
+ # Completes the specified user input with keyword suggestions.
1565
+ # @param [String] data_store
1566
+ # Required. The parent data store resource name for which the completion is
1567
+ # performed, such as `projects/*/locations/global/collections/default_collection/
1568
+ # dataStores/default_data_store`.
1569
+ # @param [Boolean] include_tail_suggestions
1570
+ # Indicates if tail suggestions should be returned if there are no suggestions
1571
+ # that match the full query. Even if set to true, if there are suggestions that
1572
+ # match the full query, those are returned and no tail suggestions are returned.
1573
+ # @param [String] query
1574
+ # Required. The typeahead input used to fetch suggestions. Maximum length is 128
1575
+ # characters.
1576
+ # @param [String] query_model
1577
+ # Selects data model of query suggestions for serving. Currently supported
1578
+ # values: * `document` - Using suggestions generated from user-imported
1579
+ # documents. * `search-history` - Using suggestions generated from the past
1580
+ # history of SearchService.Search API calls. Do not use it when there is no
1581
+ # traffic for Search API. * `user-event` - Using suggestions generated from user-
1582
+ # imported search events. * `document-completable` - Using suggestions taken
1583
+ # directly from user-imported document fields marked as completable. Default
1584
+ # values: * `document` is the default model for regular dataStores. * `search-
1585
+ # history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
1586
+ # @param [String] user_pseudo_id
1587
+ # A unique identifier for tracking visitors. For example, this could be
1588
+ # implemented with an HTTP cookie, which should be able to uniquely identify a
1589
+ # visitor on a single device. This unique identifier should not change if the
1590
+ # visitor logs in or out of the website. This field should NOT have a fixed
1591
+ # value such as `unknown_visitor`. This should be the same identifier as
1592
+ # UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
1593
+ # UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
1594
+ # INVALID_ARGUMENT` error is returned.
1595
+ # @param [String] fields
1596
+ # Selector specifying which fields to include in a partial response.
1597
+ # @param [String] quota_user
1598
+ # Available to use for quota purposes for server-side applications. Can be any
1599
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1600
+ # @param [Google::Apis::RequestOptions] options
1601
+ # Request-specific options
1602
+ #
1603
+ # @yield [result, err] Result & error if block supplied
1604
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse] parsed result object
1605
+ # @yieldparam err [StandardError] error object if request failed
1606
+ #
1607
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse]
1608
+ #
1609
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1610
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1611
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1612
+ def complete_project_location_data_store_query(data_store, include_tail_suggestions: nil, query: nil, query_model: nil, user_pseudo_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1613
+ command = make_simple_command(:get, 'v1beta/{+dataStore}:completeQuery', options)
1614
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse::Representation
1615
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse
1616
+ command.params['dataStore'] = data_store unless data_store.nil?
1617
+ command.query['includeTailSuggestions'] = include_tail_suggestions unless include_tail_suggestions.nil?
1618
+ command.query['query'] = query unless query.nil?
1619
+ command.query['queryModel'] = query_model unless query_model.nil?
1620
+ command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
1621
+ command.query['fields'] = fields unless fields.nil?
1622
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1623
+ execute_or_queue_command(command, &block)
1624
+ end
1625
+
1626
+ # Creates a Document.
1627
+ # @param [String] parent
1628
+ # Required. The parent resource name, such as `projects/`project`/locations/`
1629
+ # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
1630
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
1631
+ # @param [String] document_id
1632
+ # Required. The ID to use for the Document, which will become the final
1633
+ # component of the Document.name. If the caller does not have permission to
1634
+ # create the Document, regardless of whether or not it exists, a `
1635
+ # PERMISSION_DENIED` error is returned. This field must be unique among all
1636
+ # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
1637
+ # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
1638
+ # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
1639
+ # INVALID_ARGUMENT` error is returned.
1640
+ # @param [String] fields
1641
+ # Selector specifying which fields to include in a partial response.
1642
+ # @param [String] quota_user
1643
+ # Available to use for quota purposes for server-side applications. Can be any
1644
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1645
+ # @param [Google::Apis::RequestOptions] options
1646
+ # Request-specific options
1647
+ #
1648
+ # @yield [result, err] Result & error if block supplied
1649
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
1650
+ # @yieldparam err [StandardError] error object if request failed
1651
+ #
1652
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
1653
+ #
1654
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1655
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1656
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1657
+ def create_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1658
+ command = make_simple_command(:post, 'v1beta/{+parent}/documents', options)
1659
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1660
+ command.request_object = google_cloud_discoveryengine_v1beta_document_object
1661
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1662
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
1663
+ command.params['parent'] = parent unless parent.nil?
1664
+ command.query['documentId'] = document_id unless document_id.nil?
1665
+ command.query['fields'] = fields unless fields.nil?
1666
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1667
+ execute_or_queue_command(command, &block)
1668
+ end
1669
+
1670
+ # Deletes a Document.
1671
+ # @param [String] name
1672
+ # Required. Full resource name of Document, such as `projects/`project`/
1673
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1100
1674
  # `branch`/documents/`document``. If the caller does not have permission to
1101
1675
  # delete the Document, regardless of whether or not it exists, a `
1102
1676
  # PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
@@ -1110,32 +1684,337 @@ module Google
1110
1684
  # Request-specific options
1111
1685
  #
1112
1686
  # @yield [result, err] Result & error if block supplied
1113
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
1687
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
1688
+ # @yieldparam err [StandardError] error object if request failed
1689
+ #
1690
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
1691
+ #
1692
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1693
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1694
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1695
+ def delete_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
1696
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1697
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
1698
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
1699
+ command.params['name'] = name unless name.nil?
1700
+ command.query['fields'] = fields unless fields.nil?
1701
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1702
+ execute_or_queue_command(command, &block)
1703
+ end
1704
+
1705
+ # Gets a Document.
1706
+ # @param [String] name
1707
+ # Required. Full resource name of Document, such as `projects/`project`/
1708
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1709
+ # `branch`/documents/`document``. If the caller does not have permission to
1710
+ # access the Document, regardless of whether or not it exists, a `
1711
+ # PERMISSION_DENIED` error is returned. If the requested Document does not exist,
1712
+ # a `NOT_FOUND` error is returned.
1713
+ # @param [String] fields
1714
+ # Selector specifying which fields to include in a partial response.
1715
+ # @param [String] quota_user
1716
+ # Available to use for quota purposes for server-side applications. Can be any
1717
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1718
+ # @param [Google::Apis::RequestOptions] options
1719
+ # Request-specific options
1720
+ #
1721
+ # @yield [result, err] Result & error if block supplied
1722
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
1723
+ # @yieldparam err [StandardError] error object if request failed
1724
+ #
1725
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
1726
+ #
1727
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1728
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1729
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1730
+ def get_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
1731
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1732
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1733
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
1734
+ command.params['name'] = name unless name.nil?
1735
+ command.query['fields'] = fields unless fields.nil?
1736
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1737
+ execute_or_queue_command(command, &block)
1738
+ end
1739
+
1740
+ # Bulk import of multiple Documents. Request processing may be synchronous. Non-
1741
+ # existing items will be created. Note: It is possible for a subset of the
1742
+ # Documents to be successfully updated.
1743
+ # @param [String] parent
1744
+ # Required. The parent branch resource name, such as `projects/`project`/
1745
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1746
+ # `branch``. Requires create/update permission.
1747
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest] google_cloud_discoveryengine_v1beta_import_documents_request_object
1748
+ # @param [String] fields
1749
+ # Selector specifying which fields to include in a partial response.
1750
+ # @param [String] quota_user
1751
+ # Available to use for quota purposes for server-side applications. Can be any
1752
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1753
+ # @param [Google::Apis::RequestOptions] options
1754
+ # Request-specific options
1755
+ #
1756
+ # @yield [result, err] Result & error if block supplied
1757
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1758
+ # @yieldparam err [StandardError] error object if request failed
1759
+ #
1760
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1761
+ #
1762
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1763
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1764
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1765
+ def import_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1766
+ command = make_simple_command(:post, 'v1beta/{+parent}/documents:import', options)
1767
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest::Representation
1768
+ command.request_object = google_cloud_discoveryengine_v1beta_import_documents_request_object
1769
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1770
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1771
+ command.params['parent'] = parent unless parent.nil?
1772
+ command.query['fields'] = fields unless fields.nil?
1773
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1774
+ execute_or_queue_command(command, &block)
1775
+ end
1776
+
1777
+ # Gets a list of Documents.
1778
+ # @param [String] parent
1779
+ # Required. The parent branch resource name, such as `projects/`project`/
1780
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1781
+ # `branch``. Use `default_branch` as the branch ID, to list documents under the
1782
+ # default branch. If the caller does not have permission to list Documents under
1783
+ # this branch, regardless of whether or not this branch exists, a `
1784
+ # PERMISSION_DENIED` error is returned.
1785
+ # @param [Fixnum] page_size
1786
+ # Maximum number of Documents to return. If unspecified, defaults to 100. The
1787
+ # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
1788
+ # this field is negative, an `INVALID_ARGUMENT` error is returned.
1789
+ # @param [String] page_token
1790
+ # A page token ListDocumentsResponse.next_page_token, received from a previous
1791
+ # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
1792
+ # page. When paginating, all other parameters provided to DocumentService.
1793
+ # ListDocuments must match the call that provided the page token. Otherwise, an `
1794
+ # INVALID_ARGUMENT` error is returned.
1795
+ # @param [String] fields
1796
+ # Selector specifying which fields to include in a partial response.
1797
+ # @param [String] quota_user
1798
+ # Available to use for quota purposes for server-side applications. Can be any
1799
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1800
+ # @param [Google::Apis::RequestOptions] options
1801
+ # Request-specific options
1802
+ #
1803
+ # @yield [result, err] Result & error if block supplied
1804
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse] parsed result object
1805
+ # @yieldparam err [StandardError] error object if request failed
1806
+ #
1807
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse]
1808
+ #
1809
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1810
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1811
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1812
+ def list_project_location_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1813
+ command = make_simple_command(:get, 'v1beta/{+parent}/documents', options)
1814
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse::Representation
1815
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse
1816
+ command.params['parent'] = parent unless parent.nil?
1817
+ command.query['pageSize'] = page_size unless page_size.nil?
1818
+ command.query['pageToken'] = page_token unless page_token.nil?
1819
+ command.query['fields'] = fields unless fields.nil?
1820
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1821
+ execute_or_queue_command(command, &block)
1822
+ end
1823
+
1824
+ # Updates a Document.
1825
+ # @param [String] name
1826
+ # Immutable. The full resource name of the document. Format: `projects/`project`/
1827
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1828
+ # `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
1829
+ # with a length limit of 1024 characters.
1830
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
1831
+ # @param [Boolean] allow_missing
1832
+ # If set to true, and the Document is not found, a new Document will be created.
1833
+ # @param [String] fields
1834
+ # Selector specifying which fields to include in a partial response.
1835
+ # @param [String] quota_user
1836
+ # Available to use for quota purposes for server-side applications. Can be any
1837
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1838
+ # @param [Google::Apis::RequestOptions] options
1839
+ # Request-specific options
1840
+ #
1841
+ # @yield [result, err] Result & error if block supplied
1842
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
1843
+ # @yieldparam err [StandardError] error object if request failed
1844
+ #
1845
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
1846
+ #
1847
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1848
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1849
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1850
+ def patch_project_location_data_store_branch_document(name, google_cloud_discoveryengine_v1beta_document_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
1851
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1852
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1853
+ command.request_object = google_cloud_discoveryengine_v1beta_document_object
1854
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1855
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
1856
+ command.params['name'] = name unless name.nil?
1857
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
1858
+ command.query['fields'] = fields unless fields.nil?
1859
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1860
+ execute_or_queue_command(command, &block)
1861
+ end
1862
+
1863
+ # Permanently deletes all selected Documents in a branch. This process is
1864
+ # asynchronous. Depending on the number of Documents to be deleted, this
1865
+ # operation can take hours to complete. Before the delete operation completes,
1866
+ # some Documents might still be returned by DocumentService.GetDocument or
1867
+ # DocumentService.ListDocuments. To get a list of the Documents to be deleted,
1868
+ # set PurgeDocumentsRequest.force to false.
1869
+ # @param [String] parent
1870
+ # Required. The parent resource name, such as `projects/`project`/locations/`
1871
+ # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
1872
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest] google_cloud_discoveryengine_v1beta_purge_documents_request_object
1873
+ # @param [String] fields
1874
+ # Selector specifying which fields to include in a partial response.
1875
+ # @param [String] quota_user
1876
+ # Available to use for quota purposes for server-side applications. Can be any
1877
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1878
+ # @param [Google::Apis::RequestOptions] options
1879
+ # Request-specific options
1880
+ #
1881
+ # @yield [result, err] Result & error if block supplied
1882
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1883
+ # @yieldparam err [StandardError] error object if request failed
1884
+ #
1885
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1886
+ #
1887
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1888
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1889
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1890
+ def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1891
+ command = make_simple_command(:post, 'v1beta/{+parent}/documents:purge', options)
1892
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest::Representation
1893
+ command.request_object = google_cloud_discoveryengine_v1beta_purge_documents_request_object
1894
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1895
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1896
+ command.params['parent'] = parent unless parent.nil?
1897
+ command.query['fields'] = fields unless fields.nil?
1898
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1899
+ execute_or_queue_command(command, &block)
1900
+ end
1901
+
1902
+ # Gets the latest state of a long-running operation. Clients can use this method
1903
+ # to poll the operation result at intervals as recommended by the API service.
1904
+ # @param [String] name
1905
+ # The name of the operation resource.
1906
+ # @param [String] fields
1907
+ # Selector specifying which fields to include in a partial response.
1908
+ # @param [String] quota_user
1909
+ # Available to use for quota purposes for server-side applications. Can be any
1910
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1911
+ # @param [Google::Apis::RequestOptions] options
1912
+ # Request-specific options
1913
+ #
1914
+ # @yield [result, err] Result & error if block supplied
1915
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
1916
+ # @yieldparam err [StandardError] error object if request failed
1917
+ #
1918
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
1919
+ #
1920
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1921
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1922
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1923
+ def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1924
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1925
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1926
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1927
+ command.params['name'] = name unless name.nil?
1928
+ command.query['fields'] = fields unless fields.nil?
1929
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1930
+ execute_or_queue_command(command, &block)
1931
+ end
1932
+
1933
+ # Lists operations that match the specified filter in the request. If the server
1934
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
1935
+ # @param [String] name
1936
+ # The name of the operation's parent resource.
1937
+ # @param [String] filter
1938
+ # The standard list filter.
1939
+ # @param [Fixnum] page_size
1940
+ # The standard list page size.
1941
+ # @param [String] page_token
1942
+ # The standard list page token.
1943
+ # @param [String] fields
1944
+ # Selector specifying which fields to include in a partial response.
1945
+ # @param [String] quota_user
1946
+ # Available to use for quota purposes for server-side applications. Can be any
1947
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1948
+ # @param [Google::Apis::RequestOptions] options
1949
+ # Request-specific options
1950
+ #
1951
+ # @yield [result, err] Result & error if block supplied
1952
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
1953
+ # @yieldparam err [StandardError] error object if request failed
1954
+ #
1955
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
1956
+ #
1957
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1958
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1959
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1960
+ 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)
1961
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1962
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1963
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
1964
+ command.params['name'] = name unless name.nil?
1965
+ command.query['filter'] = filter unless filter.nil?
1966
+ command.query['pageSize'] = page_size unless page_size.nil?
1967
+ command.query['pageToken'] = page_token unless page_token.nil?
1968
+ command.query['fields'] = fields unless fields.nil?
1969
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1970
+ execute_or_queue_command(command, &block)
1971
+ end
1972
+
1973
+ # Converses a conversation.
1974
+ # @param [String] name
1975
+ # Required. The resource name of the Conversation to get. Format: `projects/`
1976
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1977
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
1978
+ # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
1979
+ # conversations/-` to activate auto session mode, which automatically creates a
1980
+ # new conversation inside a ConverseConversation session.
1981
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
1982
+ # @param [String] fields
1983
+ # Selector specifying which fields to include in a partial response.
1984
+ # @param [String] quota_user
1985
+ # Available to use for quota purposes for server-side applications. Can be any
1986
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1987
+ # @param [Google::Apis::RequestOptions] options
1988
+ # Request-specific options
1989
+ #
1990
+ # @yield [result, err] Result & error if block supplied
1991
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse] parsed result object
1114
1992
  # @yieldparam err [StandardError] error object if request failed
1115
1993
  #
1116
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
1994
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse]
1117
1995
  #
1118
1996
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1119
1997
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1120
1998
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1121
- def delete_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
1122
- command = make_simple_command(:delete, 'v1beta/{+name}', options)
1123
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
1124
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
1999
+ def converse_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1beta_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2000
+ command = make_simple_command(:post, 'v1beta/{+name}:converse', options)
2001
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest::Representation
2002
+ command.request_object = google_cloud_discoveryengine_v1beta_converse_conversation_request_object
2003
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse::Representation
2004
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse
1125
2005
  command.params['name'] = name unless name.nil?
1126
2006
  command.query['fields'] = fields unless fields.nil?
1127
2007
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1128
2008
  execute_or_queue_command(command, &block)
1129
2009
  end
1130
2010
 
1131
- # Gets a Document.
1132
- # @param [String] name
1133
- # Required. Full resource name of Document, such as `projects/`project`/
1134
- # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1135
- # `branch`/documents/`document``. If the caller does not have permission to
1136
- # access the Document, regardless of whether or not it exists, a `
1137
- # PERMISSION_DENIED` error is returned. If the requested Document does not exist,
1138
- # a `NOT_FOUND` error is returned.
2011
+ # Creates a Conversation. If the Conversation to create already exists, an
2012
+ # ALREADY_EXISTS error is returned.
2013
+ # @param [String] parent
2014
+ # Required. Full resource name of parent data store. Format: `projects/`
2015
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2016
+ # data_store_id``
2017
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
1139
2018
  # @param [String] fields
1140
2019
  # Selector specifying which fields to include in a partial response.
1141
2020
  # @param [String] quota_user
@@ -1145,32 +2024,32 @@ module Google
1145
2024
  # Request-specific options
1146
2025
  #
1147
2026
  # @yield [result, err] Result & error if block supplied
1148
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
2027
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1149
2028
  # @yieldparam err [StandardError] error object if request failed
1150
2029
  #
1151
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
2030
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1152
2031
  #
1153
2032
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1154
2033
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1155
2034
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1156
- def get_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
1157
- command = make_simple_command(:get, 'v1beta/{+name}', options)
1158
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1159
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
1160
- command.params['name'] = name unless name.nil?
2035
+ def create_project_location_data_store_conversation(parent, google_cloud_discoveryengine_v1beta_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2036
+ command = make_simple_command(:post, 'v1beta/{+parent}/conversations', options)
2037
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
2038
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
2039
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
2040
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
2041
+ command.params['parent'] = parent unless parent.nil?
1161
2042
  command.query['fields'] = fields unless fields.nil?
1162
2043
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1163
2044
  execute_or_queue_command(command, &block)
1164
2045
  end
1165
2046
 
1166
- # Bulk import of multiple Documents. Request processing may be synchronous. Non-
1167
- # existing items will be created. Note: It is possible for a subset of the
1168
- # Documents to be successfully updated.
1169
- # @param [String] parent
1170
- # Required. The parent branch resource name, such as `projects/`project`/
1171
- # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1172
- # `branch``. Requires create/update permission.
1173
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest] google_cloud_discoveryengine_v1beta_import_documents_request_object
2047
+ # Deletes a Conversation. If the Conversation to delete does not exist, a
2048
+ # NOT_FOUND error is returned.
2049
+ # @param [String] name
2050
+ # Required. The resource name of the Conversation to delete. Format: `projects/`
2051
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2052
+ # data_store_id`/conversations/`conversation_id``
1174
2053
  # @param [String] fields
1175
2054
  # Selector specifying which fields to include in a partial response.
1176
2055
  # @param [String] quota_user
@@ -1180,44 +2059,29 @@ module Google
1180
2059
  # Request-specific options
1181
2060
  #
1182
2061
  # @yield [result, err] Result & error if block supplied
1183
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
2062
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
1184
2063
  # @yieldparam err [StandardError] error object if request failed
1185
2064
  #
1186
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
2065
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
1187
2066
  #
1188
2067
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1189
2068
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1190
2069
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1191
- def import_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1192
- command = make_simple_command(:post, 'v1beta/{+parent}/documents:import', options)
1193
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest::Representation
1194
- command.request_object = google_cloud_discoveryengine_v1beta_import_documents_request_object
1195
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1196
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1197
- command.params['parent'] = parent unless parent.nil?
2070
+ def delete_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
2071
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
2072
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
2073
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
2074
+ command.params['name'] = name unless name.nil?
1198
2075
  command.query['fields'] = fields unless fields.nil?
1199
2076
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1200
2077
  execute_or_queue_command(command, &block)
1201
2078
  end
1202
2079
 
1203
- # Gets a list of Documents.
1204
- # @param [String] parent
1205
- # Required. The parent branch resource name, such as `projects/`project`/
1206
- # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1207
- # `branch``. Use `default_branch` as the branch ID, to list documents under the
1208
- # default branch. If the caller does not have permission to list Documents under
1209
- # this branch, regardless of whether or not this branch exists, a `
1210
- # PERMISSION_DENIED` error is returned.
1211
- # @param [Fixnum] page_size
1212
- # Maximum number of Documents to return. If unspecified, defaults to 100. The
1213
- # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
1214
- # this field is negative, an `INVALID_ARGUMENT` error is returned.
1215
- # @param [String] page_token
1216
- # A page token ListDocumentsResponse.next_page_token, received from a previous
1217
- # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
1218
- # page. When paginating, all other parameters provided to DocumentService.
1219
- # ListDocuments must match the call that provided the page token. Otherwise, an `
1220
- # INVALID_ARGUMENT` error is returned.
2080
+ # Gets a Conversation.
2081
+ # @param [String] name
2082
+ # Required. The resource name of the Conversation to get. Format: `projects/`
2083
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2084
+ # data_store_id`/conversations/`conversation_id``
1221
2085
  # @param [String] fields
1222
2086
  # Selector specifying which fields to include in a partial response.
1223
2087
  # @param [String] quota_user
@@ -1227,35 +2091,41 @@ module Google
1227
2091
  # Request-specific options
1228
2092
  #
1229
2093
  # @yield [result, err] Result & error if block supplied
1230
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse] parsed result object
2094
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1231
2095
  # @yieldparam err [StandardError] error object if request failed
1232
2096
  #
1233
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse]
2097
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1234
2098
  #
1235
2099
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1236
2100
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1237
2101
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1238
- def list_project_location_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1239
- command = make_simple_command(:get, 'v1beta/{+parent}/documents', options)
1240
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse::Representation
1241
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse
1242
- command.params['parent'] = parent unless parent.nil?
1243
- command.query['pageSize'] = page_size unless page_size.nil?
1244
- command.query['pageToken'] = page_token unless page_token.nil?
2102
+ def get_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
2103
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
2104
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
2105
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
2106
+ command.params['name'] = name unless name.nil?
1245
2107
  command.query['fields'] = fields unless fields.nil?
1246
2108
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1247
2109
  execute_or_queue_command(command, &block)
1248
2110
  end
1249
2111
 
1250
- # Updates a Document.
1251
- # @param [String] name
1252
- # Immutable. The full resource name of the document. Format: `projects/`project`/
1253
- # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1254
- # `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
1255
- # with a length limit of 1024 characters.
1256
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
1257
- # @param [Boolean] allow_missing
1258
- # If set to true, and the Document is not found, a new Document will be created.
2112
+ # Lists all Conversations by their parent DataStore.
2113
+ # @param [String] parent
2114
+ # Required. The data store resource name. Format: `projects/`project_number`/
2115
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
2116
+ # @param [String] filter
2117
+ # A filter to apply on the list results. The supported features are:
2118
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
2119
+ # @param [String] order_by
2120
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
2121
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
2122
+ # create_time` * `conversation_name` Example: "update_time desc" "create_time"
2123
+ # @param [Fixnum] page_size
2124
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
2125
+ # allowed value is 1000.
2126
+ # @param [String] page_token
2127
+ # A page token, received from a previous `ListConversations` call. Provide this
2128
+ # to retrieve the subsequent page.
1259
2129
  # @param [String] fields
1260
2130
  # Selector specifying which fields to include in a partial response.
1261
2131
  # @param [String] quota_user
@@ -1265,37 +2135,38 @@ module Google
1265
2135
  # Request-specific options
1266
2136
  #
1267
2137
  # @yield [result, err] Result & error if block supplied
1268
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
2138
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse] parsed result object
1269
2139
  # @yieldparam err [StandardError] error object if request failed
1270
2140
  #
1271
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
2141
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse]
1272
2142
  #
1273
2143
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1274
2144
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1275
2145
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1276
- def patch_project_location_data_store_branch_document(name, google_cloud_discoveryengine_v1beta_document_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
1277
- command = make_simple_command(:patch, 'v1beta/{+name}', options)
1278
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1279
- command.request_object = google_cloud_discoveryengine_v1beta_document_object
1280
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
1281
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
1282
- command.params['name'] = name unless name.nil?
1283
- command.query['allowMissing'] = allow_missing unless allow_missing.nil?
2146
+ def list_project_location_data_store_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2147
+ command = make_simple_command(:get, 'v1beta/{+parent}/conversations', options)
2148
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse::Representation
2149
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse
2150
+ command.params['parent'] = parent unless parent.nil?
2151
+ command.query['filter'] = filter unless filter.nil?
2152
+ command.query['orderBy'] = order_by unless order_by.nil?
2153
+ command.query['pageSize'] = page_size unless page_size.nil?
2154
+ command.query['pageToken'] = page_token unless page_token.nil?
1284
2155
  command.query['fields'] = fields unless fields.nil?
1285
2156
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1286
2157
  execute_or_queue_command(command, &block)
1287
2158
  end
1288
2159
 
1289
- # Permanently deletes all selected Documents in a branch. This process is
1290
- # asynchronous. Depending on the number of Documents to be deleted, this
1291
- # operation can take hours to complete. Before the delete operation completes,
1292
- # some Documents might still be returned by DocumentService.GetDocument or
1293
- # DocumentService.ListDocuments. To get a list of the Documents to be deleted,
1294
- # set PurgeDocumentsRequest.force to false.
1295
- # @param [String] parent
1296
- # Required. The parent resource name, such as `projects/`project`/locations/`
1297
- # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
1298
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest] google_cloud_discoveryengine_v1beta_purge_documents_request_object
2160
+ # Updates a Conversation. Conversation action type cannot be changed. If the
2161
+ # Conversation to update does not exist, a NOT_FOUND error is returned.
2162
+ # @param [String] name
2163
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
2164
+ # collection`/dataStore/*/conversations/*`
2165
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
2166
+ # @param [String] update_mask
2167
+ # Indicates which fields in the provided Conversation to update. The following
2168
+ # are NOT supported: * conversation.name If not set or empty, all supported
2169
+ # fields are updated.
1299
2170
  # @param [String] fields
1300
2171
  # Selector specifying which fields to include in a partial response.
1301
2172
  # @param [String] quota_user
@@ -1305,21 +2176,22 @@ module Google
1305
2176
  # Request-specific options
1306
2177
  #
1307
2178
  # @yield [result, err] Result & error if block supplied
1308
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
2179
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1309
2180
  # @yieldparam err [StandardError] error object if request failed
1310
2181
  #
1311
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
2182
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1312
2183
  #
1313
2184
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1314
2185
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1315
2186
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1316
- def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1317
- command = make_simple_command(:post, 'v1beta/{+parent}/documents:purge', options)
1318
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest::Representation
1319
- command.request_object = google_cloud_discoveryengine_v1beta_purge_documents_request_object
1320
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1321
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1322
- command.params['parent'] = parent unless parent.nil?
2187
+ def patch_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1beta_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2188
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
2189
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
2190
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
2191
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
2192
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
2193
+ command.params['name'] = name unless name.nil?
2194
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1323
2195
  command.query['fields'] = fields unless fields.nil?
1324
2196
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1325
2197
  execute_or_queue_command(command, &block)
@@ -1346,7 +2218,7 @@ module Google
1346
2218
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1347
2219
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1348
2220
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1349
- def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2221
+ def get_project_location_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1350
2222
  command = make_simple_command(:get, 'v1beta/{+name}', options)
1351
2223
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1352
2224
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
@@ -1383,7 +2255,7 @@ module Google
1383
2255
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1384
2256
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1385
2257
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1386
- 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)
2258
+ def list_project_location_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1387
2259
  command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1388
2260
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1389
2261
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
@@ -1417,7 +2289,7 @@ module Google
1417
2289
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1418
2290
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1419
2291
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1420
- def get_project_location_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2292
+ def get_project_location_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1421
2293
  command = make_simple_command(:get, 'v1beta/{+name}', options)
1422
2294
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1423
2295
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
@@ -1454,7 +2326,7 @@ module Google
1454
2326
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1455
2327
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1456
2328
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1457
- def list_project_location_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2329
+ def list_project_location_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1458
2330
  command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1459
2331
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1460
2332
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
@@ -1467,10 +2339,51 @@ module Google
1467
2339
  execute_or_queue_command(command, &block)
1468
2340
  end
1469
2341
 
1470
- # Gets the latest state of a long-running operation. Clients can use this method
1471
- # to poll the operation result at intervals as recommended by the API service.
2342
+ # Creates a Schema.
2343
+ # @param [String] parent
2344
+ # Required. The parent data store resource name, in the format of `projects/`
2345
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store``
2346
+ # .
2347
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
2348
+ # @param [String] schema_id
2349
+ # Required. The ID to use for the Schema, which will become the final component
2350
+ # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
2351
+ # org/html/rfc1034) standard with a length limit of 63 characters.
2352
+ # @param [String] fields
2353
+ # Selector specifying which fields to include in a partial response.
2354
+ # @param [String] quota_user
2355
+ # Available to use for quota purposes for server-side applications. Can be any
2356
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2357
+ # @param [Google::Apis::RequestOptions] options
2358
+ # Request-specific options
2359
+ #
2360
+ # @yield [result, err] Result & error if block supplied
2361
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
2362
+ # @yieldparam err [StandardError] error object if request failed
2363
+ #
2364
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
2365
+ #
2366
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2367
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2368
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2369
+ def create_project_location_data_store_schema(parent, google_cloud_discoveryengine_v1beta_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2370
+ command = make_simple_command(:post, 'v1beta/{+parent}/schemas', options)
2371
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
2372
+ command.request_object = google_cloud_discoveryengine_v1beta_schema_object
2373
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
2374
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
2375
+ command.params['parent'] = parent unless parent.nil?
2376
+ command.query['schemaId'] = schema_id unless schema_id.nil?
2377
+ command.query['fields'] = fields unless fields.nil?
2378
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2379
+ execute_or_queue_command(command, &block)
2380
+ end
2381
+
2382
+ # Deletes a Schema.
1472
2383
  # @param [String] name
1473
- # The name of the operation resource.
2384
+ # Required. The full resource name of the schema, in the format of `projects/`
2385
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
2386
+ # schemas/`schema``.
1474
2387
  # @param [String] fields
1475
2388
  # Selector specifying which fields to include in a partial response.
1476
2389
  # @param [String] quota_user
@@ -1488,8 +2401,8 @@ module Google
1488
2401
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1489
2402
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1490
2403
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1491
- def get_project_location_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1492
- command = make_simple_command(:get, 'v1beta/{+name}', options)
2404
+ def delete_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
2405
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1493
2406
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
1494
2407
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
1495
2408
  command.params['name'] = name unless name.nil?
@@ -1498,16 +2411,52 @@ module Google
1498
2411
  execute_or_queue_command(command, &block)
1499
2412
  end
1500
2413
 
1501
- # Lists operations that match the specified filter in the request. If the server
1502
- # doesn't support this method, it returns `UNIMPLEMENTED`.
2414
+ # Gets a Schema.
1503
2415
  # @param [String] name
1504
- # The name of the operation's parent resource.
1505
- # @param [String] filter
1506
- # The standard list filter.
2416
+ # Required. The full resource name of the schema, in the format of `projects/`
2417
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
2418
+ # schemas/`schema``.
2419
+ # @param [String] fields
2420
+ # Selector specifying which fields to include in a partial response.
2421
+ # @param [String] quota_user
2422
+ # Available to use for quota purposes for server-side applications. Can be any
2423
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2424
+ # @param [Google::Apis::RequestOptions] options
2425
+ # Request-specific options
2426
+ #
2427
+ # @yield [result, err] Result & error if block supplied
2428
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] parsed result object
2429
+ # @yieldparam err [StandardError] error object if request failed
2430
+ #
2431
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema]
2432
+ #
2433
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2434
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2435
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2436
+ def get_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
2437
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
2438
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
2439
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema
2440
+ command.params['name'] = name unless name.nil?
2441
+ command.query['fields'] = fields unless fields.nil?
2442
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2443
+ execute_or_queue_command(command, &block)
2444
+ end
2445
+
2446
+ # Gets a list of Schemas.
2447
+ # @param [String] parent
2448
+ # Required. The parent data store resource name, in the format of `projects/`
2449
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store``
2450
+ # .
1507
2451
  # @param [Fixnum] page_size
1508
- # The standard list page size.
2452
+ # The maximum number of Schemas to return. The service may return fewer than
2453
+ # this value. If unspecified, at most 100 Schemas will be returned. The maximum
2454
+ # value is 1000; values above 1000 will be coerced to 1000.
1509
2455
  # @param [String] page_token
1510
- # The standard list page token.
2456
+ # A page token, received from a previous SchemaService.ListSchemas call. Provide
2457
+ # this to retrieve the subsequent page. When paginating, all other parameters
2458
+ # provided to SchemaService.ListSchemas must match the call that provided the
2459
+ # page token.
1511
2460
  # @param [String] fields
1512
2461
  # Selector specifying which fields to include in a partial response.
1513
2462
  # @param [String] quota_user
@@ -1517,20 +2466,19 @@ module Google
1517
2466
  # Request-specific options
1518
2467
  #
1519
2468
  # @yield [result, err] Result & error if block supplied
1520
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
2469
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse] parsed result object
1521
2470
  # @yieldparam err [StandardError] error object if request failed
1522
2471
  #
1523
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
2472
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse]
1524
2473
  #
1525
2474
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1526
2475
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1527
2476
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1528
- def list_project_location_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1529
- command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1530
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
1531
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
1532
- command.params['name'] = name unless name.nil?
1533
- command.query['filter'] = filter unless filter.nil?
2477
+ def list_project_location_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2478
+ command = make_simple_command(:get, 'v1beta/{+parent}/schemas', options)
2479
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse::Representation
2480
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse
2481
+ command.params['parent'] = parent unless parent.nil?
1534
2482
  command.query['pageSize'] = page_size unless page_size.nil?
1535
2483
  command.query['pageToken'] = page_token unless page_token.nil?
1536
2484
  command.query['fields'] = fields unless fields.nil?
@@ -1538,6 +2486,46 @@ module Google
1538
2486
  execute_or_queue_command(command, &block)
1539
2487
  end
1540
2488
 
2489
+ # Updates a Schema.
2490
+ # @param [String] name
2491
+ # Immutable. The full resource name of the schema, in the format of `projects/`
2492
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
2493
+ # schemas/`schema``. This field must be a UTF-8 encoded string with a length
2494
+ # limit of 1024 characters.
2495
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
2496
+ # @param [Boolean] allow_missing
2497
+ # If set to true, and the Schema is not found, a new Schema will be created. In
2498
+ # this situation, `update_mask` is ignored.
2499
+ # @param [String] fields
2500
+ # Selector specifying which fields to include in a partial response.
2501
+ # @param [String] quota_user
2502
+ # Available to use for quota purposes for server-side applications. Can be any
2503
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2504
+ # @param [Google::Apis::RequestOptions] options
2505
+ # Request-specific options
2506
+ #
2507
+ # @yield [result, err] Result & error if block supplied
2508
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
2509
+ # @yieldparam err [StandardError] error object if request failed
2510
+ #
2511
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
2512
+ #
2513
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2514
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2515
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2516
+ def patch_project_location_data_store_schema(name, google_cloud_discoveryengine_v1beta_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
2517
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
2518
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
2519
+ command.request_object = google_cloud_discoveryengine_v1beta_schema_object
2520
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
2521
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
2522
+ command.params['name'] = name unless name.nil?
2523
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
2524
+ command.query['fields'] = fields unless fields.nil?
2525
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2526
+ execute_or_queue_command(command, &block)
2527
+ end
2528
+
1541
2529
  # Makes a recommendation, which requires a contextual user event.
1542
2530
  # @param [String] serving_config
1543
2531
  # Required. Full resource name of the format: `projects/*/locations/global/
@@ -1574,6 +2562,42 @@ module Google
1574
2562
  execute_or_queue_command(command, &block)
1575
2563
  end
1576
2564
 
2565
+ # Performs a search.
2566
+ # @param [String] serving_config
2567
+ # Required. The resource name of the Search serving config, such as `projects/*/
2568
+ # locations/global/collections/default_collection/dataStores/default_data_store/
2569
+ # servingConfigs/default_serving_config`. This field is used to identify the
2570
+ # serving configuration name, set of models used to make the search.
2571
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
2572
+ # @param [String] fields
2573
+ # Selector specifying which fields to include in a partial response.
2574
+ # @param [String] quota_user
2575
+ # Available to use for quota purposes for server-side applications. Can be any
2576
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2577
+ # @param [Google::Apis::RequestOptions] options
2578
+ # Request-specific options
2579
+ #
2580
+ # @yield [result, err] Result & error if block supplied
2581
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
2582
+ # @yieldparam err [StandardError] error object if request failed
2583
+ #
2584
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
2585
+ #
2586
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2587
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2588
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2589
+ def search_project_location_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2590
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:search', options)
2591
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
2592
+ command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
2593
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
2594
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
2595
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
2596
+ command.query['fields'] = fields unless fields.nil?
2597
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2598
+ execute_or_queue_command(command, &block)
2599
+ end
2600
+
1577
2601
  # Writes a single user event from the browser. This uses a GET request to due to
1578
2602
  # browser restriction of POST-ing to a third-party domain. This method is used
1579
2603
  # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.