google-apis-discoveryengine_v1alpha 0.42.0 → 0.44.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -192,6 +192,110 @@ module Google
192
192
  execute_or_queue_command(command, &block)
193
193
  end
194
194
 
195
+ # Gets a Project. Returns NOT_FOUND when the project is not yet created.
196
+ # @param [String] name
197
+ # Required. Full resource name of a Project, such as `projects/`
198
+ # project_id_or_number``.
199
+ # @param [String] fields
200
+ # Selector specifying which fields to include in a partial response.
201
+ # @param [String] quota_user
202
+ # Available to use for quota purposes for server-side applications. Can be any
203
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
204
+ # @param [Google::Apis::RequestOptions] options
205
+ # Request-specific options
206
+ #
207
+ # @yield [result, err] Result & error if block supplied
208
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject] parsed result object
209
+ # @yieldparam err [StandardError] error object if request failed
210
+ #
211
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject]
212
+ #
213
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
214
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
215
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
216
+ def get_project(name, fields: nil, quota_user: nil, options: nil, &block)
217
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
218
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject::Representation
219
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject
220
+ command.params['name'] = name unless name.nil?
221
+ command.query['fields'] = fields unless fields.nil?
222
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
223
+ execute_or_queue_command(command, &block)
224
+ end
225
+
226
+ # Provisions the project resource. During the process, related systems will get
227
+ # prepared and initialized. Caller must read the [Terms for data use](https://
228
+ # cloud.google.com/retail/data-use-terms), and optionally specify in request to
229
+ # provide consent to that service terms.
230
+ # @param [String] name
231
+ # Required. Full resource name of a Project, such as `projects/`
232
+ # project_id_or_number``.
233
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest] google_cloud_discoveryengine_v1alpha_provision_project_request_object
234
+ # @param [String] fields
235
+ # Selector specifying which fields to include in a partial response.
236
+ # @param [String] quota_user
237
+ # Available to use for quota purposes for server-side applications. Can be any
238
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
239
+ # @param [Google::Apis::RequestOptions] options
240
+ # Request-specific options
241
+ #
242
+ # @yield [result, err] Result & error if block supplied
243
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
244
+ # @yieldparam err [StandardError] error object if request failed
245
+ #
246
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
247
+ #
248
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
249
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
250
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
251
+ def provision_project(name, google_cloud_discoveryengine_v1alpha_provision_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
252
+ command = make_simple_command(:post, 'v1alpha/{+name}:provision', options)
253
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest::Representation
254
+ command.request_object = google_cloud_discoveryengine_v1alpha_provision_project_request_object
255
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
256
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
257
+ command.params['name'] = name unless name.nil?
258
+ command.query['fields'] = fields unless fields.nil?
259
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
260
+ execute_or_queue_command(command, &block)
261
+ end
262
+
263
+ # Updates service terms for this project. This method can be used to
264
+ # retroactively accept the latest terms. Terms available for update: * [Terms
265
+ # for data use](https://cloud.google.com/retail/data-use-terms)
266
+ # @param [String] project
267
+ # Required. Full resource name of a Project, such as `projects/`
268
+ # project_id_or_number``.
269
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest] google_cloud_discoveryengine_v1alpha_report_consent_change_request_object
270
+ # @param [String] fields
271
+ # Selector specifying which fields to include in a partial response.
272
+ # @param [String] quota_user
273
+ # Available to use for quota purposes for server-side applications. Can be any
274
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
275
+ # @param [Google::Apis::RequestOptions] options
276
+ # Request-specific options
277
+ #
278
+ # @yield [result, err] Result & error if block supplied
279
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject] parsed result object
280
+ # @yieldparam err [StandardError] error object if request failed
281
+ #
282
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject]
283
+ #
284
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
285
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
286
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
287
+ def report_project_consent_change(project, google_cloud_discoveryengine_v1alpha_report_consent_change_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
288
+ command = make_simple_command(:post, 'v1alpha/{+project}:reportConsentChange', options)
289
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest::Representation
290
+ command.request_object = google_cloud_discoveryengine_v1alpha_report_consent_change_request_object
291
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject::Representation
292
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProject
293
+ command.params['project'] = project unless project.nil?
294
+ command.query['fields'] = fields unless fields.nil?
295
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
296
+ execute_or_queue_command(command, &block)
297
+ end
298
+
195
299
  # Estimates the data size to be used by a customer.
196
300
  # @param [String] location
197
301
  # Required. Full resource name of the location, such as `projects/`project`/
@@ -1439,9 +1543,9 @@ module Google
1439
1543
  # Updates a Conversation. Conversation action type cannot be changed. If the
1440
1544
  # Conversation to update does not exist, a NOT_FOUND error is returned.
1441
1545
  # @param [String] name
1442
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
1443
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
1444
- # collections/`collection`/engines/*/conversations/*`.
1546
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
1547
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
1548
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
1445
1549
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
1446
1550
  # @param [String] update_mask
1447
1551
  # Indicates which fields in the provided Conversation to update. The following
@@ -1877,6 +1981,44 @@ module Google
1877
1981
  execute_or_queue_command(command, &block)
1878
1982
  end
1879
1983
 
1984
+ # Answer query method.
1985
+ # @param [String] serving_config
1986
+ # Required. The resource name of the Search serving config, such as `projects/*/
1987
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
1988
+ # default_serving_config`, or `projects/*/locations/global/collections/
1989
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
1990
+ # field is used to identify the serving configuration name, set of models used
1991
+ # to make the search.
1992
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
1993
+ # @param [String] fields
1994
+ # Selector specifying which fields to include in a partial response.
1995
+ # @param [String] quota_user
1996
+ # Available to use for quota purposes for server-side applications. Can be any
1997
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1998
+ # @param [Google::Apis::RequestOptions] options
1999
+ # Request-specific options
2000
+ #
2001
+ # @yield [result, err] Result & error if block supplied
2002
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
2003
+ # @yieldparam err [StandardError] error object if request failed
2004
+ #
2005
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
2006
+ #
2007
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2008
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2009
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2010
+ def answer_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2011
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:answer', options)
2012
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
2013
+ command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
2014
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
2015
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
2016
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
2017
+ command.query['fields'] = fields unless fields.nil?
2018
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2019
+ execute_or_queue_command(command, &block)
2020
+ end
2021
+
1880
2022
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
1881
2023
  # exist.
1882
2024
  # @param [String] name
@@ -2068,13 +2210,13 @@ module Google
2068
2210
  execute_or_queue_command(command, &block)
2069
2211
  end
2070
2212
 
2071
- # Verify target sites' ownership and validity. This API sends all the target
2072
- # sites under site search engine for verification.
2213
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
2214
+ # error is returned.
2073
2215
  # @param [String] parent
2074
- # Required. The parent resource shared by all TargetSites being verified. `
2075
- # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
2076
- # data_store`/siteSearchEngine`.
2077
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
2216
+ # Required. Full resource name of parent data store. Format: `projects/`
2217
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2218
+ # data_store_id``
2219
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
2078
2220
  # @param [String] fields
2079
2221
  # Selector specifying which fields to include in a partial response.
2080
2222
  # @param [String] quota_user
@@ -2084,31 +2226,32 @@ module Google
2084
2226
  # Request-specific options
2085
2227
  #
2086
2228
  # @yield [result, err] Result & error if block supplied
2087
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2229
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
2088
2230
  # @yieldparam err [StandardError] error object if request failed
2089
2231
  #
2090
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2232
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
2091
2233
  #
2092
2234
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2093
2235
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2094
2236
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2095
- def batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2096
- command = make_simple_command(:post, 'v1alpha/{+parent}:batchVerifyTargetSites', options)
2097
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest::Representation
2098
- command.request_object = google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
2099
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2100
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2237
+ def create_project_location_collection_data_store_session(parent, google_cloud_discoveryengine_v1alpha_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2238
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sessions', options)
2239
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2240
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
2241
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2242
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
2101
2243
  command.params['parent'] = parent unless parent.nil?
2102
2244
  command.query['fields'] = fields unless fields.nil?
2103
2245
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2104
2246
  execute_or_queue_command(command, &block)
2105
2247
  end
2106
2248
 
2107
- # Downgrade from advanced site search to basic site search.
2108
- # @param [String] site_search_engine
2109
- # Required. Full resource name of the SiteSearchEngine, such as `projects/`
2110
- # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
2111
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
2249
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
2250
+ # is returned.
2251
+ # @param [String] name
2252
+ # Required. The resource name of the Session to delete. Format: `projects/`
2253
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2254
+ # data_store_id`/sessions/`session_id``
2112
2255
  # @param [String] fields
2113
2256
  # Selector specifying which fields to include in a partial response.
2114
2257
  # @param [String] quota_user
@@ -2118,31 +2261,29 @@ module Google
2118
2261
  # Request-specific options
2119
2262
  #
2120
2263
  # @yield [result, err] Result & error if block supplied
2121
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2264
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
2122
2265
  # @yieldparam err [StandardError] error object if request failed
2123
2266
  #
2124
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2267
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
2125
2268
  #
2126
2269
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2127
2270
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2128
2271
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2129
- def disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2130
- command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
2131
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest::Representation
2132
- command.request_object = google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
2133
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2134
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2135
- command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2272
+ def delete_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
2273
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2274
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
2275
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
2276
+ command.params['name'] = name unless name.nil?
2136
2277
  command.query['fields'] = fields unless fields.nil?
2137
2278
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2138
2279
  execute_or_queue_command(command, &block)
2139
2280
  end
2140
2281
 
2141
- # Upgrade from basic site search to advanced site search.
2142
- # @param [String] site_search_engine
2143
- # Required. Full resource name of the SiteSearchEngine, such as `projects/`
2144
- # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
2145
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
2282
+ # Gets a Session.
2283
+ # @param [String] name
2284
+ # Required. The resource name of the Session to get. Format: `projects/`
2285
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2286
+ # data_store_id`/sessions/`session_id``
2146
2287
  # @param [String] fields
2147
2288
  # Selector specifying which fields to include in a partial response.
2148
2289
  # @param [String] quota_user
@@ -2152,42 +2293,41 @@ module Google
2152
2293
  # Request-specific options
2153
2294
  #
2154
2295
  # @yield [result, err] Result & error if block supplied
2155
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2296
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
2156
2297
  # @yieldparam err [StandardError] error object if request failed
2157
2298
  #
2158
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2299
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
2159
2300
  #
2160
2301
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2161
2302
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2162
2303
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2163
- def enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2164
- command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
2165
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest::Representation
2166
- command.request_object = google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
2167
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2168
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2169
- command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2304
+ def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
2305
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2306
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2307
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
2308
+ command.params['name'] = name unless name.nil?
2170
2309
  command.query['fields'] = fields unless fields.nil?
2171
2310
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2172
2311
  execute_or_queue_command(command, &block)
2173
2312
  end
2174
2313
 
2175
- # Returns list of target sites with its domain verification status. This method
2176
- # can only be called under data store with BASIC_SITE_SEARCH state at the moment.
2177
- # @param [String] site_search_engine
2178
- # Required. The site search engine resource under which we fetch all the domain
2179
- # verification status. `projects/`project`/locations/`location`/collections/`
2180
- # collection`/dataStores/`data_store`/siteSearchEngine`.
2314
+ # Lists all Sessions by their parent DataStore.
2315
+ # @param [String] parent
2316
+ # Required. The data store resource name. Format: `projects/`project_number`/
2317
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
2318
+ # @param [String] filter
2319
+ # A filter to apply on the list results. The supported features are:
2320
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
2321
+ # @param [String] order_by
2322
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
2323
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
2324
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
2181
2325
  # @param [Fixnum] page_size
2182
- # Requested page size. Server may return fewer items than requested. If
2183
- # unspecified, server will pick an appropriate default. The maximum value is
2184
- # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
2185
- # INVALID_ARGUMENT error is returned.
2326
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
2327
+ # allowed value is 1000.
2186
2328
  # @param [String] page_token
2187
- # A page token, received from a previous `FetchDomainVerificationStatus` call.
2188
- # Provide this to retrieve the subsequent page. When paginating, all other
2189
- # parameters provided to `FetchDomainVerificationStatus` must match the call
2190
- # that provided the page token.
2329
+ # A page token, received from a previous `ListSessions` call. Provide this to
2330
+ # retrieve the subsequent page.
2191
2331
  # @param [String] fields
2192
2332
  # Selector specifying which fields to include in a partial response.
2193
2333
  # @param [String] quota_user
@@ -2197,19 +2337,21 @@ module Google
2197
2337
  # Request-specific options
2198
2338
  #
2199
2339
  # @yield [result, err] Result & error if block supplied
2200
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse] parsed result object
2340
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse] parsed result object
2201
2341
  # @yieldparam err [StandardError] error object if request failed
