google-apis-discoveryengine_v1alpha 0.41.0 → 0.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1877,6 +1877,44 @@ module Google
1877
1877
  execute_or_queue_command(command, &block)
1878
1878
  end
1879
1879
 
1880
+ # Answer query method.
1881
+ # @param [String] serving_config
1882
+ # Required. The resource name of the Search serving config, such as `projects/*/
1883
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
1884
+ # default_serving_config`, or `projects/*/locations/global/collections/
1885
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
1886
+ # field is used to identify the serving configuration name, set of models used
1887
+ # to make the search.
1888
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
1889
+ # @param [String] fields
1890
+ # Selector specifying which fields to include in a partial response.
1891
+ # @param [String] quota_user
1892
+ # Available to use for quota purposes for server-side applications. Can be any
1893
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1894
+ # @param [Google::Apis::RequestOptions] options
1895
+ # Request-specific options
1896
+ #
1897
+ # @yield [result, err] Result & error if block supplied
1898
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
1899
+ # @yieldparam err [StandardError] error object if request failed
1900
+ #
1901
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
1902
+ #
1903
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1904
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1905
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1906
+ 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)
1907
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:answer', options)
1908
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
1909
+ command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
1910
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
1911
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
1912
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1913
+ command.query['fields'] = fields unless fields.nil?
1914
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1915
+ execute_or_queue_command(command, &block)
1916
+ end
1917
+
1880
1918
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
1881
1919
  # exist.
1882
1920
  # @param [String] name
@@ -2068,6 +2106,227 @@ module Google
2068
2106
  execute_or_queue_command(command, &block)
2069
2107
  end
2070
2108
 
