google-apis-discoveryengine_v1alpha 0.17.0 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +3426 -946
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +1267 -238
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +1517 -352
- metadata +3 -3
@@ -49,6 +49,209 @@ module Google
|
|
49
49
|
@batch_path = 'batch'
|
50
50
|
end
|
51
51
|
|
52
|
+
# Gets the Widget Config using the uuid.
|
53
|
+
# @param [String] location
|
54
|
+
# Required. The location resource where lookup widget will be performed. Format:
|
55
|
+
# `locations/`location``
|
56
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest] google_cloud_discoveryengine_v1alpha_lookup_widget_config_request_object
|
57
|
+
# @param [String] fields
|
58
|
+
# Selector specifying which fields to include in a partial response.
|
59
|
+
# @param [String] quota_user
|
60
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
61
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
62
|
+
# @param [Google::Apis::RequestOptions] options
|
63
|
+
# Request-specific options
|
64
|
+
#
|
65
|
+
# @yield [result, err] Result & error if block supplied
|
66
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse] parsed result object
|
67
|
+
# @yieldparam err [StandardError] error object if request failed
|
68
|
+
#
|
69
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse]
|
70
|
+
#
|
71
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
72
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
73
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
74
|
+
def lookup_location_widget_config(location, google_cloud_discoveryengine_v1alpha_lookup_widget_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
75
|
+
command = make_simple_command(:post, 'v1alpha/{+location}/lookupWidgetConfig', options)
|
76
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest::Representation
|
77
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_lookup_widget_config_request_object
|
78
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse::Representation
|
79
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse
|
80
|
+
command.params['location'] = location unless location.nil?
|
81
|
+
command.query['fields'] = fields unless fields.nil?
|
82
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
83
|
+
execute_or_queue_command(command, &block)
|
84
|
+
end
|
85
|
+
|
86
|
+
# Performs a user input completion with keyword suggestion. Similar to the
|
87
|
+
# CompletionService.CompleteQuery method, but a widget version that allows
|
88
|
+
# CompleteQuery without API Key. It supports CompleteQuery with or without JWT
|
89
|
+
# token.
|
90
|
+
# @param [String] location
|
91
|
+
# Required. The location resource where widget complete query will be performed.
|
92
|
+
# Format: `locations/`location``
|
93
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest] google_cloud_discoveryengine_v1alpha_widget_complete_query_request_object
|
94
|
+
# @param [String] fields
|
95
|
+
# Selector specifying which fields to include in a partial response.
|
96
|
+
# @param [String] quota_user
|
97
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
98
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
99
|
+
# @param [Google::Apis::RequestOptions] options
|
100
|
+
# Request-specific options
|
101
|
+
#
|
102
|
+
# @yield [result, err] Result & error if block supplied
|
103
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse] parsed result object
|
104
|
+
# @yieldparam err [StandardError] error object if request failed
|
105
|
+
#
|
106
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse]
|
107
|
+
#
|
108
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
109
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
110
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
111
|
+
def widget_location_complete_query(location, google_cloud_discoveryengine_v1alpha_widget_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
112
|
+
command = make_simple_command(:post, 'v1alpha/{+location}/widgetCompleteQuery', options)
|
113
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest::Representation
|
114
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_complete_query_request_object
|
115
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse::Representation
|
116
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse
|
117
|
+
command.params['location'] = location unless location.nil?
|
118
|
+
command.query['fields'] = fields unless fields.nil?
|
119
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
120
|
+
execute_or_queue_command(command, &block)
|
121
|
+
end
|
122
|
+
|
123
|
+
# Converse a conversation with Widget.
|
124
|
+
# @param [String] location
|
125
|
+
# Required. The location resource where widget converse conversation will be
|
126
|
+
# performed. Format: `locations/`location``
|
127
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest] google_cloud_discoveryengine_v1alpha_widget_converse_conversation_request_object
|
128
|
+
# @param [String] fields
|
129
|
+
# Selector specifying which fields to include in a partial response.
|
130
|
+
# @param [String] quota_user
|
131
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
132
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
133
|
+
# @param [Google::Apis::RequestOptions] options
|
134
|
+
# Request-specific options
|
135
|
+
#
|
136
|
+
# @yield [result, err] Result & error if block supplied
|
137
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse] parsed result object
|
138
|
+
# @yieldparam err [StandardError] error object if request failed
|
139
|
+
#
|
140
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse]
|
141
|
+
#
|
142
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
143
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
144
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
145
|
+
def widget_location_converse_conversation(location, google_cloud_discoveryengine_v1alpha_widget_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
146
|
+
command = make_simple_command(:post, 'v1alpha/{+location}/widgetConverseConversation', options)
|
147
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest::Representation
|
148
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_converse_conversation_request_object
|
149
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse::Representation
|
150
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse
|
151
|
+
command.params['location'] = location unless location.nil?
|
152
|
+
command.query['fields'] = fields unless fields.nil?
|
153
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
154
|
+
execute_or_queue_command(command, &block)
|
155
|
+
end
|
156
|
+
|
157
|
+
# Performs a search. Similar to the SearchService.Search method, but a widget
|
158
|
+
# version that allows search without API Key. It supports search with or without
|
159
|
+
# JWT token.
|
160
|
+
# @param [String] location
|
161
|
+
# Required. The location resource where widget search will be performed. Format:
|
162
|
+
# `locations/`location``
|
163
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest] google_cloud_discoveryengine_v1alpha_widget_search_request_object
|
164
|
+
# @param [String] fields
|
165
|
+
# Selector specifying which fields to include in a partial response.
|
166
|
+
# @param [String] quota_user
|
167
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
168
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
169
|
+
# @param [Google::Apis::RequestOptions] options
|
170
|
+
# Request-specific options
|
171
|
+
#
|
172
|
+
# @yield [result, err] Result & error if block supplied
|
173
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse] parsed result object
|
174
|
+
# @yieldparam err [StandardError] error object if request failed
|
175
|
+
#
|
176
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse]
|
177
|
+
#
|
178
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
179
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
180
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
181
|
+
def widget_location_search(location, google_cloud_discoveryengine_v1alpha_widget_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
182
|
+
command = make_simple_command(:post, 'v1alpha/{+location}/widgetSearch', options)
|
183
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest::Representation
|
184
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_search_request_object
|
185
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse::Representation
|
186
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse
|
187
|
+
command.params['location'] = location unless location.nil?
|
188
|
+
command.query['fields'] = fields unless fields.nil?
|
189
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
190
|
+
execute_or_queue_command(command, &block)
|
191
|
+
end
|
192
|
+
|
193
|
+
# Completes the specified user input with keyword suggestions.
|
194
|
+
# @param [String] data_store
|
195
|
+
# Required. The parent data store resource name for which the completion is
|
196
|
+
# performed, such as `projects/*/locations/global/collections/default_collection/
|
197
|
+
# dataStores/default_data_store`.
|
198
|
+
# @param [Boolean] include_tail_suggestions
|
199
|
+
# Indicates if tail suggestions should be returned if there are no suggestions
|
200
|
+
# that match the full query. Even if set to true, if there are suggestions that
|
201
|
+
# match the full query, those are returned and no tail suggestions are returned.
|
202
|
+
# @param [String] query
|
203
|
+
# Required. The typeahead input used to fetch suggestions. Maximum length is 128
|
204
|
+
# characters.
|
205
|
+
# @param [String] query_model
|
206
|
+
# Selects data model of query suggestions for serving. Currently supported
|
207
|
+
# values: * `document` - Using suggestions generated from user-imported
|
208
|
+
# documents. * `search-history` - Using suggestions generated from the past
|
209
|
+
# history of SearchService.Search API calls. Do not use it when there is no
|
210
|
+
# traffic for Search API. * `user-event` - Using suggestions generated from user-
|
211
|
+
# imported search events. * `document-completable` - Using suggestions taken
|
212
|
+
# directly from user-imported document fields marked as completable. Default
|
213
|
+
# values: * `document` is the default model for regular dataStores. * `search-
|
214
|
+
# history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
|
215
|
+
# @param [String] user_pseudo_id
|
216
|
+
# A unique identifier for tracking visitors. For example, this could be
|
217
|
+
# implemented with an HTTP cookie, which should be able to uniquely identify a
|
218
|
+
# visitor on a single device. This unique identifier should not change if the
|
219
|
+
# visitor logs in or out of the website. This field should NOT have a fixed
|
220
|
+
# value such as `unknown_visitor`. This should be the same identifier as
|
221
|
+
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
222
|
+
# UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
|
223
|
+
# INVALID_ARGUMENT` error is returned.
|
224
|
+
# @param [String] fields
|
225
|
+
# Selector specifying which fields to include in a partial response.
|
226
|
+
# @param [String] quota_user
|
227
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
228
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
229
|
+
# @param [Google::Apis::RequestOptions] options
|
230
|
+
# Request-specific options
|
231
|
+
#
|
232
|
+
# @yield [result, err] Result & error if block supplied
|
233
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse] parsed result object
|
234
|
+
# @yieldparam err [StandardError] error object if request failed
|
235
|
+
#
|
236
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse]
|
237
|
+
#
|
238
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
239
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
240
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
241
|
+
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)
|
242
|
+
command = make_simple_command(:get, 'v1alpha/{+dataStore}:completeQuery', options)
|
243
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse::Representation
|
244
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse
|
245
|
+
command.params['dataStore'] = data_store unless data_store.nil?
|
246
|
+
command.query['includeTailSuggestions'] = include_tail_suggestions unless include_tail_suggestions.nil?
|
247
|
+
command.query['query'] = query unless query.nil?
|
248
|
+
command.query['queryModel'] = query_model unless query_model.nil?
|
249
|
+
command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
|
250
|
+
command.query['fields'] = fields unless fields.nil?
|
251
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
252
|
+
execute_or_queue_command(command, &block)
|
253
|
+
end
|
254
|
+
|
52
255
|
# Creates a Document.
|
53
256
|
# @param [String] parent
|
54
257
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
@@ -396,47 +599,15 @@ module Google
|
|
396
599
|
execute_or_queue_command(command, &block)
|
397
600
|
end
|
398
601
|
|
399
|
-
#
|
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::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
413
|
-
# @yieldparam err [StandardError] error object if request failed
|
414
|
-
#
|
415
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::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, 'v1alpha/{+name}', options)
|
422
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
423
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::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`.
|
602
|
+
# Converses a conversation.
|
432
603
|
# @param [String] name
|
433
|
-
# The name of the
|
434
|
-
#
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
439
|
-
#
|
604
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
605
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
606
|
+
# data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
|
607
|
+
# /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
|
608
|
+
# conversations/-` to activate auto session mode, which automatically creates a
|
609
|
+
# new conversation inside a ConverseConversation session.
|
610
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest] google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
|
440
611
|
# @param [String] fields
|
441
612
|
# Selector specifying which fields to include in a partial response.
|
442
613
|
# @param [String] quota_user
|
@@ -446,31 +617,33 @@ module Google
|
|
446
617
|
# Request-specific options
|
447
618
|
#
|
448
619
|
# @yield [result, err] Result & error if block supplied
|
449
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
620
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse] parsed result object
|
450
621
|
# @yieldparam err [StandardError] error object if request failed
|
451
622
|
#
|
452
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
623
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse]
|
453
624
|
#
|
454
625
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
455
626
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
456
627
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
457
|
-
def
|
458
|
-
command = make_simple_command(:
|
459
|
-
command.
|
460
|
-
command.
|
628
|
+
def converse_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1alpha_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
629
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:converse', options)
|
630
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest::Representation
|
631
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
|
632
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse::Representation
|
633
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse
|
461
634
|
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
635
|
command.query['fields'] = fields unless fields.nil?
|
466
636
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
467
637
|
execute_or_queue_command(command, &block)
|
468
638
|
end
|
469
639
|
|
470
|
-
#
|
471
|
-
#
|
472
|
-
# @param [String]
|
473
|
-
#
|
640
|
+
# Creates a Conversation. If the Conversation to create already exists, an
|
641
|
+
# ALREADY_EXISTS error is returned.
|
642
|
+
# @param [String] parent
|
643
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
644
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
645
|
+
# data_store_id``
|
646
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
|
474
647
|
# @param [String] fields
|
475
648
|
# Selector specifying which fields to include in a partial response.
|
476
649
|
# @param [String] quota_user
|
@@ -480,34 +653,32 @@ module Google
|
|
480
653
|
# Request-specific options
|
481
654
|
#
|
482
655
|
# @yield [result, err] Result & error if block supplied
|
483
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
656
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
|
484
657
|
# @yieldparam err [StandardError] error object if request failed
|
485
658
|
#
|
486
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
659
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
|
487
660
|
#
|
488
661
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
489
662
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
490
663
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
491
|
-
def
|
492
|
-
command = make_simple_command(:
|
493
|
-
command.
|
494
|
-
command.
|
495
|
-
command.
|
664
|
+
def create_project_location_collection_data_store_conversation(parent, google_cloud_discoveryengine_v1alpha_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
665
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/conversations', options)
|
666
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
667
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
|
668
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
669
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
|
670
|
+
command.params['parent'] = parent unless parent.nil?
|
496
671
|
command.query['fields'] = fields unless fields.nil?
|
497
672
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
498
673
|
execute_or_queue_command(command, &block)
|
499
674
|
end
|
500
675
|
|
501
|
-
#
|
502
|
-
#
|
676
|
+
# Deletes a Conversation. If the Conversation to delete does not exist, a
|
677
|
+
# NOT_FOUND error is returned.
|
503
678
|
# @param [String] name
|
504
|
-
# The name of the
|
505
|
-
#
|
506
|
-
#
|
507
|
-
# @param [Fixnum] page_size
|
508
|
-
# The standard list page size.
|
509
|
-
# @param [String] page_token
|
510
|
-
# The standard list page token.
|
679
|
+
# Required. The resource name of the Conversation to delete. Format: `projects/`
|
680
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
681
|
+
# data_store_id`/conversations/`conversation_id``
|
511
682
|
# @param [String] fields
|
512
683
|
# Selector specifying which fields to include in a partial response.
|
513
684
|
# @param [String] quota_user
|
@@ -517,31 +688,29 @@ module Google
|
|
517
688
|
# Request-specific options
|
518
689
|
#
|
519
690
|
# @yield [result, err] Result & error if block supplied
|
520
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
691
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
521
692
|
# @yieldparam err [StandardError] error object if request failed
|
522
693
|
#
|
523
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
694
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
524
695
|
#
|
525
696
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
526
697
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
527
698
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
528
|
-
def
|
529
|
-
command = make_simple_command(:
|
530
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
531
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
699
|
+
def delete_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
700
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
701
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
702
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
532
703
|
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
704
|
command.query['fields'] = fields unless fields.nil?
|
537
705
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
538
706
|
execute_or_queue_command(command, &block)
|
539
707
|
end
|
540
708
|
|
541
|
-
# Gets
|
542
|
-
# to poll the operation result at intervals as recommended by the API service.
|
709
|
+
# Gets a Conversation.
|
543
710
|
# @param [String] name
|
544
|
-
# The name of the
|
711
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
712
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
713
|
+
# data_store_id`/conversations/`conversation_id``
|
545
714
|
# @param [String] fields
|
546
715
|
# Selector specifying which fields to include in a partial response.
|
547
716
|
# @param [String] quota_user
|
@@ -551,34 +720,41 @@ module Google
|
|
551
720
|
# Request-specific options
|
552
721
|
#
|
553
722
|
# @yield [result, err] Result & error if block supplied
|
554
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
723
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
|
555
724
|
# @yieldparam err [StandardError] error object if request failed
|
556
725
|
#
|
557
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
726
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
|
558
727
|
#
|
559
728
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
560
729
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
561
730
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
562
|
-
def
|
731
|
+
def get_project_location_collection_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
563
732
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
564
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
565
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
733
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
734
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
|
566
735
|
command.params['name'] = name unless name.nil?
|
567
736
|
command.query['fields'] = fields unless fields.nil?
|
568
737
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
569
738
|
execute_or_queue_command(command, &block)
|
570
739
|
end
|
571
740
|
|
572
|
-
# Lists
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
741
|
+
# Lists all Conversations by their parent DataStore.
|
742
|
+
# @param [String] parent
|
743
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
744
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
576
745
|
# @param [String] filter
|
577
|
-
#
|
746
|
+
# A filter to apply on the list results. The supported features are:
|
747
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
748
|
+
# @param [String] order_by
|
749
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
750
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
751
|
+
# create_time` * `conversation_name` Example: "update_time desc" "create_time"
|
578
752
|
# @param [Fixnum] page_size
|
579
|
-
#
|
753
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
754
|
+
# allowed value is 1000.
|
580
755
|
# @param [String] page_token
|
581
|
-
#
|
756
|
+
# A page token, received from a previous `ListConversations` call. Provide this
|
757
|
+
# to retrieve the subsequent page.
|
582
758
|
# @param [String] fields
|
583
759
|
# Selector specifying which fields to include in a partial response.
|
584
760
|
# @param [String] quota_user
|
@@ -588,20 +764,21 @@ module Google
|
|
588
764
|
# Request-specific options
|
589
765
|
#
|
590
766
|
# @yield [result, err] Result & error if block supplied
|
591
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
767
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse] parsed result object
|
592
768
|
# @yieldparam err [StandardError] error object if request failed
|
593
769
|
#
|
594
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
770
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse]
|
595
771
|
#
|
596
772
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
597
773
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
598
774
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
599
|
-
def
|
600
|
-
command = make_simple_command(:get, 'v1alpha/{+
|
601
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
602
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
603
|
-
command.params['
|
775
|
+
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)
|
776
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/conversations', options)
|
777
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse::Representation
|
778
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse
|
779
|
+
command.params['parent'] = parent unless parent.nil?
|
604
780
|
command.query['filter'] = filter unless filter.nil?
|
781
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
605
782
|
command.query['pageSize'] = page_size unless page_size.nil?
|
606
783
|
command.query['pageToken'] = page_token unless page_token.nil?
|
607
784
|
command.query['fields'] = fields unless fields.nil?
|
@@ -609,13 +786,16 @@ module Google
|
|
609
786
|
execute_or_queue_command(command, &block)
|
610
787
|
end
|
611
788
|
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
# @param [
|
789
|
+
# Updates a Conversation. Conversation action type cannot be changed. If the
|
790
|
+
# Conversation to update does not exist, a NOT_FOUND error is returned.
|
791
|
+
# @param [String] name
|
792
|
+
# Immutable. Fully qualified name `project/*/locations/global/collections/`
|
793
|
+
# collection`/dataStore/*/conversations/*`
|
794
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
|
795
|
+
# @param [String] update_mask
|
796
|
+
# Indicates which fields in the provided Conversation to update. The following
|
797
|
+
# are NOT supported: * conversation.name If not set or empty, all supported
|
798
|
+
# fields are updated.
|
619
799
|
# @param [String] fields
|
620
800
|
# Selector specifying which fields to include in a partial response.
|
621
801
|
# @param [String] quota_user
|
@@ -625,21 +805,22 @@ module Google
|
|
625
805
|
# Request-specific options
|
626
806
|
#
|
627
807
|
# @yield [result, err] Result & error if block supplied
|
628
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
808
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
|
629
809
|
# @yieldparam err [StandardError] error object if request failed
|
630
810
|
#
|
631
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
811
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
|
632
812
|
#
|
633
813
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
634
814
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
635
815
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
636
|
-
def
|
637
|
-
command = make_simple_command(:
|
638
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
639
|
-
command.request_object =
|
640
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
641
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
642
|
-
command.params['
|
816
|
+
def patch_project_location_collection_data_store_conversation(name, google_cloud_discoveryengine_v1alpha_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
817
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
818
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
819
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
|
820
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
821
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
|
822
|
+
command.params['name'] = name unless name.nil?
|
823
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
643
824
|
command.query['fields'] = fields unless fields.nil?
|
644
825
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
645
826
|
execute_or_queue_command(command, &block)
|
@@ -666,7 +847,7 @@ module Google
|
|
666
847
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
667
848
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
668
849
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
669
|
-
def
|
850
|
+
def get_project_location_collection_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
670
851
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
671
852
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
672
853
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
@@ -703,7 +884,7 @@ module Google
|
|
703
884
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
704
885
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
705
886
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
706
|
-
def
|
887
|
+
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
888
|
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
708
889
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
709
890
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
@@ -737,7 +918,7 @@ module Google
|
|
737
918
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
738
919
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
739
920
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
740
|
-
def
|
921
|
+
def get_project_location_collection_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
741
922
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
742
923
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
743
924
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
@@ -774,7 +955,7 @@ module Google
|
|
774
955
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
775
956
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
776
957
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
777
|
-
def
|
958
|
+
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
959
|
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
779
960
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
780
961
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
@@ -787,24 +968,16 @@ module Google
|
|
787
968
|
execute_or_queue_command(command, &block)
|
788
969
|
end
|
789
970
|
|
790
|
-
#
|
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.
|
971
|
+
# Creates a Schema.
|
794
972
|
# @param [String] parent
|
795
|
-
# Required. The parent
|
796
|
-
# locations/`location`/collections/`collection`/dataStores/`data_store
|
797
|
-
#
|
798
|
-
#
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
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.
|
973
|
+
# Required. The parent data store resource name, in the format of `projects/`
|
974
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store``
|
975
|
+
# .
|
976
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
977
|
+
# @param [String] schema_id
|
978
|
+
# Required. The ID to use for the Schema, which will become the final component
|
979
|
+
# of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
980
|
+
# org/html/rfc1034) standard with a length limit of 63 characters.
|
808
981
|
# @param [String] fields
|
809
982
|
# Selector specifying which fields to include in a partial response.
|
810
983
|
# @param [String] quota_user
|
@@ -814,36 +987,32 @@ module Google
|
|
814
987
|
# Request-specific options
|
815
988
|
#
|
816
989
|
# @yield [result, err] Result & error if block supplied
|
817
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
990
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
818
991
|
# @yieldparam err [StandardError] error object if request failed
|
819
992
|
#
|
820
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
993
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
821
994
|
#
|
822
995
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
823
996
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
824
997
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
825
|
-
def
|
826
|
-
command = make_simple_command(:
|
827
|
-
command.
|
828
|
-
command.
|
998
|
+
def create_project_location_collection_data_store_schema(parent, google_cloud_discoveryengine_v1alpha_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
999
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/schemas', options)
|
1000
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema::Representation
|
1001
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_schema_object
|
1002
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1003
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
829
1004
|
command.params['parent'] = parent unless parent.nil?
|
830
|
-
command.query['
|
831
|
-
command.query['uri'] = uri unless uri.nil?
|
832
|
-
command.query['userEvent'] = user_event unless user_event.nil?
|
1005
|
+
command.query['schemaId'] = schema_id unless schema_id.nil?
|
833
1006
|
command.query['fields'] = fields unless fields.nil?
|
834
1007
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
835
1008
|
execute_or_queue_command(command, &block)
|
836
1009
|
end
|
837
1010
|
|
838
|
-
#
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
1011
|
+
# Deletes a Schema.
|
1012
|
+
# @param [String] name
|
1013
|
+
# Required. The full resource name of the schema, in the format of `projects/`
|
1014
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1015
|
+
# schemas/`schema``.
|
847
1016
|
# @param [String] fields
|
848
1017
|
# Selector specifying which fields to include in a partial response.
|
849
1018
|
# @param [String] quota_user
|
@@ -861,27 +1030,21 @@ module Google
|
|
861
1030
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
862
1031
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
863
1032
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
864
|
-
def
|
865
|
-
command = make_simple_command(:
|
866
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
|
867
|
-
command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
1033
|
+
def delete_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
|
1034
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
868
1035
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
869
1036
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
870
|
-
command.params['
|
1037
|
+
command.params['name'] = name unless name.nil?
|
871
1038
|
command.query['fields'] = fields unless fields.nil?
|
872
1039
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
873
1040
|
execute_or_queue_command(command, &block)
|
874
1041
|
end
|
875
1042
|
|
876
|
-
#
|
877
|
-
#
|
878
|
-
#
|
879
|
-
#
|
880
|
-
#
|
881
|
-
# Required. The resource name of the catalog under which the events are created.
|
882
|
-
# The format is `projects/$`projectId`/locations/global/collections/`$
|
883
|
-
# collectionId`/dataStores/$`dataStoreId``
|
884
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
|
1043
|
+
# Gets a Schema.
|
1044
|
+
# @param [String] name
|
1045
|
+
# Required. The full resource name of the schema, in the format of `projects/`
|
1046
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1047
|
+
# schemas/`schema``.
|
885
1048
|
# @param [String] fields
|
886
1049
|
# Selector specifying which fields to include in a partial response.
|
887
1050
|
# @param [String] quota_user
|
@@ -891,31 +1054,38 @@ module Google
|
|
891
1054
|
# Request-specific options
|
892
1055
|
#
|
893
1056
|
# @yield [result, err] Result & error if block supplied
|
894
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
1057
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] parsed result object
|
895
1058
|
# @yieldparam err [StandardError] error object if request failed
|
896
1059
|
#
|
897
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
1060
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema]
|
898
1061
|
#
|
899
1062
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
900
1063
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
901
1064
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
902
|
-
def
|
903
|
-
command = make_simple_command(:
|
904
|
-
command.
|
905
|
-
command.
|
906
|
-
command.
|
907
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
908
|
-
command.params['parent'] = parent unless parent.nil?
|
1065
|
+
def get_project_location_collection_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
|
1066
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1067
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema::Representation
|
1068
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema
|
1069
|
+
command.params['name'] = name unless name.nil?
|
909
1070
|
command.query['fields'] = fields unless fields.nil?
|
910
1071
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
911
1072
|
execute_or_queue_command(command, &block)
|
912
1073
|
end
|
913
1074
|
|
914
|
-
#
|
1075
|
+
# Gets a list of Schemas.
|
915
1076
|
# @param [String] parent
|
916
|
-
# Required. The parent
|
917
|
-
# locations/`location`/collections/`collection`/dataStores/`data_store
|
918
|
-
#
|
1077
|
+
# Required. The parent data store resource name, in the format of `projects/`
|
1078
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store``
|
1079
|
+
# .
|
1080
|
+
# @param [Fixnum] page_size
|
1081
|
+
# The maximum number of Schemas to return. The service may return fewer than
|
1082
|
+
# this value. If unspecified, at most 100 Schemas will be returned. The maximum
|
1083
|
+
# value is 1000; values above 1000 will be coerced to 1000.
|
1084
|
+
# @param [String] page_token
|
1085
|
+
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
1086
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
1087
|
+
# provided to SchemaService.ListSchemas must match the call that provided the
|
1088
|
+
# page token.
|
919
1089
|
# @param [String] fields
|
920
1090
|
# Selector specifying which fields to include in a partial response.
|
921
1091
|
# @param [String] quota_user
|
@@ -925,21 +1095,61 @@ module Google
|
|
925
1095
|
# Request-specific options
|
926
1096
|
#
|
927
1097
|
# @yield [result, err] Result & error if block supplied
|
928
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
1098
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse] parsed result object
|
929
1099
|
# @yieldparam err [StandardError] error object if request failed
|
930
1100
|
#
|
931
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
1101
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse]
|
932
1102
|
#
|
933
1103
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
934
1104
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
935
1105
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
936
|
-
def
|
937
|
-
command = make_simple_command(:
|
938
|
-
command.
|
939
|
-
command.
|
940
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
|
941
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
|
1106
|
+
def list_project_location_collection_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1107
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/schemas', options)
|
1108
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse::Representation
|
1109
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse
|
942
1110
|
command.params['parent'] = parent unless parent.nil?
|
1111
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1112
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1113
|
+
command.query['fields'] = fields unless fields.nil?
|
1114
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1115
|
+
execute_or_queue_command(command, &block)
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
# Updates a Schema.
|
1119
|
+
# @param [String] name
|
1120
|
+
# Immutable. The full resource name of the schema, in the format of `projects/`
|
1121
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1122
|
+
# schemas/`schema``. This field must be a UTF-8 encoded string with a length
|
1123
|
+
# limit of 1024 characters.
|
1124
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
1125
|
+
# @param [Boolean] allow_missing
|
1126
|
+
# If set to true, and the Schema is not found, a new Schema will be created. In
|
1127
|
+
# this situation, `update_mask` is ignored.
|
1128
|
+
# @param [String] fields
|
1129
|
+
# Selector specifying which fields to include in a partial response.
|
1130
|
+
# @param [String] quota_user
|
1131
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1132
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1133
|
+
# @param [Google::Apis::RequestOptions] options
|
1134
|
+
# Request-specific options
|
1135
|
+
#
|
1136
|
+
# @yield [result, err] Result & error if block supplied
|
1137
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1138
|
+
# @yieldparam err [StandardError] error object if request failed
|
1139
|
+
#
|
1140
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1141
|
+
#
|
1142
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1143
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1144
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1145
|
+
def patch_project_location_collection_data_store_schema(name, google_cloud_discoveryengine_v1alpha_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1146
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
1147
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema::Representation
|
1148
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_schema_object
|
1149
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1150
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1151
|
+
command.params['name'] = name unless name.nil?
|
1152
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
943
1153
|
command.query['fields'] = fields unless fields.nil?
|
944
1154
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
945
1155
|
execute_or_queue_command(command, &block)
|
@@ -966,7 +1176,7 @@ module Google
|
|
966
1176
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
967
1177
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
968
1178
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
969
|
-
def
|
1179
|
+
def get_project_location_collection_data_store_schema_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
970
1180
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
971
1181
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
972
1182
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
@@ -1003,7 +1213,7 @@ module Google
|
|
1003
1213
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1004
1214
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1005
1215
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1006
|
-
def
|
1216
|
+
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)
|
1007
1217
|
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
1008
1218
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
1009
1219
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
@@ -1016,6 +1226,78 @@ module Google
|
|
1016
1226
|
execute_or_queue_command(command, &block)
|
1017
1227
|
end
|
1018
1228
|
|
1229
|
+
# Makes a recommendation, which requires a contextual user event.
|
1230
|
+
# @param [String] serving_config
|
1231
|
+
# Required. Full resource name of the format: `projects/*/locations/global/
|
1232
|
+
# collections/*/dataStores/*/servingConfigs/*` Before you can request
|
1233
|
+
# recommendations from your model, you must create at least one serving config
|
1234
|
+
# for it.
|
1235
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
1236
|
+
# @param [String] fields
|
1237
|
+
# Selector specifying which fields to include in a partial response.
|
1238
|
+
# @param [String] quota_user
|
1239
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1240
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1241
|
+
# @param [Google::Apis::RequestOptions] options
|
1242
|
+
# Request-specific options
|
1243
|
+
#
|
1244
|
+
# @yield [result, err] Result & error if block supplied
|
1245
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
|
1246
|
+
# @yieldparam err [StandardError] error object if request failed
|
1247
|
+
#
|
1248
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
|
1249
|
+
#
|
1250
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1251
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1252
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1253
|
+
def recommend_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1254
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
|
1255
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
|
1256
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
|
1257
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
|
1258
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
|
1259
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1260
|
+
command.query['fields'] = fields unless fields.nil?
|
1261
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1262
|
+
execute_or_queue_command(command, &block)
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# Performs a search.
|
1266
|
+
# @param [String] serving_config
|
1267
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
1268
|
+
# locations/global/collections/default_collection/dataStores/default_data_store/
|
1269
|
+
# servingConfigs/default_serving_config`. This field is used to identify the
|
1270
|
+
# serving configuration name, set of models used to make the search.
|
1271
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
|
1272
|
+
# @param [String] fields
|
1273
|
+
# Selector specifying which fields to include in a partial response.
|
1274
|
+
# @param [String] quota_user
|
1275
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1276
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1277
|
+
# @param [Google::Apis::RequestOptions] options
|
1278
|
+
# Request-specific options
|
1279
|
+
#
|
1280
|
+
# @yield [result, err] Result & error if block supplied
|
1281
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
|
1282
|
+
# @yieldparam err [StandardError] error object if request failed
|
1283
|
+
#
|
1284
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
|
1285
|
+
#
|
1286
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1287
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1288
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1289
|
+
def search_project_location_collection_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1290
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:search', options)
|
1291
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
1292
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
1293
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
1294
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
|
1295
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1296
|
+
command.query['fields'] = fields unless fields.nil?
|
1297
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1298
|
+
execute_or_queue_command(command, &block)
|
1299
|
+
end
|
1300
|
+
|
1019
1301
|
# Gets the latest state of a long-running operation. Clients can use this method
|
1020
1302
|
# to poll the operation result at intervals as recommended by the API service.
|
1021
1303
|
# @param [String] name
|
@@ -1037,7 +1319,7 @@ module Google
|
|
1037
1319
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1038
1320
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1039
1321
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1040
|
-
def
|
1322
|
+
def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1041
1323
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1042
1324
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1043
1325
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
@@ -1074,7 +1356,7 @@ module Google
|
|
1074
1356
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1075
1357
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1076
1358
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1077
|
-
def
|
1359
|
+
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)
|
1078
1360
|
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
1079
1361
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
1080
1362
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
@@ -1087,20 +1369,10 @@ module Google
|
|
1087
1369
|
execute_or_queue_command(command, &block)
|
1088
1370
|
end
|
1089
1371
|
|
1090
|
-
#
|
1091
|
-
#
|
1092
|
-
#
|
1093
|
-
#
|
1094
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
1095
|
-
# @param [String] document_id
|
1096
|
-
# Required. The ID to use for the Document, which will become the final
|
1097
|
-
# component of the Document.name. If the caller does not have permission to
|
1098
|
-
# create the Document, regardless of whether or not it exists, a `
|
1099
|
-
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
1100
|
-
# Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
1101
|
-
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
1102
|
-
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
1103
|
-
# INVALID_ARGUMENT` error is returned.
|
1372
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1373
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1374
|
+
# @param [String] name
|
1375
|
+
# The name of the operation resource.
|
1104
1376
|
# @param [String] fields
|
1105
1377
|
# Selector specifying which fields to include in a partial response.
|
1106
1378
|
# @param [String] quota_user
|
@@ -1110,35 +1382,782 @@ module Google
|
|
1110
1382
|
# Request-specific options
|
1111
1383
|
#
|
1112
1384
|
# @yield [result, err] Result & error if block supplied
|
1113
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
1385
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1114
1386
|
# @yieldparam err [StandardError] error object if request failed
|
1115
1387
|
#
|
1116
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
1388
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1117
1389
|
#
|
1118
1390
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1119
1391
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1120
1392
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1121
|
-
def
|
1122
|
-
command = make_simple_command(:
|
1123
|
-
command.
|
1124
|
-
command.
|
1125
|
-
command.
|
1126
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
|
1127
|
-
command.params['parent'] = parent unless parent.nil?
|
1128
|
-
command.query['documentId'] = document_id unless document_id.nil?
|
1393
|
+
def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1394
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1395
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1396
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1397
|
+
command.params['name'] = name unless name.nil?
|
1129
1398
|
command.query['fields'] = fields unless fields.nil?
|
1130
1399
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1131
1400
|
execute_or_queue_command(command, &block)
|
1132
1401
|
end
|
1133
1402
|
|
1134
|
-
#
|
1403
|
+
# Lists operations that match the specified filter in the request. If the server
|
1404
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
1135
1405
|
# @param [String] name
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
1406
|
+
# The name of the operation's parent resource.
|
1407
|
+
# @param [String] filter
|
1408
|
+
# The standard list filter.
|
1409
|
+
# @param [Fixnum] page_size
|
1410
|
+
# The standard list page size.
|
1411
|
+
# @param [String] page_token
|
1412
|
+
# The standard list page token.
|
1413
|
+
# @param [String] fields
|
1414
|
+
# Selector specifying which fields to include in a partial response.
|
1415
|
+
# @param [String] quota_user
|
1416
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1417
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1418
|
+
# @param [Google::Apis::RequestOptions] options
|
1419
|
+
# Request-specific options
|
1420
|
+
#
|
1421
|
+
# @yield [result, err] Result & error if block supplied
|
1422
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
1423
|
+
# @yieldparam err [StandardError] error object if request failed
|
1424
|
+
#
|
1425
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
1426
|
+
#
|
1427
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1428
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1429
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1430
|
+
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)
|
1431
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
1432
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
1433
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
1434
|
+
command.params['name'] = name unless name.nil?
|
1435
|
+
command.query['filter'] = filter unless filter.nil?
|
1436
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1437
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1438
|
+
command.query['fields'] = fields unless fields.nil?
|
1439
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1440
|
+
execute_or_queue_command(command, &block)
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
# Writes a single user event from the browser. This uses a GET request to due to
|
1444
|
+
# browser restriction of POST-ing to a third-party domain. This method is used
|
1445
|
+
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
1446
|
+
# Users should not call this method directly.
|
1447
|
+
# @param [String] parent
|
1448
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
1449
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
1450
|
+
# @param [Fixnum] ets
|
1451
|
+
# The event timestamp in milliseconds. This prevents browser caching of
|
1452
|
+
# otherwise identical get requests. The name is abbreviated to reduce the
|
1453
|
+
# payload bytes.
|
1454
|
+
# @param [String] uri
|
1455
|
+
# The URL including cgi-parameters but excluding the hash fragment with a length
|
1456
|
+
# limit of 5,000 characters. This is often more useful than the referer URL,
|
1457
|
+
# because many browsers only send the domain for third-party requests.
|
1458
|
+
# @param [String] user_event
|
1459
|
+
# Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
1460
|
+
# characters.
|
1461
|
+
# @param [String] fields
|
1462
|
+
# Selector specifying which fields to include in a partial response.
|
1463
|
+
# @param [String] quota_user
|
1464
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1465
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1466
|
+
# @param [Google::Apis::RequestOptions] options
|
1467
|
+
# Request-specific options
|
1468
|
+
#
|
1469
|
+
# @yield [result, err] Result & error if block supplied
|
1470
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
|
1471
|
+
# @yieldparam err [StandardError] error object if request failed
|
1472
|
+
#
|
1473
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
|
1474
|
+
#
|
1475
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1476
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1477
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1478
|
+
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)
|
1479
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
|
1480
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
|
1481
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
|
1482
|
+
command.params['parent'] = parent unless parent.nil?
|
1483
|
+
command.query['ets'] = ets unless ets.nil?
|
1484
|
+
command.query['uri'] = uri unless uri.nil?
|
1485
|
+
command.query['userEvent'] = user_event unless user_event.nil?
|
1486
|
+
command.query['fields'] = fields unless fields.nil?
|
1487
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1488
|
+
execute_or_queue_command(command, &block)
|
1489
|
+
end
|
1490
|
+
|
1491
|
+
# Bulk import of User events. Request processing might be synchronous. Events
|
1492
|
+
# that already exist are skipped. Use this method for backfilling historical
|
1493
|
+
# user events. Operation.response is of type ImportResponse. Note that it is
|
1494
|
+
# possible for a subset of the items to be successfully inserted. Operation.
|
1495
|
+
# metadata is of type ImportMetadata.
|
1496
|
+
# @param [String] parent
|
1497
|
+
# Required. Parent DataStore resource name, of the form `projects/`project`/
|
1498
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
1499
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
1500
|
+
# @param [String] fields
|
1501
|
+
# Selector specifying which fields to include in a partial response.
|
1502
|
+
# @param [String] quota_user
|
1503
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1504
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1505
|
+
# @param [Google::Apis::RequestOptions] options
|
1506
|
+
# Request-specific options
|
1507
|
+
#
|
1508
|
+
# @yield [result, err] Result & error if block supplied
|
1509
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1510
|
+
# @yieldparam err [StandardError] error object if request failed
|
1511
|
+
#
|
1512
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1513
|
+
#
|
1514
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1515
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1516
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1517
|
+
def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1518
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
|
1519
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
|
1520
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
1521
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1522
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1523
|
+
command.params['parent'] = parent unless parent.nil?
|
1524
|
+
command.query['fields'] = fields unless fields.nil?
|
1525
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1526
|
+
execute_or_queue_command(command, &block)
|
1527
|
+
end
|
1528
|
+
|
1529
|
+
# Deletes permanently all user events specified by the filter provided.
|
1530
|
+
# Depending on the number of events specified by the filter, this operation
|
1531
|
+
# could take hours or days to complete. To test a filter, use the list command
|
1532
|
+
# first.
|
1533
|
+
# @param [String] parent
|
1534
|
+
# Required. The resource name of the catalog under which the events are created.
|
1535
|
+
# The format is `projects/$`projectId`/locations/global/collections/`$
|
1536
|
+
# collectionId`/dataStores/$`dataStoreId``
|
1537
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
|
1538
|
+
# @param [String] fields
|
1539
|
+
# Selector specifying which fields to include in a partial response.
|
1540
|
+
# @param [String] quota_user
|
1541
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1542
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1543
|
+
# @param [Google::Apis::RequestOptions] options
|
1544
|
+
# Request-specific options
|
1545
|
+
#
|
1546
|
+
# @yield [result, err] Result & error if block supplied
|
1547
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1548
|
+
# @yieldparam err [StandardError] error object if request failed
|
1549
|
+
#
|
1550
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1551
|
+
#
|
1552
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1553
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1554
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1555
|
+
def purge_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1556
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:purge', options)
|
1557
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest::Representation
|
1558
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
|
1559
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1560
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1561
|
+
command.params['parent'] = parent unless parent.nil?
|
1562
|
+
command.query['fields'] = fields unless fields.nil?
|
1563
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1564
|
+
execute_or_queue_command(command, &block)
|
1565
|
+
end
|
1566
|
+
|
1567
|
+
# Writes a single user event.
|
1568
|
+
# @param [String] parent
|
1569
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
1570
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
1571
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
|
1572
|
+
# @param [String] fields
|
1573
|
+
# Selector specifying which fields to include in a partial response.
|
1574
|
+
# @param [String] quota_user
|
1575
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1576
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1577
|
+
# @param [Google::Apis::RequestOptions] options
|
1578
|
+
# Request-specific options
|
1579
|
+
#
|
1580
|
+
# @yield [result, err] Result & error if block supplied
|
1581
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] parsed result object
|
1582
|
+
# @yieldparam err [StandardError] error object if request failed
|
1583
|
+
#
|
1584
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
|
1585
|
+
#
|
1586
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1587
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1588
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1589
|
+
def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1590
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
|
1591
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
|
1592
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
|
1593
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
|
1594
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
|
1595
|
+
command.params['parent'] = parent unless parent.nil?
|
1596
|
+
command.query['fields'] = fields unless fields.nil?
|
1597
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1598
|
+
execute_or_queue_command(command, &block)
|
1599
|
+
end
|
1600
|
+
|
1601
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1602
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1603
|
+
# @param [String] name
|
1604
|
+
# The name of the operation resource.
|
1605
|
+
# @param [String] fields
|
1606
|
+
# Selector specifying which fields to include in a partial response.
|
1607
|
+
# @param [String] quota_user
|
1608
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1609
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1610
|
+
# @param [Google::Apis::RequestOptions] options
|
1611
|
+
# Request-specific options
|
1612
|
+
#
|
1613
|
+
# @yield [result, err] Result & error if block supplied
|
1614
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1615
|
+
# @yieldparam err [StandardError] error object if request failed
|
1616
|
+
#
|
1617
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1618
|
+
#
|
1619
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1620
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1621
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1622
|
+
def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1623
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1624
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1625
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1626
|
+
command.params['name'] = name unless name.nil?
|
1627
|
+
command.query['fields'] = fields unless fields.nil?
|
1628
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1629
|
+
execute_or_queue_command(command, &block)
|
1630
|
+
end
|
1631
|
+
|
1632
|
+
# Lists operations that match the specified filter in the request. If the server
|
1633
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
1634
|
+
# @param [String] name
|
1635
|
+
# The name of the operation's parent resource.
|
1636
|
+
# @param [String] filter
|
1637
|
+
# The standard list filter.
|
1638
|
+
# @param [Fixnum] page_size
|
1639
|
+
# The standard list page size.
|
1640
|
+
# @param [String] page_token
|
1641
|
+
# The standard list page token.
|
1642
|
+
# @param [String] fields
|
1643
|
+
# Selector specifying which fields to include in a partial response.
|
1644
|
+
# @param [String] quota_user
|
1645
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1646
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1647
|
+
# @param [Google::Apis::RequestOptions] options
|
1648
|
+
# Request-specific options
|
1649
|
+
#
|
1650
|
+
# @yield [result, err] Result & error if block supplied
|
1651
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
1652
|
+
# @yieldparam err [StandardError] error object if request failed
|
1653
|
+
#
|
1654
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
1655
|
+
#
|
1656
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1657
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1658
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1659
|
+
def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1660
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
1661
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
1662
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
1663
|
+
command.params['name'] = name unless name.nil?
|
1664
|
+
command.query['filter'] = filter unless filter.nil?
|
1665
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1666
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1667
|
+
command.query['fields'] = fields unless fields.nil?
|
1668
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1669
|
+
execute_or_queue_command(command, &block)
|
1670
|
+
end
|
1671
|
+
|
1672
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1673
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1674
|
+
# @param [String] name
|
1675
|
+
# The name of the operation resource.
|
1676
|
+
# @param [String] fields
|
1677
|
+
# Selector specifying which fields to include in a partial response.
|
1678
|
+
# @param [String] quota_user
|
1679
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1680
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1681
|
+
# @param [Google::Apis::RequestOptions] options
|
1682
|
+
# Request-specific options
|
1683
|
+
#
|
1684
|
+
# @yield [result, err] Result & error if block supplied
|
1685
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1686
|
+
# @yieldparam err [StandardError] error object if request failed
|
1687
|
+
#
|
1688
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1689
|
+
#
|
1690
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1691
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1692
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1693
|
+
def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1694
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1695
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1696
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1697
|
+
command.params['name'] = name unless name.nil?
|
1698
|
+
command.query['fields'] = fields unless fields.nil?
|
1699
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1700
|
+
execute_or_queue_command(command, &block)
|
1701
|
+
end
|
1702
|
+
|
1703
|
+
# Lists operations that match the specified filter in the request. If the server
|
1704
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
1705
|
+
# @param [String] name
|
1706
|
+
# The name of the operation's parent resource.
|
1707
|
+
# @param [String] filter
|
1708
|
+
# The standard list filter.
|
1709
|
+
# @param [Fixnum] page_size
|
1710
|
+
# The standard list page size.
|
1711
|
+
# @param [String] page_token
|
1712
|
+
# The standard list page token.
|
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::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
1723
|
+
# @yieldparam err [StandardError] error object if request failed
|
1724
|
+
#
|
1725
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
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 list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1731
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
1732
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
1733
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
1734
|
+
command.params['name'] = name unless name.nil?
|
1735
|
+
command.query['filter'] = filter unless filter.nil?
|
1736
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1737
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1738
|
+
command.query['fields'] = fields unless fields.nil?
|
1739
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1740
|
+
execute_or_queue_command(command, &block)
|
1741
|
+
end
|
1742
|
+
|
1743
|
+
# Completes the specified user input with keyword suggestions.
|
1744
|
+
# @param [String] data_store
|
1745
|
+
# Required. The parent data store resource name for which the completion is
|
1746
|
+
# performed, such as `projects/*/locations/global/collections/default_collection/
|
1747
|
+
# dataStores/default_data_store`.
|
1748
|
+
# @param [Boolean] include_tail_suggestions
|
1749
|
+
# Indicates if tail suggestions should be returned if there are no suggestions
|
1750
|
+
# that match the full query. Even if set to true, if there are suggestions that
|
1751
|
+
# match the full query, those are returned and no tail suggestions are returned.
|
1752
|
+
# @param [String] query
|
1753
|
+
# Required. The typeahead input used to fetch suggestions. Maximum length is 128
|
1754
|
+
# characters.
|
1755
|
+
# @param [String] query_model
|
1756
|
+
# Selects data model of query suggestions for serving. Currently supported
|
1757
|
+
# values: * `document` - Using suggestions generated from user-imported
|
1758
|
+
# documents. * `search-history` - Using suggestions generated from the past
|
1759
|
+
# history of SearchService.Search API calls. Do not use it when there is no
|
1760
|
+
# traffic for Search API. * `user-event` - Using suggestions generated from user-
|
1761
|
+
# imported search events. * `document-completable` - Using suggestions taken
|
1762
|
+
# directly from user-imported document fields marked as completable. Default
|
1763
|
+
# values: * `document` is the default model for regular dataStores. * `search-
|
1764
|
+
# history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
|
1765
|
+
# @param [String] user_pseudo_id
|
1766
|
+
# A unique identifier for tracking visitors. For example, this could be
|
1767
|
+
# implemented with an HTTP cookie, which should be able to uniquely identify a
|
1768
|
+
# visitor on a single device. This unique identifier should not change if the
|
1769
|
+
# visitor logs in or out of the website. This field should NOT have a fixed
|
1770
|
+
# value such as `unknown_visitor`. This should be the same identifier as
|
1771
|
+
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
1772
|
+
# UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
|
1773
|
+
# INVALID_ARGUMENT` error is returned.
|
1774
|
+
# @param [String] fields
|
1775
|
+
# Selector specifying which fields to include in a partial response.
|
1776
|
+
# @param [String] quota_user
|
1777
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1778
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1779
|
+
# @param [Google::Apis::RequestOptions] options
|
1780
|
+
# Request-specific options
|
1781
|
+
#
|
1782
|
+
# @yield [result, err] Result & error if block supplied
|
1783
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse] parsed result object
|
1784
|
+
# @yieldparam err [StandardError] error object if request failed
|
1785
|
+
#
|
1786
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse]
|
1787
|
+
#
|
1788
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1789
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1790
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1791
|
+
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)
|
1792
|
+
command = make_simple_command(:get, 'v1alpha/{+dataStore}:completeQuery', options)
|
1793
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse::Representation
|
1794
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse
|
1795
|
+
command.params['dataStore'] = data_store unless data_store.nil?
|
1796
|
+
command.query['includeTailSuggestions'] = include_tail_suggestions unless include_tail_suggestions.nil?
|
1797
|
+
command.query['query'] = query unless query.nil?
|
1798
|
+
command.query['queryModel'] = query_model unless query_model.nil?
|
1799
|
+
command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
|
1800
|
+
command.query['fields'] = fields unless fields.nil?
|
1801
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1802
|
+
execute_or_queue_command(command, &block)
|
1803
|
+
end
|
1804
|
+
|
1805
|
+
# Creates a Document.
|
1806
|
+
# @param [String] parent
|
1807
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
1808
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
1809
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
1810
|
+
# @param [String] document_id
|
1811
|
+
# Required. The ID to use for the Document, which will become the final
|
1812
|
+
# component of the Document.name. If the caller does not have permission to
|
1813
|
+
# create the Document, regardless of whether or not it exists, a `
|
1814
|
+
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
1815
|
+
# Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
1816
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
1817
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
1818
|
+
# INVALID_ARGUMENT` error is returned.
|
1819
|
+
# @param [String] fields
|
1820
|
+
# Selector specifying which fields to include in a partial response.
|
1821
|
+
# @param [String] quota_user
|
1822
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1823
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1824
|
+
# @param [Google::Apis::RequestOptions] options
|
1825
|
+
# Request-specific options
|
1826
|
+
#
|
1827
|
+
# @yield [result, err] Result & error if block supplied
|
1828
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
|
1829
|
+
# @yieldparam err [StandardError] error object if request failed
|
1830
|
+
#
|
1831
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
|
1832
|
+
#
|
1833
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1834
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1835
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1836
|
+
def create_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1alpha_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1837
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/documents', options)
|
1838
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
1839
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_document_object
|
1840
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
1841
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
|
1842
|
+
command.params['parent'] = parent unless parent.nil?
|
1843
|
+
command.query['documentId'] = document_id unless document_id.nil?
|
1844
|
+
command.query['fields'] = fields unless fields.nil?
|
1845
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1846
|
+
execute_or_queue_command(command, &block)
|
1847
|
+
end
|
1848
|
+
|
1849
|
+
# Deletes a Document.
|
1850
|
+
# @param [String] name
|
1851
|
+
# Required. Full resource name of Document, such as `projects/`project`/
|
1852
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
1853
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
1854
|
+
# delete the Document, regardless of whether or not it exists, a `
|
1855
|
+
# PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
|
1856
|
+
# a `NOT_FOUND` error is returned.
|
1857
|
+
# @param [String] fields
|
1858
|
+
# Selector specifying which fields to include in a partial response.
|
1859
|
+
# @param [String] quota_user
|
1860
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1861
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1862
|
+
# @param [Google::Apis::RequestOptions] options
|
1863
|
+
# Request-specific options
|
1864
|
+
#
|
1865
|
+
# @yield [result, err] Result & error if block supplied
|
1866
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
1867
|
+
# @yieldparam err [StandardError] error object if request failed
|
1868
|
+
#
|
1869
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
1870
|
+
#
|
1871
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1872
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1873
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1874
|
+
def delete_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
1875
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
1876
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
1877
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
1878
|
+
command.params['name'] = name unless name.nil?
|
1879
|
+
command.query['fields'] = fields unless fields.nil?
|
1880
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1881
|
+
execute_or_queue_command(command, &block)
|
1882
|
+
end
|
1883
|
+
|
1884
|
+
# Gets a Document.
|
1885
|
+
# @param [String] name
|
1886
|
+
# Required. Full resource name of Document, such as `projects/`project`/
|
1887
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
1888
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
1889
|
+
# access the Document, regardless of whether or not it exists, a `
|
1890
|
+
# PERMISSION_DENIED` error is returned. If the requested Document does not exist,
|
1891
|
+
# a `NOT_FOUND` error is returned.
|
1892
|
+
# @param [String] fields
|
1893
|
+
# Selector specifying which fields to include in a partial response.
|
1894
|
+
# @param [String] quota_user
|
1895
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1896
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1897
|
+
# @param [Google::Apis::RequestOptions] options
|
1898
|
+
# Request-specific options
|
1899
|
+
#
|
1900
|
+
# @yield [result, err] Result & error if block supplied
|
1901
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
|
1902
|
+
# @yieldparam err [StandardError] error object if request failed
|
1903
|
+
#
|
1904
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
|
1905
|
+
#
|
1906
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1907
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1908
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1909
|
+
def get_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
1910
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1911
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
1912
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
|
1913
|
+
command.params['name'] = name unless name.nil?
|
1914
|
+
command.query['fields'] = fields unless fields.nil?
|
1915
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1916
|
+
execute_or_queue_command(command, &block)
|
1917
|
+
end
|
1918
|
+
|
1919
|
+
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
1920
|
+
# existing items will be created. Note: It is possible for a subset of the
|
1921
|
+
# Documents to be successfully updated.
|
1922
|
+
# @param [String] parent
|
1923
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
1924
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
1925
|
+
# `branch``. Requires create/update permission.
|
1926
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest] google_cloud_discoveryengine_v1alpha_import_documents_request_object
|
1927
|
+
# @param [String] fields
|
1928
|
+
# Selector specifying which fields to include in a partial response.
|
1929
|
+
# @param [String] quota_user
|
1930
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1931
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1932
|
+
# @param [Google::Apis::RequestOptions] options
|
1933
|
+
# Request-specific options
|
1934
|
+
#
|
1935
|
+
# @yield [result, err] Result & error if block supplied
|
1936
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1937
|
+
# @yieldparam err [StandardError] error object if request failed
|
1938
|
+
#
|
1939
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1940
|
+
#
|
1941
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1942
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1943
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1944
|
+
def import_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1alpha_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1945
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/documents:import', options)
|
1946
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest::Representation
|
1947
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_documents_request_object
|
1948
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1949
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1950
|
+
command.params['parent'] = parent unless parent.nil?
|
1951
|
+
command.query['fields'] = fields unless fields.nil?
|
1952
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1953
|
+
execute_or_queue_command(command, &block)
|
1954
|
+
end
|
1955
|
+
|
1956
|
+
# Gets a list of Documents.
|
1957
|
+
# @param [String] parent
|
1958
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
1959
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
1960
|
+
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
1961
|
+
# default branch. If the caller does not have permission to list Documents under
|
1962
|
+
# this branch, regardless of whether or not this branch exists, a `
|
1963
|
+
# PERMISSION_DENIED` error is returned.
|
1964
|
+
# @param [Fixnum] page_size
|
1965
|
+
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
1966
|
+
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
1967
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
1968
|
+
# @param [String] page_token
|
1969
|
+
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
1970
|
+
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
1971
|
+
# page. When paginating, all other parameters provided to DocumentService.
|
1972
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
1973
|
+
# INVALID_ARGUMENT` error is returned.
|
1974
|
+
# @param [String] fields
|
1975
|
+
# Selector specifying which fields to include in a partial response.
|
1976
|
+
# @param [String] quota_user
|
1977
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1978
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1979
|
+
# @param [Google::Apis::RequestOptions] options
|
1980
|
+
# Request-specific options
|
1981
|
+
#
|
1982
|
+
# @yield [result, err] Result & error if block supplied
|
1983
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse] parsed result object
|
1984
|
+
# @yieldparam err [StandardError] error object if request failed
|
1985
|
+
#
|
1986
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse]
|
1987
|
+
#
|
1988
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1989
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1990
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1991
|
+
def list_project_location_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1992
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/documents', options)
|
1993
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse::Representation
|
1994
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse
|
1995
|
+
command.params['parent'] = parent unless parent.nil?
|
1996
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1997
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1998
|
+
command.query['fields'] = fields unless fields.nil?
|
1999
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2000
|
+
execute_or_queue_command(command, &block)
|
2001
|
+
end
|
2002
|
+
|
2003
|
+
# Updates a Document.
|
2004
|
+
# @param [String] name
|
2005
|
+
# Immutable. The full resource name of the document. Format: `projects/`project`/
|
2006
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
2007
|
+
# `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
|
2008
|
+
# with a length limit of 1024 characters.
|
2009
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
2010
|
+
# @param [Boolean] allow_missing
|
2011
|
+
# If set to true, and the Document is not found, a new Document will be created.
|
2012
|
+
# @param [String] fields
|
2013
|
+
# Selector specifying which fields to include in a partial response.
|
2014
|
+
# @param [String] quota_user
|
2015
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2016
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2017
|
+
# @param [Google::Apis::RequestOptions] options
|
2018
|
+
# Request-specific options
|
2019
|
+
#
|
2020
|
+
# @yield [result, err] Result & error if block supplied
|
2021
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
|
2022
|
+
# @yieldparam err [StandardError] error object if request failed
|
2023
|
+
#
|
2024
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
|
2025
|
+
#
|
2026
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2027
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2028
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2029
|
+
def patch_project_location_data_store_branch_document(name, google_cloud_discoveryengine_v1alpha_document_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2030
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
2031
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
2032
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_document_object
|
2033
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
2034
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
|
2035
|
+
command.params['name'] = name unless name.nil?
|
2036
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
2037
|
+
command.query['fields'] = fields unless fields.nil?
|
2038
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2039
|
+
execute_or_queue_command(command, &block)
|
2040
|
+
end
|
2041
|
+
|
2042
|
+
# Permanently deletes all selected Documents in a branch. This process is
|
2043
|
+
# asynchronous. Depending on the number of Documents to be deleted, this
|
2044
|
+
# operation can take hours to complete. Before the delete operation completes,
|
2045
|
+
# some Documents might still be returned by DocumentService.GetDocument or
|
2046
|
+
# DocumentService.ListDocuments. To get a list of the Documents to be deleted,
|
2047
|
+
# set PurgeDocumentsRequest.force to false.
|
2048
|
+
# @param [String] parent
|
2049
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
2050
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
2051
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest] google_cloud_discoveryengine_v1alpha_purge_documents_request_object
|
2052
|
+
# @param [String] fields
|
2053
|
+
# Selector specifying which fields to include in a partial response.
|
2054
|
+
# @param [String] quota_user
|
2055
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2056
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2057
|
+
# @param [Google::Apis::RequestOptions] options
|
2058
|
+
# Request-specific options
|
2059
|
+
#
|
2060
|
+
# @yield [result, err] Result & error if block supplied
|
2061
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
2062
|
+
# @yieldparam err [StandardError] error object if request failed
|
2063
|
+
#
|
2064
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
2065
|
+
#
|
2066
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2067
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2068
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2069
|
+
def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1alpha_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2070
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/documents:purge', options)
|
2071
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest::Representation
|
2072
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_purge_documents_request_object
|
2073
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
2074
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
2075
|
+
command.params['parent'] = parent unless parent.nil?
|
2076
|
+
command.query['fields'] = fields unless fields.nil?
|
2077
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2078
|
+
execute_or_queue_command(command, &block)
|
2079
|
+
end
|
2080
|
+
|
2081
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
2082
|
+
# to poll the operation result at intervals as recommended by the API service.
|
2083
|
+
# @param [String] name
|
2084
|
+
# The name of the operation resource.
|
2085
|
+
# @param [String] fields
|
2086
|
+
# Selector specifying which fields to include in a partial response.
|
2087
|
+
# @param [String] quota_user
|
2088
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2089
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2090
|
+
# @param [Google::Apis::RequestOptions] options
|
2091
|
+
# Request-specific options
|
2092
|
+
#
|
2093
|
+
# @yield [result, err] Result & error if block supplied
|
2094
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
2095
|
+
# @yieldparam err [StandardError] error object if request failed
|
2096
|
+
#
|
2097
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
2098
|
+
#
|
2099
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2100
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2101
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2102
|
+
def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2103
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
2104
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
2105
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
2106
|
+
command.params['name'] = name unless name.nil?
|
2107
|
+
command.query['fields'] = fields unless fields.nil?
|
2108
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2109
|
+
execute_or_queue_command(command, &block)
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# Lists operations that match the specified filter in the request. If the server
|
2113
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
2114
|
+
# @param [String] name
|
2115
|
+
# The name of the operation's parent resource.
|
2116
|
+
# @param [String] filter
|
2117
|
+
# The standard list filter.
|
2118
|
+
# @param [Fixnum] page_size
|
2119
|
+
# The standard list page size.
|
2120
|
+
# @param [String] page_token
|
2121
|
+
# The standard list page token.
|
2122
|
+
# @param [String] fields
|
2123
|
+
# Selector specifying which fields to include in a partial response.
|
2124
|
+
# @param [String] quota_user
|
2125
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2126
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2127
|
+
# @param [Google::Apis::RequestOptions] options
|
2128
|
+
# Request-specific options
|
2129
|
+
#
|
2130
|
+
# @yield [result, err] Result & error if block supplied
|
2131
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
2132
|
+
# @yieldparam err [StandardError] error object if request failed
|
2133
|
+
#
|
2134
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
2135
|
+
#
|
2136
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2137
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2138
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2139
|
+
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)
|
2140
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
2141
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
2142
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
2143
|
+
command.params['name'] = name unless name.nil?
|
2144
|
+
command.query['filter'] = filter unless filter.nil?
|
2145
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2146
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2147
|
+
command.query['fields'] = fields unless fields.nil?
|
2148
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2149
|
+
execute_or_queue_command(command, &block)
|
2150
|
+
end
|
2151
|
+
|
2152
|
+
# Converses a conversation.
|
2153
|
+
# @param [String] name
|
2154
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
2155
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2156
|
+
# data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
|
2157
|
+
# /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
|
2158
|
+
# conversations/-` to activate auto session mode, which automatically creates a
|
2159
|
+
# new conversation inside a ConverseConversation session.
|
2160
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest] google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
|
1142
2161
|
# @param [String] fields
|
1143
2162
|
# Selector specifying which fields to include in a partial response.
|
1144
2163
|
# @param [String] quota_user
|
@@ -1148,32 +2167,33 @@ module Google
|
|
1148
2167
|
# Request-specific options
|
1149
2168
|
#
|
1150
2169
|
# @yield [result, err] Result & error if block supplied
|
1151
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
2170
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse] parsed result object
|
1152
2171
|
# @yieldparam err [StandardError] error object if request failed
|
1153
2172
|
#
|
1154
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
2173
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse]
|
1155
2174
|
#
|
1156
2175
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1157
2176
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1158
2177
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1159
|
-
def
|
1160
|
-
command = make_simple_command(:
|
1161
|
-
command.
|
1162
|
-
command.
|
2178
|
+
def converse_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1alpha_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2179
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:converse', options)
|
2180
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest::Representation
|
2181
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
|
2182
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse::Representation
|
2183
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse
|
1163
2184
|
command.params['name'] = name unless name.nil?
|
1164
2185
|
command.query['fields'] = fields unless fields.nil?
|
1165
2186
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1166
2187
|
execute_or_queue_command(command, &block)
|
1167
2188
|
end
|
1168
2189
|
|
1169
|
-
#
|
1170
|
-
#
|
1171
|
-
#
|
1172
|
-
#
|
1173
|
-
#
|
1174
|
-
#
|
1175
|
-
#
|
1176
|
-
# a `NOT_FOUND` error is returned.
|
2190
|
+
# Creates a Conversation. If the Conversation to create already exists, an
|
2191
|
+
# ALREADY_EXISTS error is returned.
|
2192
|
+
# @param [String] parent
|
2193
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
2194
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2195
|
+
# data_store_id``
|
2196
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
|
1177
2197
|
# @param [String] fields
|
1178
2198
|
# Selector specifying which fields to include in a partial response.
|
1179
2199
|
# @param [String] quota_user
|
@@ -1183,32 +2203,32 @@ module Google
|
|
1183
2203
|
# Request-specific options
|
1184
2204
|
#
|
1185
2205
|
# @yield [result, err] Result & error if block supplied
|
1186
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
2206
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
|
1187
2207
|
# @yieldparam err [StandardError] error object if request failed
|
1188
2208
|
#
|
1189
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
2209
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
|
1190
2210
|
#
|
1191
2211
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1192
2212
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1193
2213
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1194
|
-
def
|
1195
|
-
command = make_simple_command(:
|
1196
|
-
command.
|
1197
|
-
command.
|
1198
|
-
command.
|
2214
|
+
def create_project_location_data_store_conversation(parent, google_cloud_discoveryengine_v1alpha_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2215
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/conversations', options)
|
2216
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
2217
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
|
2218
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
2219
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
|
2220
|
+
command.params['parent'] = parent unless parent.nil?
|
1199
2221
|
command.query['fields'] = fields unless fields.nil?
|
1200
2222
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1201
2223
|
execute_or_queue_command(command, &block)
|
1202
2224
|
end
|
1203
2225
|
|
1204
|
-
#
|
1205
|
-
#
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
#
|
1210
|
-
# `branch``. Requires create/update permission.
|
1211
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest] google_cloud_discoveryengine_v1alpha_import_documents_request_object
|
2226
|
+
# Deletes a Conversation. If the Conversation to delete does not exist, a
|
2227
|
+
# NOT_FOUND error is returned.
|
2228
|
+
# @param [String] name
|
2229
|
+
# Required. The resource name of the Conversation to delete. Format: `projects/`
|
2230
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2231
|
+
# data_store_id`/conversations/`conversation_id``
|
1212
2232
|
# @param [String] fields
|
1213
2233
|
# Selector specifying which fields to include in a partial response.
|
1214
2234
|
# @param [String] quota_user
|
@@ -1218,44 +2238,29 @@ module Google
|
|
1218
2238
|
# Request-specific options
|
1219
2239
|
#
|
1220
2240
|
# @yield [result, err] Result & error if block supplied
|
1221
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
2241
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
1222
2242
|
# @yieldparam err [StandardError] error object if request failed
|
1223
2243
|
#
|
1224
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
2244
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
1225
2245
|
#
|
1226
2246
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1227
2247
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1228
2248
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1229
|
-
def
|
1230
|
-
command = make_simple_command(:
|
1231
|
-
command.
|
1232
|
-
command.
|
1233
|
-
command.
|
1234
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1235
|
-
command.params['parent'] = parent unless parent.nil?
|
2249
|
+
def delete_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2250
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
2251
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
2252
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
2253
|
+
command.params['name'] = name unless name.nil?
|
1236
2254
|
command.query['fields'] = fields unless fields.nil?
|
1237
2255
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1238
2256
|
execute_or_queue_command(command, &block)
|
1239
2257
|
end
|
1240
2258
|
|
1241
|
-
# Gets a
|
1242
|
-
# @param [String]
|
1243
|
-
# Required. The
|
1244
|
-
# locations/`
|
1245
|
-
#
|
1246
|
-
# default branch. If the caller does not have permission to list Documents under
|
1247
|
-
# this branch, regardless of whether or not this branch exists, a `
|
1248
|
-
# PERMISSION_DENIED` error is returned.
|
1249
|
-
# @param [Fixnum] page_size
|
1250
|
-
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
1251
|
-
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
1252
|
-
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
1253
|
-
# @param [String] page_token
|
1254
|
-
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
1255
|
-
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
1256
|
-
# page. When paginating, all other parameters provided to DocumentService.
|
1257
|
-
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
1258
|
-
# INVALID_ARGUMENT` error is returned.
|
2259
|
+
# Gets a Conversation.
|
2260
|
+
# @param [String] name
|
2261
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
2262
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2263
|
+
# data_store_id`/conversations/`conversation_id``
|
1259
2264
|
# @param [String] fields
|
1260
2265
|
# Selector specifying which fields to include in a partial response.
|
1261
2266
|
# @param [String] quota_user
|
@@ -1265,35 +2270,41 @@ module Google
|
|
1265
2270
|
# Request-specific options
|
1266
2271
|
#
|
1267
2272
|
# @yield [result, err] Result & error if block supplied
|
1268
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
2273
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
|
1269
2274
|
# @yieldparam err [StandardError] error object if request failed
|
1270
2275
|
#
|
1271
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
2276
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
|
1272
2277
|
#
|
1273
2278
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1274
2279
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1275
2280
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1276
|
-
def
|
1277
|
-
command = make_simple_command(:get, 'v1alpha/{+
|
1278
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
1279
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
1280
|
-
command.params['
|
1281
|
-
command.query['pageSize'] = page_size unless page_size.nil?
|
1282
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
2281
|
+
def get_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2282
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
2283
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
2284
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
|
2285
|
+
command.params['name'] = name unless name.nil?
|
1283
2286
|
command.query['fields'] = fields unless fields.nil?
|
1284
2287
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1285
2288
|
execute_or_queue_command(command, &block)
|
1286
2289
|
end
|
1287
2290
|
|
1288
|
-
#
|
1289
|
-
# @param [String]
|
1290
|
-
#
|
1291
|
-
# locations/`
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
# @param [
|
1296
|
-
#
|
2291
|
+
# Lists all Conversations by their parent DataStore.
|
2292
|
+
# @param [String] parent
|
2293
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
2294
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
2295
|
+
# @param [String] filter
|
2296
|
+
# A filter to apply on the list results. The supported features are:
|
2297
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
2298
|
+
# @param [String] order_by
|
2299
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
2300
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
2301
|
+
# create_time` * `conversation_name` Example: "update_time desc" "create_time"
|
2302
|
+
# @param [Fixnum] page_size
|
2303
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
2304
|
+
# allowed value is 1000.
|
2305
|
+
# @param [String] page_token
|
2306
|
+
# A page token, received from a previous `ListConversations` call. Provide this
|
2307
|
+
# to retrieve the subsequent page.
|
1297
2308
|
# @param [String] fields
|
1298
2309
|
# Selector specifying which fields to include in a partial response.
|
1299
2310
|
# @param [String] quota_user
|
@@ -1303,37 +2314,38 @@ module Google
|
|
1303
2314
|
# Request-specific options
|
1304
2315
|
#
|
1305
2316
|
# @yield [result, err] Result & error if block supplied
|
1306
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
2317
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse] parsed result object
|
1307
2318
|
# @yieldparam err [StandardError] error object if request failed
|
1308
2319
|
#
|
1309
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
2320
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse]
|
1310
2321
|
#
|
1311
2322
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1312
2323
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1313
2324
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1314
|
-
def
|
1315
|
-
command = make_simple_command(:
|
1316
|
-
command.
|
1317
|
-
command.
|
1318
|
-
command.
|
1319
|
-
command.
|
1320
|
-
command.
|
1321
|
-
command.query['
|
2325
|
+
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)
|
2326
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/conversations', options)
|
2327
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse::Representation
|
2328
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse
|
2329
|
+
command.params['parent'] = parent unless parent.nil?
|
2330
|
+
command.query['filter'] = filter unless filter.nil?
|
2331
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2332
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2333
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1322
2334
|
command.query['fields'] = fields unless fields.nil?
|
1323
2335
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1324
2336
|
execute_or_queue_command(command, &block)
|
1325
2337
|
end
|
1326
2338
|
|
1327
|
-
#
|
1328
|
-
#
|
1329
|
-
#
|
1330
|
-
#
|
1331
|
-
#
|
1332
|
-
#
|
1333
|
-
# @param [String]
|
1334
|
-
#
|
1335
|
-
#
|
1336
|
-
#
|
2339
|
+
# Updates a Conversation. Conversation action type cannot be changed. If the
|
2340
|
+
# Conversation to update does not exist, a NOT_FOUND error is returned.
|
2341
|
+
# @param [String] name
|
2342
|
+
# Immutable. Fully qualified name `project/*/locations/global/collections/`
|
2343
|
+
# collection`/dataStore/*/conversations/*`
|
2344
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
|
2345
|
+
# @param [String] update_mask
|
2346
|
+
# Indicates which fields in the provided Conversation to update. The following
|
2347
|
+
# are NOT supported: * conversation.name If not set or empty, all supported
|
2348
|
+
# fields are updated.
|
1337
2349
|
# @param [String] fields
|
1338
2350
|
# Selector specifying which fields to include in a partial response.
|
1339
2351
|
# @param [String] quota_user
|
@@ -1343,21 +2355,22 @@ module Google
|
|
1343
2355
|
# Request-specific options
|
1344
2356
|
#
|
1345
2357
|
# @yield [result, err] Result & error if block supplied
|
1346
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
2358
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
|
1347
2359
|
# @yieldparam err [StandardError] error object if request failed
|
1348
2360
|
#
|
1349
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
2361
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
|
1350
2362
|
#
|
1351
2363
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1352
2364
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1353
2365
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1354
|
-
def
|
1355
|
-
command = make_simple_command(:
|
1356
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
1357
|
-
command.request_object =
|
1358
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
1359
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
1360
|
-
command.params['
|
2366
|
+
def patch_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1alpha_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2367
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
2368
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
2369
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
|
2370
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
|
2371
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
|
2372
|
+
command.params['name'] = name unless name.nil?
|
2373
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1361
2374
|
command.query['fields'] = fields unless fields.nil?
|
1362
2375
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1363
2376
|
execute_or_queue_command(command, &block)
|
@@ -1384,7 +2397,7 @@ module Google
|
|
1384
2397
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1385
2398
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1386
2399
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1387
|
-
def
|
2400
|
+
def get_project_location_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1388
2401
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1389
2402
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1390
2403
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
@@ -1421,7 +2434,7 @@ module Google
|
|
1421
2434
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1422
2435
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1423
2436
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1424
|
-
def
|
2437
|
+
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)
|
1425
2438
|
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
1426
2439
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
1427
2440
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
@@ -1455,7 +2468,7 @@ module Google
|
|
1455
2468
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1456
2469
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1457
2470
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1458
|
-
def
|
2471
|
+
def get_project_location_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1459
2472
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1460
2473
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1461
2474
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
@@ -1492,7 +2505,7 @@ module Google
|
|
1492
2505
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1493
2506
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1494
2507
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1495
|
-
def
|
2508
|
+
def list_project_location_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1496
2509
|
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
1497
2510
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
1498
2511
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
@@ -1505,10 +2518,51 @@ module Google
|
|
1505
2518
|
execute_or_queue_command(command, &block)
|
1506
2519
|
end
|
1507
2520
|
|
1508
|
-
#
|
1509
|
-
#
|
2521
|
+
# Creates a Schema.
|
2522
|
+
# @param [String] parent
|
2523
|
+
# Required. The parent data store resource name, in the format of `projects/`
|
2524
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store``
|
2525
|
+
# .
|
2526
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
2527
|
+
# @param [String] schema_id
|
2528
|
+
# Required. The ID to use for the Schema, which will become the final component
|
2529
|
+
# of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
2530
|
+
# org/html/rfc1034) standard with a length limit of 63 characters.
|
2531
|
+
# @param [String] fields
|
2532
|
+
# Selector specifying which fields to include in a partial response.
|
2533
|
+
# @param [String] quota_user
|
2534
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2535
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2536
|
+
# @param [Google::Apis::RequestOptions] options
|
2537
|
+
# Request-specific options
|
2538
|
+
#
|
2539
|
+
# @yield [result, err] Result & error if block supplied
|
2540
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
2541
|
+
# @yieldparam err [StandardError] error object if request failed
|
2542
|
+
#
|
2543
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
2544
|
+
#
|
2545
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2546
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2547
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2548
|
+
def create_project_location_data_store_schema(parent, google_cloud_discoveryengine_v1alpha_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2549
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/schemas', options)
|
2550
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema::Representation
|
2551
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_schema_object
|
2552
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
2553
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
2554
|
+
command.params['parent'] = parent unless parent.nil?
|
2555
|
+
command.query['schemaId'] = schema_id unless schema_id.nil?
|
2556
|
+
command.query['fields'] = fields unless fields.nil?
|
2557
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2558
|
+
execute_or_queue_command(command, &block)
|
2559
|
+
end
|
2560
|
+
|
2561
|
+
# Deletes a Schema.
|
1510
2562
|
# @param [String] name
|
1511
|
-
# The name of the
|
2563
|
+
# Required. The full resource name of the schema, in the format of `projects/`
|
2564
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
2565
|
+
# schemas/`schema``.
|
1512
2566
|
# @param [String] fields
|
1513
2567
|
# Selector specifying which fields to include in a partial response.
|
1514
2568
|
# @param [String] quota_user
|
@@ -1526,8 +2580,8 @@ module Google
|
|
1526
2580
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1527
2581
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1528
2582
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1529
|
-
def
|
1530
|
-
command = make_simple_command(:
|
2583
|
+
def delete_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
|
2584
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
1531
2585
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1532
2586
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1533
2587
|
command.params['name'] = name unless name.nil?
|
@@ -1536,16 +2590,52 @@ module Google
|
|
1536
2590
|
execute_or_queue_command(command, &block)
|
1537
2591
|
end
|
1538
2592
|
|
1539
|
-
#
|
1540
|
-
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
2593
|
+
# Gets a Schema.
|
1541
2594
|
# @param [String] name
|
1542
|
-
# The name of the
|
1543
|
-
#
|
1544
|
-
#
|
2595
|
+
# Required. The full resource name of the schema, in the format of `projects/`
|
2596
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
2597
|
+
# schemas/`schema``.
|
2598
|
+
# @param [String] fields
|
2599
|
+
# Selector specifying which fields to include in a partial response.
|
2600
|
+
# @param [String] quota_user
|
2601
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2602
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2603
|
+
# @param [Google::Apis::RequestOptions] options
|
2604
|
+
# Request-specific options
|
2605
|
+
#
|
2606
|
+
# @yield [result, err] Result & error if block supplied
|
2607
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] parsed result object
|
2608
|
+
# @yieldparam err [StandardError] error object if request failed
|
2609
|
+
#
|
2610
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema]
|
2611
|
+
#
|
2612
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2613
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2614
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2615
|
+
def get_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
|
2616
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
2617
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema::Representation
|
2618
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema
|
2619
|
+
command.params['name'] = name unless name.nil?
|
2620
|
+
command.query['fields'] = fields unless fields.nil?
|
2621
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2622
|
+
execute_or_queue_command(command, &block)
|
2623
|
+
end
|
2624
|
+
|
2625
|
+
# Gets a list of Schemas.
|
2626
|
+
# @param [String] parent
|
2627
|
+
# Required. The parent data store resource name, in the format of `projects/`
|
2628
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store``
|
2629
|
+
# .
|
1545
2630
|
# @param [Fixnum] page_size
|
1546
|
-
# The
|
2631
|
+
# The maximum number of Schemas to return. The service may return fewer than
|
2632
|
+
# this value. If unspecified, at most 100 Schemas will be returned. The maximum
|
2633
|
+
# value is 1000; values above 1000 will be coerced to 1000.
|
1547
2634
|
# @param [String] page_token
|
1548
|
-
#
|
2635
|
+
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
2636
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
2637
|
+
# provided to SchemaService.ListSchemas must match the call that provided the
|
2638
|
+
# page token.
|
1549
2639
|
# @param [String] fields
|
1550
2640
|
# Selector specifying which fields to include in a partial response.
|
1551
2641
|
# @param [String] quota_user
|
@@ -1555,20 +2645,19 @@ module Google
|
|
1555
2645
|
# Request-specific options
|
1556
2646
|
#
|
1557
2647
|
# @yield [result, err] Result & error if block supplied
|
1558
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
2648
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse] parsed result object
|
1559
2649
|
# @yieldparam err [StandardError] error object if request failed
|
1560
2650
|
#
|
1561
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
2651
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse]
|
1562
2652
|
#
|
1563
2653
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1564
2654
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1565
2655
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1566
|
-
def
|
1567
|
-
command = make_simple_command(:get, 'v1alpha/{+
|
1568
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
1569
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
1570
|
-
command.params['
|
1571
|
-
command.query['filter'] = filter unless filter.nil?
|
2656
|
+
def list_project_location_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2657
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/schemas', options)
|
2658
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse::Representation
|
2659
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSchemasResponse
|
2660
|
+
command.params['parent'] = parent unless parent.nil?
|
1572
2661
|
command.query['pageSize'] = page_size unless page_size.nil?
|
1573
2662
|
command.query['pageToken'] = page_token unless page_token.nil?
|
1574
2663
|
command.query['fields'] = fields unless fields.nil?
|
@@ -1576,6 +2665,46 @@ module Google
|
|
1576
2665
|
execute_or_queue_command(command, &block)
|
1577
2666
|
end
|
1578
2667
|
|
2668
|
+
# Updates a Schema.
|
2669
|
+
# @param [String] name
|
2670
|
+
# Immutable. The full resource name of the schema, in the format of `projects/`
|
2671
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
2672
|
+
# schemas/`schema``. This field must be a UTF-8 encoded string with a length
|
2673
|
+
# limit of 1024 characters.
|
2674
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
2675
|
+
# @param [Boolean] allow_missing
|
2676
|
+
# If set to true, and the Schema is not found, a new Schema will be created. In
|
2677
|
+
# this situation, `update_mask` is ignored.
|
2678
|
+
# @param [String] fields
|
2679
|
+
# Selector specifying which fields to include in a partial response.
|
2680
|
+
# @param [String] quota_user
|
2681
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2682
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2683
|
+
# @param [Google::Apis::RequestOptions] options
|
2684
|
+
# Request-specific options
|
2685
|
+
#
|
2686
|
+
# @yield [result, err] Result & error if block supplied
|
2687
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
2688
|
+
# @yieldparam err [StandardError] error object if request failed
|
2689
|
+
#
|
2690
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
2691
|
+
#
|
2692
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2693
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2694
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2695
|
+
def patch_project_location_data_store_schema(name, google_cloud_discoveryengine_v1alpha_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2696
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
2697
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema::Representation
|
2698
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_schema_object
|
2699
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
2700
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
2701
|
+
command.params['name'] = name unless name.nil?
|
2702
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
2703
|
+
command.query['fields'] = fields unless fields.nil?
|
2704
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2705
|
+
execute_or_queue_command(command, &block)
|
2706
|
+
end
|
2707
|
+
|
1579
2708
|
# Makes a recommendation, which requires a contextual user event.
|
1580
2709
|
# @param [String] serving_config
|
1581
2710
|
# Required. Full resource name of the format: `projects/*/locations/global/
|
@@ -1612,6 +2741,42 @@ module Google
|
|
1612
2741
|
execute_or_queue_command(command, &block)
|
1613
2742
|
end
|
1614
2743
|
|
2744
|
+
# Performs a search.
|
2745
|
+
# @param [String] serving_config
|
2746
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
2747
|
+
# locations/global/collections/default_collection/dataStores/default_data_store/
|
2748
|
+
# servingConfigs/default_serving_config`. This field is used to identify the
|
2749
|
+
# serving configuration name, set of models used to make the search.
|
2750
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
|
2751
|
+
# @param [String] fields
|
2752
|
+
# Selector specifying which fields to include in a partial response.
|
2753
|
+
# @param [String] quota_user
|
2754
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2755
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2756
|
+
# @param [Google::Apis::RequestOptions] options
|
2757
|
+
# Request-specific options
|
2758
|
+
#
|
2759
|
+
# @yield [result, err] Result & error if block supplied
|
2760
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
|
2761
|
+
# @yieldparam err [StandardError] error object if request failed
|
2762
|
+
#
|
2763
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
|
2764
|
+
#
|
2765
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2766
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2767
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2768
|
+
def search_project_location_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2769
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:search', options)
|
2770
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
2771
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
2772
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
2773
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
|
2774
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2775
|
+
command.query['fields'] = fields unless fields.nil?
|
2776
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2777
|
+
execute_or_queue_command(command, &block)
|
2778
|
+
end
|
2779
|
+
|
1615
2780
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1616
2781
|
# browser restriction of POST-ing to a third-party domain. This method is used
|
1617
2782
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|