2202
2342
  #
2203
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse]
2343
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse]
2204
2344
  #
2205
2345
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2206
2346
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2207
2347
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2208
- def fetch_project_location_collection_data_store_site_search_engine_domain_verification_status(site_search_engine, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2209
- command = make_simple_command(:get, 'v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus', options)
2210
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse::Representation
2211
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
2212
- command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2348
+ def list_project_location_collection_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2349
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sessions', options)
2350
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse::Representation
2351
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse
2352
+ command.params['parent'] = parent unless parent.nil?
2353
+ command.query['filter'] = filter unless filter.nil?
2354
+ command.query['orderBy'] = order_by unless order_by.nil?
2213
2355
  command.query['pageSize'] = page_size unless page_size.nil?
2214
2356
  command.query['pageToken'] = page_token unless page_token.nil?
2215
2357
  command.query['fields'] = fields unless fields.nil?
@@ -2217,11 +2359,16 @@ module Google
2217
2359
  execute_or_queue_command(command, &block)
2218
2360
  end
2219
2361
 
2220
- # Request on-demand recrawl for a list of URIs.
2221
- # @param [String] site_search_engine
2222
- # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
2223
- # locations/*/collections/*/dataStores/*/siteSearchEngine`.
2224
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
2362
+ # Updates a Session. Session action type cannot be changed. If the Session to
2363
+ # update does not exist, a NOT_FOUND error is returned.
2364
+ # @param [String] name
2365
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
2366
+ # collections/`collection`/engines/`engine`/sessions/*`
2367
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
2368
+ # @param [String] update_mask
2369
+ # Indicates which fields in the provided Session to update. The following are
2370
+ # NOT supported: * Session.name If not set or empty, all supported fields are
2371
+ # updated.
2225
2372
  # @param [String] fields
2226
2373
  # Selector specifying which fields to include in a partial response.
2227
2374
  # @param [String] quota_user
@@ -2231,30 +2378,32 @@ module Google
2231
2378
  # Request-specific options
2232
2379
  #
2233
2380
  # @yield [result, err] Result & error if block supplied
2234
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2381
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
2235
2382
  # @yieldparam err [StandardError] error object if request failed
2236
2383
  #
2237
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2384
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
2238
2385
  #
2239
2386
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2240
2387
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2241
2388
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2242
- def recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2243
- command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
2244
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
2245
- command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
2246
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2247
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2248
- command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2389
+ def patch_project_location_collection_data_store_session(name, google_cloud_discoveryengine_v1alpha_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2390
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2391
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2392
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
2393
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2394
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
2395
+ command.params['name'] = name unless name.nil?
2396
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2249
2397
  command.query['fields'] = fields unless fields.nil?
2250
2398
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2251
2399
  execute_or_queue_command(command, &block)
2252
2400
  end
2253
2401
 
2254
- # Gets the latest state of a long-running operation. Clients can use this method
2255
- # to poll the operation result at intervals as recommended by the API service.
2402
+ # Gets a Answer.
2256
2403
  # @param [String] name
2257
- # The name of the operation resource.
2404
+ # Required. The resource name of the Answer to get. Format: `projects/`
2405
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
2406
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
2258
2407
  # @param [String] fields
2259
2408
  # Selector specifying which fields to include in a partial response.
2260
2409
  # @param [String] quota_user
@@ -2264,34 +2413,31 @@ module Google
2264
2413
  # Request-specific options
2265
2414
  #
2266
2415
  # @yield [result, err] Result & error if block supplied
2267
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2416
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer] parsed result object
2268
2417
  # @yieldparam err [StandardError] error object if request failed
2269
2418
  #
2270
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2419
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
2271
2420
  #
2272
2421
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2273
2422
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2274
2423
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2275
- def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2424
+ def get_project_location_collection_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
2276
2425
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
2277
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2278
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2426
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
2427
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer
2279
2428
  command.params['name'] = name unless name.nil?
2280
2429
  command.query['fields'] = fields unless fields.nil?
2281
2430
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2282
2431
  execute_or_queue_command(command, &block)
2283
2432
  end
2284
2433
 
2285
- # Lists operations that match the specified filter in the request. If the server
2286
- # doesn't support this method, it returns `UNIMPLEMENTED`.
2287
- # @param [String] name
2288
- # The name of the operation's parent resource.
2289
- # @param [String] filter
2290
- # The standard list filter.
2291
- # @param [Fixnum] page_size
2292
- # The standard list page size.
2293
- # @param [String] page_token
2294
- # The standard list page token.
2434
+ # Verify target sites' ownership and validity. This API sends all the target
2435
+ # sites under site search engine for verification.
2436
+ # @param [String] parent
2437
+ # Required. The parent resource shared by all TargetSites being verified. `
2438
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
2439
+ # data_store`/siteSearchEngine`.
2440
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
2295
2441
  # @param [String] fields
2296
2442
  # Selector specifying which fields to include in a partial response.
2297
2443
  # @param [String] quota_user
@@ -2301,33 +2447,250 @@ module Google
2301
2447
  # Request-specific options
2302
2448
  #
2303
2449
  # @yield [result, err] Result & error if block supplied
2304
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
2450
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2305
2451
  # @yieldparam err [StandardError] error object if request failed
2306
2452
  #
2307
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
2453
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2308
2454
  #
2309
2455
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2310
2456
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2311
2457
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2312
- 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)
2313
- command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
2314
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
2315
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
2316
- command.params['name'] = name unless name.nil?
2317
- command.query['filter'] = filter unless filter.nil?
2318
- command.query['pageSize'] = page_size unless page_size.nil?
2319
- command.query['pageToken'] = page_token unless page_token.nil?
2458
+ def batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2459
+ command = make_simple_command(:post, 'v1alpha/{+parent}:batchVerifyTargetSites', options)
2460
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest::Representation
2461
+ command.request_object = google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
2462
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2463
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2464
+ command.params['parent'] = parent unless parent.nil?
2320
2465
  command.query['fields'] = fields unless fields.nil?