2109
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
2110
+ # error is returned.
2111
+ # @param [String] parent
2112
+ # Required. Full resource name of parent data store. Format: `projects/`
2113
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2114
+ # data_store_id``
2115
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
2116
+ # @param [String] fields
2117
+ # Selector specifying which fields to include in a partial response.
2118
+ # @param [String] quota_user
2119
+ # Available to use for quota purposes for server-side applications. Can be any
2120
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2121
+ # @param [Google::Apis::RequestOptions] options
2122
+ # Request-specific options
2123
+ #
2124
+ # @yield [result, err] Result & error if block supplied
2125
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
2126
+ # @yieldparam err [StandardError] error object if request failed
2127
+ #
2128
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
2129
+ #
2130
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2131
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2132
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2133
+ def create_project_location_collection_data_store_session(parent, google_cloud_discoveryengine_v1alpha_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2134
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sessions', options)
2135
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2136
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
2137
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2138
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
2139
+ command.params['parent'] = parent unless parent.nil?
2140
+ command.query['fields'] = fields unless fields.nil?
2141
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2142
+ execute_or_queue_command(command, &block)
2143
+ end
2144
+
2145
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
2146
+ # is returned.
2147
+ # @param [String] name
2148
+ # Required. The resource name of the Session to delete. Format: `projects/`
2149
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2150
+ # data_store_id`/sessions/`session_id``
2151
+ # @param [String] fields
2152
+ # Selector specifying which fields to include in a partial response.
2153
+ # @param [String] quota_user
2154
+ # Available to use for quota purposes for server-side applications. Can be any
2155
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2156
+ # @param [Google::Apis::RequestOptions] options
2157
+ # Request-specific options
2158
+ #
2159
+ # @yield [result, err] Result & error if block supplied
2160
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
2161
+ # @yieldparam err [StandardError] error object if request failed
2162
+ #
2163
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
2164
+ #
2165
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2166
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2167
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2168
+ def delete_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
2169
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2170
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
2171
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
2172
+ command.params['name'] = name unless name.nil?
2173
+ command.query['fields'] = fields unless fields.nil?
2174
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2175
+ execute_or_queue_command(command, &block)
2176
+ end
2177
+
2178
+ # Gets a Session.
2179
+ # @param [String] name
2180
+ # Required. The resource name of the Session to get. Format: `projects/`
2181
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2182
+ # data_store_id`/sessions/`session_id``
2183
+ # @param [String] fields
2184
+ # Selector specifying which fields to include in a partial response.
2185
+ # @param [String] quota_user
2186
+ # Available to use for quota purposes for server-side applications. Can be any
2187
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2188
+ # @param [Google::Apis::RequestOptions] options
2189
+ # Request-specific options
2190
+ #
2191
+ # @yield [result, err] Result & error if block supplied
2192
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
2193
+ # @yieldparam err [StandardError] error object if request failed
2194
+ #
2195
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
2196
+ #
2197
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2198
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2199
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2200
+ def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
2201
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2202
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2203
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
2204
+ command.params['name'] = name unless name.nil?
2205
+ command.query['fields'] = fields unless fields.nil?
2206
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2207
+ execute_or_queue_command(command, &block)
2208
+ end
2209
+
2210
+ # Lists all Sessions by their parent DataStore.
2211
+ # @param [String] parent
2212
+ # Required. The data store resource name. Format: `projects/`project_number`/
2213
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
2214
+ # @param [String] filter
2215
+ # A filter to apply on the list results. The supported features are:
2216
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
2217
+ # @param [String] order_by
2218
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
2219
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
2220
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
2221
+ # @param [Fixnum] page_size
2222
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
2223
+ # allowed value is 1000.
2224
+ # @param [String] page_token
2225
+ # A page token, received from a previous `ListSessions` call. Provide this to
2226
+ # retrieve the subsequent page.
2227
+ # @param [String] fields
2228
+ # Selector specifying which fields to include in a partial response.
2229
+ # @param [String] quota_user
2230
+ # Available to use for quota purposes for server-side applications. Can be any
2231
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2232
+ # @param [Google::Apis::RequestOptions] options
2233
+ # Request-specific options
2234
+ #
2235
+ # @yield [result, err] Result & error if block supplied
2236
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse] parsed result object
2237
+ # @yieldparam err [StandardError] error object if request failed
2238
+ #
2239
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse]
2240
+ #
2241
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2242
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2243
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2244
+ 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)
2245
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sessions', options)
2246
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse::Representation
2247
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse
2248
+ command.params['parent'] = parent unless parent.nil?
2249
+ command.query['filter'] = filter unless filter.nil?
2250
+ command.query['orderBy'] = order_by unless order_by.nil?
2251
+ command.query['pageSize'] = page_size unless page_size.nil?
2252
+ command.query['pageToken'] = page_token unless page_token.nil?
2253
+ command.query['fields'] = fields unless fields.nil?
2254
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2255
+ execute_or_queue_command(command, &block)
2256
+ end
2257
+
2258
+ # Updates a Session. Session action type cannot be changed. If the Session to
2259
+ # update does not exist, a NOT_FOUND error is returned.
2260
+ # @param [String] name
2261
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
2262
+ # collection`/engines/`engine`/sessions/*`
2263
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
2264
+ # @param [String] update_mask
2265
+ # Indicates which fields in the provided Session to update. The following are
2266
+ # NOT supported: * Session.name If not set or empty, all supported fields are
2267
+ # updated.
2268
+ # @param [String] fields
2269
+ # Selector specifying which fields to include in a partial response.
2270
+ # @param [String] quota_user
2271
+ # Available to use for quota purposes for server-side applications. Can be any
2272
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2273
+ # @param [Google::Apis::RequestOptions] options
2274
+ # Request-specific options
2275
+ #
2276
+ # @yield [result, err] Result & error if block supplied
2277
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
2278
+ # @yieldparam err [StandardError] error object if request failed
2279
+ #
2280
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
2281
+ #
2282
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2283
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2284
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2285
+ 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)
2286
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2287
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2288
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
2289
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
2290
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
2291
+ command.params['name'] = name unless name.nil?
2292
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2293
+ command.query['fields'] = fields unless fields.nil?
2294
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2295
+ execute_or_queue_command(command, &block)
2296
+ end
2297
+
2298
+ # Gets a Answer.
2299
+ # @param [String] name
2300
+ # Required. The resource name of the Answer to get. Format: `projects/`
2301
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
2302
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
2303
+ # @param [String] fields
2304
+ # Selector specifying which fields to include in a partial response.
2305
+ # @param [String] quota_user
2306
+ # Available to use for quota purposes for server-side applications. Can be any
2307
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2308
+ # @param [Google::Apis::RequestOptions] options
2309
+ # Request-specific options
2310
+ #
2311
+ # @yield [result, err] Result & error if block supplied
2312
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer] parsed result object
2313
+ # @yieldparam err [StandardError] error object if request failed
2314
+ #
2315
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
2316
+ #
2317
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2318
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2319
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2320
+ def get_project_location_collection_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
2321
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2322
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
2323
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer
2324
+ command.params['name'] = name unless name.nil?
2325
+ command.query['fields'] = fields unless fields.nil?
2326
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2327
+ execute_or_queue_command(command, &block)
2328
+ end
2329
+
2071
2330
  # Verify target sites' ownership and validity. This API sends all the target