2321
2466
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2322
2467
  execute_or_queue_command(command, &block)
2323
2468
  end
2324
2469
 
2325
- # Creates TargetSite in a batch.
2326
- # @param [String] parent
2327
- # Required. The parent resource shared by all TargetSites being created. `
2328
- # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
2329
- # data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
2330
- # messages must either be empty or match this field.
2470
+ # Downgrade from advanced site search to basic site search.
2471
+ # @param [String] site_search_engine
2472
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
2473
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
2474
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
2475
+ # @param [String] fields
2476
+ # Selector specifying which fields to include in a partial response.
2477
+ # @param [String] quota_user
2478
+ # Available to use for quota purposes for server-side applications. Can be any
2479
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2480
+ # @param [Google::Apis::RequestOptions] options
2481
+ # Request-specific options
2482
+ #
2483
+ # @yield [result, err] Result & error if block supplied
2484
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2485
+ # @yieldparam err [StandardError] error object if request failed
2486
+ #
2487
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2488
+ #
2489
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2490
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2491
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2492
+ def disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2493
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
2494
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest::Representation
2495
+ command.request_object = google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
2496
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2497
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2498
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2499
+ command.query['fields'] = fields unless fields.nil?
2500
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2501
+ execute_or_queue_command(command, &block)
2502
+ end
2503
+
2504
+ # Upgrade from basic site search to advanced site search.
2505
+ # @param [String] site_search_engine
2506
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
2507
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
2508
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
2509
+ # @param [String] fields
2510
+ # Selector specifying which fields to include in a partial response.
2511
+ # @param [String] quota_user
2512
+ # Available to use for quota purposes for server-side applications. Can be any
2513
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2514
+ # @param [Google::Apis::RequestOptions] options
2515
+ # Request-specific options
2516
+ #
2517
+ # @yield [result, err] Result & error if block supplied
2518
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2519
+ # @yieldparam err [StandardError] error object if request failed
2520
+ #
2521
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2522
+ #
2523
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2524
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2525
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2526
+ def enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2527
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
2528
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest::Representation
2529
+ command.request_object = google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
2530
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2531
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2532
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2533
+ command.query['fields'] = fields unless fields.nil?
2534
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2535
+ execute_or_queue_command(command, &block)
2536
+ end
2537
+
2538
+ # Returns list of target sites with its domain verification status. This method
2539
+ # can only be called under data store with BASIC_SITE_SEARCH state at the moment.
2540
+ # @param [String] site_search_engine
2541
+ # Required. The site search engine resource under which we fetch all the domain
2542
+ # verification status. `projects/`project`/locations/`location`/collections/`
2543
+ # collection`/dataStores/`data_store`/siteSearchEngine`.
2544
+ # @param [Fixnum] page_size
2545
+ # Requested page size. Server may return fewer items than requested. If
2546
+ # unspecified, server will pick an appropriate default. The maximum value is
2547
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
2548
+ # INVALID_ARGUMENT error is returned.
2549
+ # @param [String] page_token
2550
+ # A page token, received from a previous `FetchDomainVerificationStatus` call.
2551
+ # Provide this to retrieve the subsequent page. When paginating, all other
2552
+ # parameters provided to `FetchDomainVerificationStatus` must match the call
2553
+ # that provided the page token.
2554
+ # @param [String] fields
2555
+ # Selector specifying which fields to include in a partial response.
2556
+ # @param [String] quota_user
2557
+ # Available to use for quota purposes for server-side applications. Can be any
2558
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2559
+ # @param [Google::Apis::RequestOptions] options
2560
+ # Request-specific options
2561
+ #
2562
+ # @yield [result, err] Result & error if block supplied
2563
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse] parsed result object
2564
+ # @yieldparam err [StandardError] error object if request failed
2565
+ #
2566
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse]
2567
+ #
2568
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2569
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2570
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2571
+ def fetch_project_location_collection_data_store_site_search_engine_domain_verification_status(site_search_engine, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2572
+ command = make_simple_command(:get, 'v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus', options)
2573
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse::Representation
2574
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
2575
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2576
+ command.query['pageSize'] = page_size unless page_size.nil?
2577
+ command.query['pageToken'] = page_token unless page_token.nil?
2578
+ command.query['fields'] = fields unless fields.nil?
2579
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2580
+ execute_or_queue_command(command, &block)
2581
+ end
2582
+
2583
+ # Request on-demand recrawl for a list of URIs.
2584
+ # @param [String] site_search_engine
2585
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
2586
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
2587
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
2588
+ # @param [String] fields
2589
+ # Selector specifying which fields to include in a partial response.
2590
+ # @param [String] quota_user
2591
+ # Available to use for quota purposes for server-side applications. Can be any
2592
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2593
+ # @param [Google::Apis::RequestOptions] options
2594
+ # Request-specific options
2595
+ #
2596
+ # @yield [result, err] Result & error if block supplied
2597
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2598
+ # @yieldparam err [StandardError] error object if request failed
2599
+ #
2600
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2601
+ #
2602
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2603
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2604
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2605
+ def recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2606
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
2607
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
2608
+ command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
2609
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2610
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2611
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
2612
+ command.query['fields'] = fields unless fields.nil?
2613
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2614
+ execute_or_queue_command(command, &block)
2615
+ end
2616
+
2617
+ # Gets the latest state of a long-running operation. Clients can use this method
2618
+ # to poll the operation result at intervals as recommended by the API service.
2619
+ # @param [String] name
2620
+ # The name of the operation resource.
2621
+ # @param [String] fields
2622
+ # Selector specifying which fields to include in a partial response.
2623
+ # @param [String] quota_user
2624
+ # Available to use for quota purposes for server-side applications. Can be any
2625
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2626
+ # @param [Google::Apis::RequestOptions] options
2627
+ # Request-specific options
2628
+ #
2629
+ # @yield [result, err] Result & error if block supplied
2630
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2631
+ # @yieldparam err [StandardError] error object if request failed
2632
+ #
2633
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2634
+ #
2635
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2636
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2637
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2638
+ def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2639
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2640
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2641
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2642
+ command.params['name'] = name unless name.nil?
2643
+ command.query['fields'] = fields unless fields.nil?
2644
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2645
+ execute_or_queue_command(command, &block)
2646
+ end
2647
+
2648
+ # Lists operations that match the specified filter in the request. If the server
2649
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
2650
+ # @param [String] name
2651
+ # The name of the operation's parent resource.
2652
+ # @param [String] filter
2653
+ # The standard list filter.
2654
+ # @param [Fixnum] page_size
2655
+ # The standard list page size.
2656
+ # @param [String] page_token
2657
+ # The standard list page token.
2658
+ # @param [String] fields
2659
+ # Selector specifying which fields to include in a partial response.
2660
+ # @param [String] quota_user
2661
+ # Available to use for quota purposes for server-side applications. Can be any
2662
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2663
+ # @param [Google::Apis::RequestOptions] options
2664
+ # Request-specific options
2665
+ #
2666
+ # @yield [result, err] Result & error if block supplied
2667
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
2668
+ # @yieldparam err [StandardError] error object if request failed
2669
+ #
2670
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
2671
+ #
2672
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2673
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2674
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2675
+ 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)
2676
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
2677
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
2678
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
2679
+ command.params['name'] = name unless name.nil?
2680
+ command.query['filter'] = filter unless filter.nil?
2681
+ command.query['pageSize'] = page_size unless page_size.nil?
2682
+ command.query['pageToken'] = page_token unless page_token.nil?
2683
+ command.query['fields'] = fields unless fields.nil?
2684
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2685
+ execute_or_queue_command(command, &block)
2686
+ end
2687
+
2688
+ # Creates TargetSite in a batch.
2689
+ # @param [String] parent
2690
+ # Required. The parent resource shared by all TargetSites being created. `
2691
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
2692
+ # data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
2693
+ # messages must either be empty or match this field.
2331
2694
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
2332
2695
  # @param [String] fields
2333
2696
  # Selector specifying which fields to include in a partial response.
@@ -2809,8 +3172,12 @@ module Google
2809
3172
 
2810
3173
  # Writes a single user event.
2811
3174
  # @param [String] parent
2812
- # Required. The parent DataStore resource name, such as `projects/`project`/
2813
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
3175
+ # Required. The parent resource name. If the write user event action is applied
3176
+ # in DataStore level, the format is: `projects/`project`/locations/`location`/
3177
+ # collections/`collection`/dataStores/`data_store``. If the write user event
3178
+ # action is applied in Location level, for example, the event with Document
3179
+ # across multiple DataStore, the format is: `projects/`project`/locations/`
3180
+ # location``.
2814
3181
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
2815
3182
  # @param [String] fields
2816
3183
  # Selector specifying which fields to include in a partial response.
@@ -3324,9 +3691,9 @@ module Google
3324
3691
  # Updates a Conversation. Conversation action type cannot be changed. If the
3325
3692
  # Conversation to update does not exist, a NOT_FOUND error is returned.
3326
3693
  # @param [String] name
3327
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
3328
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
3329
- # collections/`collection`/engines/*/conversations/*`.
3694
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
3695
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
3696
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
3330
3697
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
3331
3698
  # @param [String] update_mask
3332
3699
  # Indicates which fields in the provided Conversation to update. The following