2072
2331
  # sites under site search engine for verification.
2073
2332
  # @param [String] parent
@@ -3433,6 +3692,44 @@ module Google
3433
3692
  execute_or_queue_command(command, &block)
3434
3693
  end
3435
3694
 
3695
+ # Answer query method.
3696
+ # @param [String] serving_config
3697
+ # Required. The resource name of the Search serving config, such as `projects/*/
3698
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
3699
+ # default_serving_config`, or `projects/*/locations/global/collections/
3700
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
3701
+ # field is used to identify the serving configuration name, set of models used
3702
+ # to make the search.
3703
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
3704
+ # @param [String] fields
3705
+ # Selector specifying which fields to include in a partial response.
3706
+ # @param [String] quota_user
3707
+ # Available to use for quota purposes for server-side applications. Can be any
3708
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3709
+ # @param [Google::Apis::RequestOptions] options
3710
+ # Request-specific options
3711
+ #
3712
+ # @yield [result, err] Result & error if block supplied
3713
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
3714
+ # @yieldparam err [StandardError] error object if request failed
3715
+ #
3716
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
3717
+ #
3718
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3719
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3720
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3721
+ 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)
3722
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:answer', options)
3723
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
3724
+ command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
3725
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
3726
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
3727
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
3728
+ command.query['fields'] = fields unless fields.nil?
3729
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3730
+ execute_or_queue_command(command, &block)
3731
+ end
3732
+
3436
3733
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
3437
3734
  # exist.
3438
3735
  # @param [String] name
@@ -3624,10 +3921,13 @@ module Google
3624
3921
  execute_or_queue_command(command, &block)
3625
3922
  end
3626
3923
 
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.
3924
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
3925
+ # error is returned.
3926
+ # @param [String] parent
3927
+ # Required. Full resource name of parent data store. Format: `projects/`
3928
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3929
+ # data_store_id``
3930
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
3631
3931
  # @param [String] fields
3632
3932
  # Selector specifying which fields to include in a partial response.
3633
3933
  # @param [String] quota_user
@@ -3637,34 +3937,32 @@ module Google
3637
3937
  # Request-specific options
3638
3938
  #
3639
3939
  # @yield [result, err] Result & error if block supplied
3640
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
3940
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
3641
3941
  # @yieldparam err [StandardError] error object if request failed
3642
3942
  #
3643
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
3943
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
3644
3944
  #