@@ -3433,6 +3800,44 @@ module Google
3433
3800
  execute_or_queue_command(command, &block)
3434
3801
  end
3435
3802
 
3803
+ # Answer query method.
3804
+ # @param [String] serving_config
3805
+ # Required. The resource name of the Search serving config, such as `projects/*/
3806
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
3807
+ # default_serving_config`, or `projects/*/locations/global/collections/
3808
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
3809
+ # field is used to identify the serving configuration name, set of models used
3810
+ # to make the search.
3811
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
3812
+ # @param [String] fields
3813
+ # Selector specifying which fields to include in a partial response.
3814
+ # @param [String] quota_user
3815
+ # Available to use for quota purposes for server-side applications. Can be any
3816
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3817
+ # @param [Google::Apis::RequestOptions] options
3818
+ # Request-specific options
3819
+ #
3820
+ # @yield [result, err] Result & error if block supplied
3821
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
3822
+ # @yieldparam err [StandardError] error object if request failed
3823
+ #
3824
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
3825
+ #
3826
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3827
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3828
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3829
+ def answer_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3830
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:answer', options)
3831
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
3832
+ command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
3833
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
3834
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
3835
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
3836
+ command.query['fields'] = fields unless fields.nil?
3837
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3838
+ execute_or_queue_command(command, &block)
3839
+ end
3840
+
3436
3841
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
3437
3842
  # exist.
3438
3843
  # @param [String] name
@@ -3624,11 +4029,232 @@ module Google
3624
4029
  execute_or_queue_command(command, &block)
3625
4030
  end
3626
4031
 
3627
- # Gets the latest state of a long-running operation. Clients can use this method
3628
- # to poll the operation result at intervals as recommended by the API service.
3629
- # @param [String] name
3630
- # The name of the operation resource.
3631
- # @param [String] fields
4032
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
4033
+ # error is returned.
4034
+ # @param [String] parent
4035
+ # Required. Full resource name of parent data store. Format: `projects/`
4036
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
4037
+ # data_store_id``
4038
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
4039
+ # @param [String] fields
4040
+ # Selector specifying which fields to include in a partial response.
4041
+ # @param [String] quota_user
4042
+ # Available to use for quota purposes for server-side applications. Can be any
4043
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4044
+ # @param [Google::Apis::RequestOptions] options
4045
+ # Request-specific options
4046
+ #
4047
+ # @yield [result, err] Result & error if block supplied
4048
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
4049
+ # @yieldparam err [StandardError] error object if request failed
4050
+ #
4051
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
4052
+ #
4053
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4054
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4055
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4056
+ def create_project_location_collection_engine_session(parent, google_cloud_discoveryengine_v1alpha_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4057
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sessions', options)
4058
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4059
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
4060
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4061
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
4062
+ command.params['parent'] = parent unless parent.nil?
4063
+ command.query['fields'] = fields unless fields.nil?
4064
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4065
+ execute_or_queue_command(command, &block)
4066
+ end
4067
+
4068
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
4069
+ # is returned.
4070
+ # @param [String] name
4071
+ # Required. The resource name of the Session to delete. Format: `projects/`
4072
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
4073
+ # data_store_id`/sessions/`session_id``
4074
+ # @param [String] fields
4075
+ # Selector specifying which fields to include in a partial response.
4076
+ # @param [String] quota_user
4077
+ # Available to use for quota purposes for server-side applications. Can be any
4078
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4079
+ # @param [Google::Apis::RequestOptions] options
4080
+ # Request-specific options
4081
+ #
4082
+ # @yield [result, err] Result & error if block supplied
4083
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
4084
+ # @yieldparam err [StandardError] error object if request failed
4085
+ #
4086
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
4087
+ #
4088
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4089
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4090
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4091
+ def delete_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
4092
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
4093
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
4094
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
4095
+ command.params['name'] = name unless name.nil?
4096
+ command.query['fields'] = fields unless fields.nil?
4097
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4098
+ execute_or_queue_command(command, &block)
4099
+ end
4100
+
4101
+ # Gets a Session.
4102
+ # @param [String] name
4103
+ # Required. The resource name of the Session to get. Format: `projects/`
4104
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
4105
+ # data_store_id`/sessions/`session_id``
4106
+ # @param [String] fields
4107
+ # Selector specifying which fields to include in a partial response.
4108
+ # @param [String] quota_user
4109
+ # Available to use for quota purposes for server-side applications. Can be any
4110
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4111
+ # @param [Google::Apis::RequestOptions] options
4112
+ # Request-specific options
4113
+ #
4114
+ # @yield [result, err] Result & error if block supplied
4115
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
4116
+ # @yieldparam err [StandardError] error object if request failed
4117
+ #
4118
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
4119
+ #
4120
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4121
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4122
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4123
+ def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
4124
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4125
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4126
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
4127
+ command.params['name'] = name unless name.nil?
4128
+ command.query['fields'] = fields unless fields.nil?
4129
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4130
+ execute_or_queue_command(command, &block)
4131
+ end
4132
+
4133
+ # Lists all Sessions by their parent DataStore.
4134
+ # @param [String] parent
4135
+ # Required. The data store resource name. Format: `projects/`project_number`/
4136
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
4137
+ # @param [String] filter
4138
+ # A filter to apply on the list results. The supported features are:
4139
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
4140
+ # @param [String] order_by
4141
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
4142
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
4143
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
4144
+ # @param [Fixnum] page_size
4145
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
4146
+ # allowed value is 1000.
4147
+ # @param [String] page_token
4148
+ # A page token, received from a previous `ListSessions` call. Provide this to
4149
+ # retrieve the subsequent page.
4150
+ # @param [String] fields
4151
+ # Selector specifying which fields to include in a partial response.
4152
+ # @param [String] quota_user
4153
+ # Available to use for quota purposes for server-side applications. Can be any
4154
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4155
+ # @param [Google::Apis::RequestOptions] options
4156
+ # Request-specific options
4157
+ #
4158
+ # @yield [result, err] Result & error if block supplied
4159
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse] parsed result object
4160
+ # @yieldparam err [StandardError] error object if request failed
4161
+ #
4162
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse]
4163
+ #
4164
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4165
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4166
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4167
+ def list_project_location_collection_engine_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4168
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sessions', options)
4169
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse::Representation
4170
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse
4171
+ command.params['parent'] = parent unless parent.nil?
4172
+ command.query['filter'] = filter unless filter.nil?
4173
+ command.query['orderBy'] = order_by unless order_by.nil?
4174
+ command.query['pageSize'] = page_size unless page_size.nil?
4175
+ command.query['pageToken'] = page_token unless page_token.nil?
4176
+ command.query['fields'] = fields unless fields.nil?
4177
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4178
+ execute_or_queue_command(command, &block)
4179
+ end
4180
+
4181
+ # Updates a Session. Session action type cannot be changed. If the Session to
4182
+ # update does not exist, a NOT_FOUND error is returned.
4183
+ # @param [String] name
4184
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
4185
+ # collections/`collection`/engines/`engine`/sessions/*`
4186
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
4187
+ # @param [String] update_mask
4188
+ # Indicates which fields in the provided Session to update. The following are
4189
+ # NOT supported: * Session.name If not set or empty, all supported fields are
4190
+ # updated.
4191
+ # @param [String] fields
4192
+ # Selector specifying which fields to include in a partial response.
4193
+ # @param [String] quota_user
4194
+ # Available to use for quota purposes for server-side applications. Can be any
4195
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4196
+ # @param [Google::Apis::RequestOptions] options
4197
+ # Request-specific options
4198
+ #
4199
+ # @yield [result, err] Result & error if block supplied
4200
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
4201
+ # @yieldparam err [StandardError] error object if request failed
4202
+ #
4203
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
4204
+ #
4205
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4206
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4207
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4208
+ def patch_project_location_collection_engine_session(name, google_cloud_discoveryengine_v1alpha_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4209
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
4210
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4211
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
4212
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4213
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
4214
+ command.params['name'] = name unless name.nil?
4215
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4216
+ command.query['fields'] = fields unless fields.nil?
4217
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4218
+ execute_or_queue_command(command, &block)
4219
+ end
4220
+
4221
+ # Gets a Answer.
4222
+ # @param [String] name
4223
+ # Required. The resource name of the Answer to get. Format: `projects/`
4224
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
4225
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
4226
+ # @param [String] fields
4227
+ # Selector specifying which fields to include in a partial response.
4228
+ # @param [String] quota_user
4229
+ # Available to use for quota purposes for server-side applications. Can be any
4230
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4231
+ # @param [Google::Apis::RequestOptions] options
4232
+ # Request-specific options
4233
+ #
4234
+ # @yield [result, err] Result & error if block supplied
4235
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer] parsed result object
4236
+ # @yieldparam err [StandardError] error object if request failed
4237
+ #
4238
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
4239
+ #
4240
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4241
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4242
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4243
+ def get_project_location_collection_engine_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
4244
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4245
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
4246
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer
4247
+ command.params['name'] = name unless name.nil?
4248
+ command.query['fields'] = fields unless fields.nil?
4249
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4250
+ execute_or_queue_command(command, &block)
4251
+ end
4252
+
4253
+ # Gets the latest state of a long-running operation. Clients can use this method
4254
+ # to poll the operation result at intervals as recommended by the API service.
4255
+ # @param [String] name
4256
+ # The name of the operation resource.
4257
+ # @param [String] fields
3632
4258
  # Selector specifying which fields to include in a partial response.
3633
4259
  # @param [String] quota_user
3634
4260
  # Available to use for quota purposes for server-side applications. Can be any
@@ -4733,9 +5359,9 @@ module Google
4733
5359
  # Updates a Conversation. Conversation action type cannot be changed. If the
4734
5360
  # Conversation to update does not exist, a NOT_FOUND error is returned.
4735
5361
  # @param [String] name
4736
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
4737
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
4738
- # collections/`collection`/engines/*/conversations/*`.
5362
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
5363
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
5364
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
4739
5365
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
4740
5366
  # @param [String] update_mask
4741
5367
  # Indicates which fields in the provided Conversation to update. The following
@@ -5100,6 +5726,44 @@ module Google
5100
5726
  execute_or_queue_command(command, &block)
5101
5727
  end
5102
5728
 
5729
+ # Answer query method.
5730
+ # @param [String] serving_config
5731
+ # Required. The resource name of the Search serving config, such as `projects/*/
5732
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
5733
+ # default_serving_config`, or `projects/*/locations/global/collections/
5734
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
5735
+ # field is used to identify the serving configuration name, set of models used
5736
+ # to make the search.
5737
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
5738
+ # @param [String] fields
5739
+ # Selector specifying which fields to include in a partial response.
5740
+ # @param [String] quota_user
5741
+ # Available to use for quota purposes for server-side applications. Can be any
5742
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5743
+ # @param [Google::Apis::RequestOptions] options
5744
+ # Request-specific options
5745
+ #
5746
+ # @yield [result, err] Result & error if block supplied
5747
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
5748
+ # @yieldparam err [StandardError] error object if request failed
5749
+ #
5750
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
5751
+ #
5752
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5753
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5754
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5755
+ def answer_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5756
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:answer', options)
5757
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
5758
+ command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
5759
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
5760
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
5761
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
5762
+ command.query['fields'] = fields unless fields.nil?
5763
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5764
+ execute_or_queue_command(command, &block)
5765
+ end
5766
+
5103
5767
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
5104
5768
  # exist.
5105
5769
  # @param [String] name
@@ -5291,6 +5955,227 @@ module Google
5291
5955
  execute_or_queue_command(command, &block)
5292
5956
  end
5293
5957
 