3645
3945
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3646
3946
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3647
3947
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3648
- def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
3649
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
3650
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
3651
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
3652
- command.params['name'] = name unless name.nil?
3948
+ def create_project_location_collection_engine_session(parent, google_cloud_discoveryengine_v1alpha_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3949
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sessions', options)
3950
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
3951
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
3952
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
3953
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
3954
+ command.params['parent'] = parent unless parent.nil?
3653
3955
  command.query['fields'] = fields unless fields.nil?
3654
3956
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3655
3957
  execute_or_queue_command(command, &block)
3656
3958
  end
3657
3959
 
3658
- # Lists operations that match the specified filter in the request. If the server
3659
- # doesn't support this method, it returns `UNIMPLEMENTED`.
3960
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
3961
+ # is returned.
3660
3962
  # @param [String] name
3661
- # The name of the operation's parent resource.
3662
- # @param [String] filter
3663
- # The standard list filter.
3664
- # @param [Fixnum] page_size
3665
- # The standard list page size.
3666
- # @param [String] page_token
3667
- # The standard list page token.
3963
+ # Required. The resource name of the Session to delete. Format: `projects/`
3964
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3965
+ # data_store_id`/sessions/`session_id``
3668
3966
  # @param [String] fields
3669
3967
  # Selector specifying which fields to include in a partial response.
3670
3968
  # @param [String] quota_user
@@ -3674,28 +3972,248 @@ module Google
3674
3972
  # Request-specific options
3675
3973
  #
3676
3974
  # @yield [result, err] Result & error if block supplied
3677
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
3975
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
3678
3976
  # @yieldparam err [StandardError] error object if request failed
3679
3977
  #
3680
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
3978
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
3681
3979
  #
3682
3980
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3683
3981
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3684
3982
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3685
- def list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3686
- command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
3687
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
3688
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
3983
+ def delete_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
3984
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
3985
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
3986
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
3689
3987
  command.params['name'] = name unless name.nil?
3690
- command.query['filter'] = filter unless filter.nil?
3691
- command.query['pageSize'] = page_size unless page_size.nil?
3692
- command.query['pageToken'] = page_token unless page_token.nil?
3693
3988
  command.query['fields'] = fields unless fields.nil?
3694
3989
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3695
3990
  execute_or_queue_command(command, &block)
3696
3991
  end
3697
3992
 
3698
- # Completes the specified user input with keyword suggestions.
3993
+ # Gets a Session.
3994
+ # @param [String] name
3995
+ # Required. The resource name of the Session to get. Format: `projects/`
3996
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3997
+ # data_store_id`/sessions/`session_id``
3998
+ # @param [String] fields
3999
+ # Selector specifying which fields to include in a partial response.
4000
+ # @param [String] quota_user
4001
+ # Available to use for quota purposes for server-side applications. Can be any
4002
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4003
+ # @param [Google::Apis::RequestOptions] options
4004
+ # Request-specific options
4005
+ #
4006
+ # @yield [result, err] Result & error if block supplied
4007
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
4008
+ # @yieldparam err [StandardError] error object if request failed
4009
+ #
4010
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
4011
+ #
4012
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4013
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4014
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4015
+ def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
4016
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4017
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4018
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
4019
+ command.params['name'] = name unless name.nil?
4020
+ command.query['fields'] = fields unless fields.nil?
4021
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4022
+ execute_or_queue_command(command, &block)
4023
+ end
4024
+
4025
+ # Lists all Sessions by their parent DataStore.
4026
+ # @param [String] parent
4027
+ # Required. The data store resource name. Format: `projects/`project_number`/
4028
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
4029
+ # @param [String] filter
4030
+ # A filter to apply on the list results. The supported features are:
4031
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
4032
+ # @param [String] order_by
4033
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
4034
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
4035
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
4036
+ # @param [Fixnum] page_size
4037
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
4038
+ # allowed value is 1000.
4039
+ # @param [String] page_token
4040
+ # A page token, received from a previous `ListSessions` call. Provide this to
4041
+ # retrieve the subsequent page.
4042
+ # @param [String] fields
4043
+ # Selector specifying which fields to include in a partial response.
4044
+ # @param [String] quota_user
4045
+ # Available to use for quota purposes for server-side applications. Can be any
4046
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4047
+ # @param [Google::Apis::RequestOptions] options
4048
+ # Request-specific options
4049
+ #
4050
+ # @yield [result, err] Result & error if block supplied
4051
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse] parsed result object
4052
+ # @yieldparam err [StandardError] error object if request failed
4053
+ #
4054
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse]
4055
+ #
4056
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4057
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4058
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4059
+ 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)
4060
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sessions', options)
4061
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse::Representation
4062
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse
4063
+ command.params['parent'] = parent unless parent.nil?
4064
+ command.query['filter'] = filter unless filter.nil?
4065
+ command.query['orderBy'] = order_by unless order_by.nil?
4066
+ command.query['pageSize'] = page_size unless page_size.nil?
4067
+ command.query['pageToken'] = page_token unless page_token.nil?
4068
+ command.query['fields'] = fields unless fields.nil?
4069
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4070
+ execute_or_queue_command(command, &block)
4071
+ end
4072
+
4073
+ # Updates a Session. Session action type cannot be changed. If the Session to
4074
+ # update does not exist, a NOT_FOUND error is returned.
4075
+ # @param [String] name
4076
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
4077
+ # collection`/engines/`engine`/sessions/*`
4078
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
4079
+ # @param [String] update_mask
4080
+ # Indicates which fields in the provided Session to update. The following are
4081
+ # NOT supported: * Session.name If not set or empty, all supported fields are
4082
+ # updated.
4083
+ # @param [String] fields
4084
+ # Selector specifying which fields to include in a partial response.
4085
+ # @param [String] quota_user
4086
+ # Available to use for quota purposes for server-side applications. Can be any
4087
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4088
+ # @param [Google::Apis::RequestOptions] options
4089
+ # Request-specific options
4090
+ #
4091
+ # @yield [result, err] Result & error if block supplied
4092
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
4093
+ # @yieldparam err [StandardError] error object if request failed
4094
+ #
4095
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
4096
+ #
4097
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4098
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4099
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4100
+ 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)
4101
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
4102
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4103
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
4104
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
4105
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
4106
+ command.params['name'] = name unless name.nil?
4107
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4108
+ command.query['fields'] = fields unless fields.nil?
4109
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4110
+ execute_or_queue_command(command, &block)
4111
+ end
4112
+
4113
+ # Gets a Answer.
4114
+ # @param [String] name
4115
+ # Required. The resource name of the Answer to get. Format: `projects/`
4116
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
4117
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
4118
+ # @param [String] fields
4119
+ # Selector specifying which fields to include in a partial response.
4120
+ # @param [String] quota_user
4121
+ # Available to use for quota purposes for server-side applications. Can be any
4122
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4123
+ # @param [Google::Apis::RequestOptions] options
4124
+ # Request-specific options
4125
+ #
4126
+ # @yield [result, err] Result & error if block supplied
4127
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer] parsed result object
4128
+ # @yieldparam err [StandardError] error object if request failed
4129
+ #
4130
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
4131
+ #
4132
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4133
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4134
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4135
+ def get_project_location_collection_engine_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
4136
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4137
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
4138
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer
4139
+ command.params['name'] = name unless name.nil?
4140
+ command.query['fields'] = fields unless fields.nil?
4141
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4142
+ execute_or_queue_command(command, &block)
4143
+ end
4144
+
4145
+ # Gets the latest state of a long-running operation. Clients can use this method
4146
+ # to poll the operation result at intervals as recommended by the API service.
4147
+ # @param [String] name
4148
+ # The name of the operation resource.
4149
+ # @param [String] fields
4150
+ # Selector specifying which fields to include in a partial response.
4151
+ # @param [String] quota_user
4152
+ # Available to use for quota purposes for server-side applications. Can be any
4153
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4154
+ # @param [Google::Apis::RequestOptions] options
4155
+ # Request-specific options
4156
+ #
4157
+ # @yield [result, err] Result & error if block supplied
4158
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4159
+ # @yieldparam err [StandardError] error object if request failed
4160
+ #
4161
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4162
+ #
4163
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4164
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4165
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4166
+ def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
4167
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4168
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4169
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4170
+ command.params['name'] = name unless name.nil?
4171
+ command.query['fields'] = fields unless fields.nil?
4172
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4173
+ execute_or_queue_command(command, &block)
4174
+ end
4175
+
4176
+ # Lists operations that match the specified filter in the request. If the server
4177
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
4178
+ # @param [String] name
4179
+ # The name of the operation's parent resource.
4180
+ # @param [String] filter
4181
+ # The standard list filter.
4182
+ # @param [Fixnum] page_size
4183
+ # The standard list page size.
4184
+ # @param [String] page_token
4185
+ # The standard list page token.
4186
+ # @param [String] fields
4187
+ # Selector specifying which fields to include in a partial response.
4188
+ # @param [String] quota_user
4189
+ # Available to use for quota purposes for server-side applications. Can be any
4190
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4191
+ # @param [Google::Apis::RequestOptions] options
4192
+ # Request-specific options
4193
+ #
4194
+ # @yield [result, err] Result & error if block supplied
4195
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
4196
+ # @yieldparam err [StandardError] error object if request failed
4197
+ #
4198
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
4199
+ #
4200
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4201
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4202
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4203
+ def list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4204
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
4205
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
4206
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
4207
+ command.params['name'] = name unless name.nil?
4208
+ command.query['filter'] = filter unless filter.nil?
4209
+ command.query['pageSize'] = page_size unless page_size.nil?
4210
+ command.query['pageToken'] = page_token unless page_token.nil?
4211
+ command.query['fields'] = fields unless fields.nil?
4212
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4213
+ execute_or_queue_command(command, &block)
4214
+ end
4215
+
4216
+ # Completes the specified user input with keyword suggestions.
3699
4217
  # @param [String] data_store