5958
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
5959
+ # error is returned.
5960
+ # @param [String] parent
5961
+ # Required. Full resource name of parent data store. Format: `projects/`
5962
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5963
+ # data_store_id``
5964
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
5965
+ # @param [String] fields
5966
+ # Selector specifying which fields to include in a partial response.
5967
+ # @param [String] quota_user
5968
+ # Available to use for quota purposes for server-side applications. Can be any
5969
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5970
+ # @param [Google::Apis::RequestOptions] options
5971
+ # Request-specific options
5972
+ #
5973
+ # @yield [result, err] Result & error if block supplied
5974
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
5975
+ # @yieldparam err [StandardError] error object if request failed
5976
+ #
5977
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
5978
+ #
5979
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5980
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5981
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5982
+ def create_project_location_data_store_session(parent, google_cloud_discoveryengine_v1alpha_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5983
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sessions', options)
5984
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
5985
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
5986
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
5987
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
5988
+ command.params['parent'] = parent unless parent.nil?
5989
+ command.query['fields'] = fields unless fields.nil?
5990
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5991
+ execute_or_queue_command(command, &block)
5992
+ end
5993
+
5994
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
5995
+ # is returned.
5996
+ # @param [String] name
5997
+ # Required. The resource name of the Session to delete. Format: `projects/`
5998
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5999
+ # data_store_id`/sessions/`session_id``
6000
+ # @param [String] fields
6001
+ # Selector specifying which fields to include in a partial response.
6002
+ # @param [String] quota_user
6003
+ # Available to use for quota purposes for server-side applications. Can be any
6004
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6005
+ # @param [Google::Apis::RequestOptions] options
6006
+ # Request-specific options
6007
+ #
6008
+ # @yield [result, err] Result & error if block supplied
6009
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
6010
+ # @yieldparam err [StandardError] error object if request failed
6011
+ #
6012
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
6013
+ #
6014
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6015
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6016
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6017
+ def delete_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
6018
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
6019
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
6020
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
6021
+ command.params['name'] = name unless name.nil?
6022
+ command.query['fields'] = fields unless fields.nil?
6023
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6024
+ execute_or_queue_command(command, &block)
6025
+ end
6026
+
6027
+ # Gets a Session.
6028
+ # @param [String] name
6029
+ # Required. The resource name of the Session to get. Format: `projects/`
6030
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
6031
+ # data_store_id`/sessions/`session_id``
6032
+ # @param [String] fields
6033
+ # Selector specifying which fields to include in a partial response.
6034
+ # @param [String] quota_user
6035
+ # Available to use for quota purposes for server-side applications. Can be any
6036
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6037
+ # @param [Google::Apis::RequestOptions] options
6038
+ # Request-specific options
6039
+ #
6040
+ # @yield [result, err] Result & error if block supplied
6041
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
6042
+ # @yieldparam err [StandardError] error object if request failed
6043
+ #
6044
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
6045
+ #
6046
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6047
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6048
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6049
+ def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
6050
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
6051
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
6052
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
6053
+ command.params['name'] = name unless name.nil?
6054
+ command.query['fields'] = fields unless fields.nil?
6055
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6056
+ execute_or_queue_command(command, &block)
6057
+ end
6058
+
6059
+ # Lists all Sessions by their parent DataStore.
6060
+ # @param [String] parent
6061
+ # Required. The data store resource name. Format: `projects/`project_number`/
6062
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
6063
+ # @param [String] filter
6064
+ # A filter to apply on the list results. The supported features are:
6065
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
6066
+ # @param [String] order_by
6067
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
6068
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
6069
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
6070
+ # @param [Fixnum] page_size
6071
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
6072
+ # allowed value is 1000.
6073
+ # @param [String] page_token
6074
+ # A page token, received from a previous `ListSessions` call. Provide this to
6075
+ # retrieve the subsequent page.
6076
+ # @param [String] fields
6077
+ # Selector specifying which fields to include in a partial response.
6078
+ # @param [String] quota_user
6079
+ # Available to use for quota purposes for server-side applications. Can be any
6080
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6081
+ # @param [Google::Apis::RequestOptions] options
6082
+ # Request-specific options
6083
+ #
6084
+ # @yield [result, err] Result & error if block supplied
6085
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse] parsed result object
6086
+ # @yieldparam err [StandardError] error object if request failed
6087
+ #
6088
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse]
6089
+ #
6090
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6091
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6092
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6093
+ def list_project_location_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
6094
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sessions', options)
6095
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse::Representation
6096
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse
6097
+ command.params['parent'] = parent unless parent.nil?
6098
+ command.query['filter'] = filter unless filter.nil?
6099
+ command.query['orderBy'] = order_by unless order_by.nil?
6100
+ command.query['pageSize'] = page_size unless page_size.nil?
6101
+ command.query['pageToken'] = page_token unless page_token.nil?
6102
+ command.query['fields'] = fields unless fields.nil?
6103
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6104
+ execute_or_queue_command(command, &block)
6105
+ end
6106
+
6107
+ # Updates a Session. Session action type cannot be changed. If the Session to
6108
+ # update does not exist, a NOT_FOUND error is returned.
6109
+ # @param [String] name
6110
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
6111
+ # collections/`collection`/engines/`engine`/sessions/*`
6112
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
6113
+ # @param [String] update_mask
6114
+ # Indicates which fields in the provided Session to update. The following are
6115
+ # NOT supported: * Session.name If not set or empty, all supported fields are
6116
+ # updated.
6117
+ # @param [String] fields
6118
+ # Selector specifying which fields to include in a partial response.
6119
+ # @param [String] quota_user
6120
+ # Available to use for quota purposes for server-side applications. Can be any
6121
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6122
+ # @param [Google::Apis::RequestOptions] options
6123
+ # Request-specific options
6124
+ #
6125
+ # @yield [result, err] Result & error if block supplied
6126
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
6127
+ # @yieldparam err [StandardError] error object if request failed
6128
+ #
6129
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
6130
+ #
6131
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6132
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6133
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6134
+ def patch_project_location_data_store_session(name, google_cloud_discoveryengine_v1alpha_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
6135
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
6136
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
6137
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
6138
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
6139
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
6140
+ command.params['name'] = name unless name.nil?
6141
+ command.query['updateMask'] = update_mask unless update_mask.nil?
6142
+ command.query['fields'] = fields unless fields.nil?
6143
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6144
+ execute_or_queue_command(command, &block)
6145
+ end
6146
+
6147
+ # Gets a Answer.
6148
+ # @param [String] name
6149
+ # Required. The resource name of the Answer to get. Format: `projects/`
6150
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
6151
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
6152
+ # @param [String] fields
6153
+ # Selector specifying which fields to include in a partial response.
6154
+ # @param [String] quota_user
6155
+ # Available to use for quota purposes for server-side applications. Can be any
6156
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6157
+ # @param [Google::Apis::RequestOptions] options
6158
+ # Request-specific options
6159
+ #
6160
+ # @yield [result, err] Result & error if block supplied
6161
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer] parsed result object
6162
+ # @yieldparam err [StandardError] error object if request failed
6163
+ #
6164
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
6165
+ #
6166
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6167
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6168
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6169
+ def get_project_location_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
6170
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
6171
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
6172
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer
6173
+ command.params['name'] = name unless name.nil?
6174
+ command.query['fields'] = fields unless fields.nil?
6175
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6176
+ execute_or_queue_command(command, &block)
6177
+ end
6178
+
5294
6179
  # Downgrade from advanced site search to basic site search.
5295
6180
  # @param [String] site_search_engine
5296
6181
  # Required. Full resource name of the SiteSearchEngine, such as `projects/`
@@ -5809,8 +6694,12 @@ module Google
5809
6694
 
5810
6695
  # Writes a single user event.
5811
6696
  # @param [String] parent
5812
- # Required. The parent DataStore resource name, such as `projects/`project`/
5813
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
6697
+ # Required. The parent resource name. If the write user event action is applied
6698
+ # in DataStore level, the format is: `projects/`project`/locations/`location`/
6699
+ # collections/`collection`/dataStores/`data_store``. If the write user event
6700
+ # action is applied in Location level, for example, the event with Document
6701
+ # across multiple DataStore, the format is: `projects/`project`/locations/`
6702
+ # location``.
5814
6703
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
5815
6704
  # @param [String] fields
5816
6705
  # Selector specifying which fields to include in a partial response.
@@ -5841,6 +6730,71 @@ module Google
5841
6730
  execute_or_queue_command(command, &block)
5842
6731
  end
5843
6732
 
6733
+ # Gets the latest state of a long-running operation. Clients can use this method
6734
+ # to poll the operation result at intervals as recommended by the API service.
6735
+ # @param [String] name
6736
+ # The name of the operation resource.
6737
+ # @param [String] fields
6738
+ # Selector specifying which fields to include in a partial response.
6739
+ # @param [String] quota_user
6740
+ # Available to use for quota purposes for server-side applications. Can be any
6741
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6742
+ # @param [Google::Apis::RequestOptions] options
6743
+ # Request-specific options
6744
+ #
6745
+ # @yield [result, err] Result & error if block supplied
6746
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
6747
+ # @yieldparam err [StandardError] error object if request failed
6748
+ #
6749
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
6750
+ #
6751
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6752
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6753
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6754
+ def get_project_location_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
6755
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
6756
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
6757
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
6758
+ command.params['name'] = name unless name.nil?
6759
+ command.query['fields'] = fields unless fields.nil?
6760
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6761
+ execute_or_queue_command(command, &block)
6762
+ end
6763
+
6764
+ # Performs a grounding check.
6765
+ # @param [String] grounding_config
6766
+ # Required. The resource name of the grounding config, such as `projects/*/
6767
+ # locations/global/groundingConfigs/default_grounding_config`.
6768
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest] google_cloud_discoveryengine_v1alpha_check_grounding_request_object
6769
+ # @param [String] fields
6770
+ # Selector specifying which fields to include in a partial response.
6771
+ # @param [String] quota_user
6772
+ # Available to use for quota purposes for server-side applications. Can be any
6773
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6774
+ # @param [Google::Apis::RequestOptions] options
6775
+ # Request-specific options
6776
+ #
6777
+ # @yield [result, err] Result & error if block supplied
6778
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse] parsed result object
6779
+ # @yieldparam err [StandardError] error object if request failed
6780
+ #
6781
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse]
6782
+ #
6783
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6784
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6785
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6786
+ def check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1alpha_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6787
+ command = make_simple_command(:post, 'v1alpha/{+groundingConfig}:check', options)
6788
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest::Representation
6789
+ command.request_object = google_cloud_discoveryengine_v1alpha_check_grounding_request_object
6790
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse::Representation
6791
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse
6792
+ command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
6793
+ command.query['fields'] = fields unless fields.nil?
6794
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6795
+ execute_or_queue_command(command, &block)
6796
+ end
6797
+
5844
6798
  # Gets the latest state of a long-running operation. Clients can use this method
5845
6799
  # to poll the operation result at intervals as recommended by the API service.
5846
6800
  # @param [String] name
@@ -5946,6 +6900,75 @@ module Google
5946
6900
  execute_or_queue_command(command, &block)
5947
6901
  end
5948
6902
 
6903
+ # Gets the latest state of a long-running operation. Clients can use this method
6904
+ # to poll the operation result at intervals as recommended by the API service.
6905
+ # @param [String] name
6906
+ # The name of the operation resource.
6907
+ # @param [String] fields
6908
+ # Selector specifying which fields to include in a partial response.
6909
+ # @param [String] quota_user
6910
+ # Available to use for quota purposes for server-side applications. Can be any
6911
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6912
+ # @param [Google::Apis::RequestOptions] options
6913
+ # Request-specific options
6914
+ #
6915
+ # @yield [result, err] Result & error if block supplied
6916
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
6917
+ # @yieldparam err [StandardError] error object if request failed
6918
+ #
6919
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
6920
+ #
6921
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6922
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6923
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6924
+ def get_project_location_sample_query_set_operation(name, fields: nil, quota_user: nil, options: nil, &block)
6925
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
6926
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
6927
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
6928
+ command.params['name'] = name unless name.nil?
6929
+ command.query['fields'] = fields unless fields.nil?
6930
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6931
+ execute_or_queue_command(command, &block)
6932
+ end
6933
+
6934
+ # Writes a single user event.
6935
+ # @param [String] parent
6936
+ # Required. The parent resource name. If the write user event action is applied
6937
+ # in DataStore level, the format is: `projects/`project`/locations/`location`/
6938
+ # collections/`collection`/dataStores/`data_store``. If the write user event
6939
+ # action is applied in Location level, for example, the event with Document
6940
+ # across multiple DataStore, the format is: `projects/`project`/locations/`
6941
+ # location``.
6942
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
6943
+ # @param [String] fields
6944
+ # Selector specifying which fields to include in a partial response.
6945
+ # @param [String] quota_user
6946
+ # Available to use for quota purposes for server-side applications. Can be any
6947
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6948
+ # @param [Google::Apis::RequestOptions] options
6949
+ # Request-specific options
6950
+ #
6951
+ # @yield [result, err] Result & error if block supplied
6952
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] parsed result object
6953
+ # @yieldparam err [StandardError] error object if request failed
6954
+ #
6955
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
6956
+ #
6957
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6958
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6959
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6960
+ def write_project_location_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6961
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
6962
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6963
+ command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
6964
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6965
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
6966
+ command.params['parent'] = parent unless parent.nil?
6967
+ command.query['fields'] = fields unless fields.nil?
6968
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6969
+ execute_or_queue_command(command, &block)
6970
+ end
6971
+
5949
6972
  # Gets the latest state of a long-running operation. Clients can use this method
5950
6973
  # to poll the operation result at intervals as recommended by the API service.
5951
6974
  # @param [String] name