3700
4218
  # Required. The parent data store resource name for which the completion is
3701
4219
  # performed, such as `projects/*/locations/global/collections/default_collection/
@@ -5100,6 +5618,44 @@ module Google
5100
5618
  execute_or_queue_command(command, &block)
5101
5619
  end
5102
5620
 
5621
+ # Answer query method.
5622
+ # @param [String] serving_config
5623
+ # Required. The resource name of the Search serving config, such as `projects/*/
5624
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
5625
+ # default_serving_config`, or `projects/*/locations/global/collections/
5626
+ # default_collection/dataStores/*/servingConfigs/default_serving_config`. This
5627
+ # field is used to identify the serving configuration name, set of models used
5628
+ # to make the search.
5629
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
5630
+ # @param [String] fields
5631
+ # Selector specifying which fields to include in a partial response.
5632
+ # @param [String] quota_user
5633
+ # Available to use for quota purposes for server-side applications. Can be any
5634
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5635
+ # @param [Google::Apis::RequestOptions] options
5636
+ # Request-specific options
5637
+ #
5638
+ # @yield [result, err] Result & error if block supplied
5639
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
5640
+ # @yieldparam err [StandardError] error object if request failed
5641
+ #
5642
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
5643
+ #
5644
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5645
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5646
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5647
+ 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)
5648
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:answer', options)
5649
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
5650
+ command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
5651
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
5652
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
5653
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
5654
+ command.query['fields'] = fields unless fields.nil?
5655
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5656
+ execute_or_queue_command(command, &block)
5657
+ end
5658
+
5103
5659
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
5104
5660
  # exist.
5105
5661
  # @param [String] name
@@ -5291,6 +5847,227 @@ module Google
5291
5847
  execute_or_queue_command(command, &block)
5292
5848
  end
5293
5849
 
5850
+ # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
5851
+ # error is returned.
5852
+ # @param [String] parent
5853
+ # Required. Full resource name of parent data store. Format: `projects/`
5854
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5855
+ # data_store_id``
5856
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
5857
+ # @param [String] fields
5858
+ # Selector specifying which fields to include in a partial response.
5859
+ # @param [String] quota_user
5860
+ # Available to use for quota purposes for server-side applications. Can be any
5861
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5862
+ # @param [Google::Apis::RequestOptions] options
5863
+ # Request-specific options
5864
+ #
5865
+ # @yield [result, err] Result & error if block supplied
5866
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
5867
+ # @yieldparam err [StandardError] error object if request failed
5868
+ #
5869
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
5870
+ #
5871
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5872
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5873
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5874
+ def create_project_location_data_store_session(parent, google_cloud_discoveryengine_v1alpha_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5875
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sessions', options)
5876
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
5877
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
5878
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
5879
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
5880
+ command.params['parent'] = parent unless parent.nil?
5881
+ command.query['fields'] = fields unless fields.nil?
5882
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5883
+ execute_or_queue_command(command, &block)
5884
+ end
5885
+
5886
+ # Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
5887
+ # is returned.
5888
+ # @param [String] name
5889
+ # Required. The resource name of the Session to delete. Format: `projects/`
5890
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5891
+ # data_store_id`/sessions/`session_id``
5892
+ # @param [String] fields
5893
+ # Selector specifying which fields to include in a partial response.
5894
+ # @param [String] quota_user
5895
+ # Available to use for quota purposes for server-side applications. Can be any
5896
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5897
+ # @param [Google::Apis::RequestOptions] options
5898
+ # Request-specific options
5899
+ #
5900
+ # @yield [result, err] Result & error if block supplied
5901
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
5902
+ # @yieldparam err [StandardError] error object if request failed
5903
+ #
5904
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
5905
+ #
5906
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5907
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5908
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5909
+ def delete_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
5910
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
5911
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
5912
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
5913
+ command.params['name'] = name unless name.nil?
5914
+ command.query['fields'] = fields unless fields.nil?
5915
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5916
+ execute_or_queue_command(command, &block)
5917
+ end
5918
+
5919
+ # Gets a Session.
5920
+ # @param [String] name
5921
+ # Required. The resource name of the Session to get. Format: `projects/`
5922
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5923
+ # data_store_id`/sessions/`session_id``
5924
+ # @param [String] fields
5925
+ # Selector specifying which fields to include in a partial response.
5926
+ # @param [String] quota_user
5927
+ # Available to use for quota purposes for server-side applications. Can be any
5928
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5929
+ # @param [Google::Apis::RequestOptions] options
5930
+ # Request-specific options
5931
+ #
5932
+ # @yield [result, err] Result & error if block supplied
5933
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
5934
+ # @yieldparam err [StandardError] error object if request failed
5935
+ #
5936
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
5937
+ #
5938
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5939
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5940
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5941
+ def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
5942
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
5943
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
5944
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
5945
+ command.params['name'] = name unless name.nil?
5946
+ command.query['fields'] = fields unless fields.nil?
5947
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5948
+ execute_or_queue_command(command, &block)
5949
+ end
5950
+
5951
+ # Lists all Sessions by their parent DataStore.
5952
+ # @param [String] parent
5953
+ # Required. The data store resource name. Format: `projects/`project_number`/
5954
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
5955
+ # @param [String] filter
5956
+ # A filter to apply on the list results. The supported features are:
5957
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
5958
+ # @param [String] order_by
5959
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
5960
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
5961
+ # create_time` * `session_name` Example: "update_time desc" "create_time"
5962
+ # @param [Fixnum] page_size
5963
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
5964
+ # allowed value is 1000.
5965
+ # @param [String] page_token
5966
+ # A page token, received from a previous `ListSessions` call. Provide this to
5967
+ # retrieve the subsequent page.
5968
+ # @param [String] fields
5969
+ # Selector specifying which fields to include in a partial response.
5970
+ # @param [String] quota_user
5971
+ # Available to use for quota purposes for server-side applications. Can be any
5972
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5973
+ # @param [Google::Apis::RequestOptions] options
5974
+ # Request-specific options
5975
+ #
5976
+ # @yield [result, err] Result & error if block supplied
5977
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse] parsed result object
5978
+ # @yieldparam err [StandardError] error object if request failed
5979
+ #
5980
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse]
5981
+ #
5982
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5983
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5984
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5985
+ 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)
5986
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sessions', options)
5987
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse::Representation
5988
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsResponse
5989
+ command.params['parent'] = parent unless parent.nil?
5990
+ command.query['filter'] = filter unless filter.nil?
5991
+ command.query['orderBy'] = order_by unless order_by.nil?
5992
+ command.query['pageSize'] = page_size unless page_size.nil?
5993
+ command.query['pageToken'] = page_token unless page_token.nil?
5994
+ command.query['fields'] = fields unless fields.nil?
5995
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5996
+ execute_or_queue_command(command, &block)
5997
+ end
5998
+
5999
+ # Updates a Session. Session action type cannot be changed. If the Session to
6000
+ # update does not exist, a NOT_FOUND error is returned.
6001
+ # @param [String] name
6002
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
6003
+ # collection`/engines/`engine`/sessions/*`
6004
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
6005
+ # @param [String] update_mask
6006
+ # Indicates which fields in the provided Session to update. The following are
6007
+ # NOT supported: * Session.name If not set or empty, all supported fields are
6008
+ # updated.
6009
+ # @param [String] fields
6010
+ # Selector specifying which fields to include in a partial response.
6011
+ # @param [String] quota_user
6012
+ # Available to use for quota purposes for server-side applications. Can be any
6013
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6014
+ # @param [Google::Apis::RequestOptions] options
6015
+ # Request-specific options
6016
+ #
6017
+ # @yield [result, err] Result & error if block supplied
6018
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] parsed result object
6019
+ # @yieldparam err [StandardError] error object if request failed
6020
+ #
6021
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
6022
+ #
6023
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6024
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6025
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6026
+ 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)
6027
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
6028
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
6029
+ command.request_object = google_cloud_discoveryengine_v1alpha_session_object
6030
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
6031
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
6032
+ command.params['name'] = name unless name.nil?
6033
+ command.query['updateMask'] = update_mask unless update_mask.nil?
6034
+ command.query['fields'] = fields unless fields.nil?
6035
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6036
+ execute_or_queue_command(command, &block)
6037
+ end
6038
+
6039
+ # Gets a Answer.
6040
+ # @param [String] name
6041
+ # Required. The resource name of the Answer to get. Format: `projects/`
6042
+ # project_number`/locations/`location_id`/collections/`collection`/engines/`
6043
+ # engine_id`/sessions/`session_id`/answers/`answer_id``
6044
+ # @param [String] fields
6045
+ # Selector specifying which fields to include in a partial response.
6046
+ # @param [String] quota_user
6047
+ # Available to use for quota purposes for server-side applications. Can be any
6048
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6049
+ # @param [Google::Apis::RequestOptions] options
6050
+ # Request-specific options
6051
+ #
6052
+ # @yield [result, err] Result & error if block supplied
6053
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer] parsed result object
6054
+ # @yieldparam err [StandardError] error object if request failed
6055
+ #
6056
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
6057
+ #
6058
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6059
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6060
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6061
+ def get_project_location_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
6062
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
6063
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
6064
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer
6065
+ command.params['name'] = name unless name.nil?
6066
+ command.query['fields'] = fields unless fields.nil?
6067
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6068
+ execute_or_queue_command(command, &block)
6069
+ end
6070
+
5294
6071
  # Downgrade from advanced site search to basic site search.
5295
6072
  # @param [String] site_search_engine
5296
6073
  # Required. Full resource name of the SiteSearchEngine, such as `projects/`
@@ -5841,6 +6618,71 @@ module Google
5841
6618
  execute_or_queue_command(command, &block)
5842
6619
  end
5843
6620
 
6621
+ # Gets the latest state of a long-running operation. Clients can use this method
6622
+ # to poll the operation result at intervals as recommended by the API service.
6623
+ # @param [String] name
6624
+ # The name of the operation resource.
6625
+ # @param [String] fields
6626
+ # Selector specifying which fields to include in a partial response.
6627
+ # @param [String] quota_user
6628
+ # Available to use for quota purposes for server-side applications. Can be any
6629
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6630
+ # @param [Google::Apis::RequestOptions] options
6631
+ # Request-specific options
6632
+ #
6633
+ # @yield [result, err] Result & error if block supplied
6634
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
6635
+ # @yieldparam err [StandardError] error object if request failed
6636
+ #
6637
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
6638
+ #
6639
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6640
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6641
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6642
+ def get_project_location_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
6643
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
6644
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
6645
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
6646
+ command.params['name'] = name unless name.nil?
6647
+ command.query['fields'] = fields unless fields.nil?
6648
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6649
+ execute_or_queue_command(command, &block)
6650
+ end
6651
+
6652
+ # Performs a grounding check.
6653
+ # @param [String] grounding_config
6654
+ # Required. The resource name of the grounding config, such as `projects/*/
6655
+ # locations/global/groundingConfigs/default_grounding_config`.
6656
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest] google_cloud_discoveryengine_v1alpha_check_grounding_request_object
6657
+ # @param [String] fields
6658
+ # Selector specifying which fields to include in a partial response.
6659
+ # @param [String] quota_user
6660
+ # Available to use for quota purposes for server-side applications. Can be any
6661
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6662
+ # @param [Google::Apis::RequestOptions] options
6663
+ # Request-specific options
6664
+ #
6665
+ # @yield [result, err] Result & error if block supplied
6666
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse] parsed result object
6667
+ # @yieldparam err [StandardError] error object if request failed
6668
+ #
6669
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse]
6670
+ #
6671
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6672
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6673
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6674
+ 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)
6675
+ command = make_simple_command(:post, 'v1alpha/{+groundingConfig}:check', options)
6676
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest::Representation
6677
+ command.request_object = google_cloud_discoveryengine_v1alpha_check_grounding_request_object
6678
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse::Representation
6679
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse
6680
+ command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
6681
+ command.query['fields'] = fields unless fields.nil?
6682
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6683
+ execute_or_queue_command(command, &block)
6684
+ end
6685
+
5844
6686
  # Gets the latest state of a long-running operation. Clients can use this method
5845
6687
  # to poll the operation result at intervals as recommended by the API service.
5846
6688
  # @param [String] name
@@ -5912,6 +6754,40 @@ module Google
5912
6754
  execute_or_queue_command(command, &block)
5913
6755
  end
5914
6756
 
6757
+ # Ranks a list of text records based on the given input query.
6758
+ # @param [String] ranking_config
6759
+ # Required. The resource name of the rank service config, such as `projects/`
6760
+ # project_num`/locations/`location_id`/rankingConfigs/default_ranking_config`.
6761
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankRequest] google_cloud_discoveryengine_v1alpha_rank_request_object
6762
+ # @param [String] fields
6763
+ # Selector specifying which fields to include in a partial response.
6764
+ # @param [String] quota_user
6765
+ # Available to use for quota purposes for server-side applications. Can be any
6766
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6767
+ # @param [Google::Apis::RequestOptions] options
6768
+ # Request-specific options
6769
+ #
6770
+ # @yield [result, err] Result & error if block supplied
6771
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse] parsed result object
6772
+ # @yieldparam err [StandardError] error object if request failed
6773
+ #
6774
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse]
6775
+ #
6776
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6777
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6778
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6779
+ def rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1alpha_rank_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6780
+ command = make_simple_command(:post, 'v1alpha/{+rankingConfig}:rank', options)
6781
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankRequest::Representation
6782
+ command.request_object = google_cloud_discoveryengine_v1alpha_rank_request_object
6783
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse::Representation
6784
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse
6785
+ command.params['rankingConfig'] = ranking_config unless ranking_config.nil?
6786
+ command.query['fields'] = fields unless fields.nil?
6787
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6788
+ execute_or_queue_command(command, &block)
6789
+ end
6790
+
5915
6791
  # Gets the latest state of a long-running operation. Clients can use this method
5916
6792
  # to poll the operation result at intervals as recommended by the API service.
5917
6793
  # @param [String] name