google-apis-dialogflow_v2 0.6.0 → 0.7.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.
@@ -2093,6 +2093,2436 @@ module Google
2093
2093
  execute_or_queue_command(command, &block)
2094
2094
  end
2095
2095
 
2096
+ # Returns the list of all answer records in the specified project in reverse
2097
+ # chronological order.
2098
+ # @param [String] parent
2099
+ # Required. The project to list all answer records for in reverse chronological
2100
+ # order. Format: `projects//locations/`.
2101
+ # @param [String] filter
2102
+ # Required. Filters to restrict results to specific answer records. Filter on
2103
+ # answer record type. Currently predicates on `type` is supported, valid values
2104
+ # are `ARTICLE_ANSWER`, `FAQ_ANSWER`. For more information about filtering, see [
2105
+ # API Filtering](https://aip.dev/160).
2106
+ # @param [Fixnum] page_size
2107
+ # Optional. The maximum number of records to return in a single page. The server
2108
+ # may return fewer records than this. If unspecified, we use 10. The maximum is
2109
+ # 100.
2110
+ # @param [String] page_token
2111
+ # Optional. The ListAnswerRecordsResponse.next_page_token value returned from a
2112
+ # previous list request used to continue listing on the next page.
2113
+ # @param [String] fields
2114
+ # Selector specifying which fields to include in a partial response.
2115
+ # @param [String] quota_user
2116
+ # Available to use for quota purposes for server-side applications. Can be any
2117
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2118
+ # @param [Google::Apis::RequestOptions] options
2119
+ # Request-specific options
2120
+ #
2121
+ # @yield [result, err] Result & error if block supplied
2122
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse] parsed result object
2123
+ # @yieldparam err [StandardError] error object if request failed
2124
+ #
2125
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse]
2126
+ #
2127
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2128
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2129
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2130
+ def list_project_answer_records(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2131
+ command = make_simple_command(:get, 'v2/{+parent}/answerRecords', options)
2132
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse::Representation
2133
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse
2134
+ command.params['parent'] = parent unless parent.nil?
2135
+ command.query['filter'] = filter unless filter.nil?
2136
+ command.query['pageSize'] = page_size unless page_size.nil?
2137
+ command.query['pageToken'] = page_token unless page_token.nil?
2138
+ command.query['fields'] = fields unless fields.nil?
2139
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2140
+ execute_or_queue_command(command, &block)
2141
+ end
2142
+
2143
+ # Updates the specified answer record.
2144
+ # @param [String] name
2145
+ # The unique identifier of this answer record. Format: `projects//locations//
2146
+ # answerRecords/`.
2147
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord] google_cloud_dialogflow_v2_answer_record_object
2148
+ # @param [String] update_mask
2149
+ # Required. The mask to control which fields get updated.
2150
+ # @param [String] fields
2151
+ # Selector specifying which fields to include in a partial response.
2152
+ # @param [String] quota_user
2153
+ # Available to use for quota purposes for server-side applications. Can be any
2154
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2155
+ # @param [Google::Apis::RequestOptions] options
2156
+ # Request-specific options
2157
+ #
2158
+ # @yield [result, err] Result & error if block supplied
2159
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord] parsed result object
2160
+ # @yieldparam err [StandardError] error object if request failed
2161
+ #
2162
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord]
2163
+ #
2164
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2165
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2166
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2167
+ def patch_project_answer_record(name, google_cloud_dialogflow_v2_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2168
+ command = make_simple_command(:patch, 'v2/{+name}', options)
2169
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord::Representation
2170
+ command.request_object = google_cloud_dialogflow_v2_answer_record_object
2171
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord::Representation
2172
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord
2173
+ command.params['name'] = name unless name.nil?
2174
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2175
+ command.query['fields'] = fields unless fields.nil?
2176
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2177
+ execute_or_queue_command(command, &block)
2178
+ end
2179
+
2180
+ # Creates a conversation profile in the specified project. ConversationProfile.
2181
+ # CreateTime and ConversationProfile.UpdateTime aren't populated in the response.
2182
+ # You can retrieve them via GetConversationProfile API.
2183
+ # @param [String] parent
2184
+ # Required. The project to create a conversation profile for. Format: `projects//
2185
+ # locations/`.
2186
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] google_cloud_dialogflow_v2_conversation_profile_object
2187
+ # @param [String] fields
2188
+ # Selector specifying which fields to include in a partial response.
2189
+ # @param [String] quota_user
2190
+ # Available to use for quota purposes for server-side applications. Can be any
2191
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2192
+ # @param [Google::Apis::RequestOptions] options
2193
+ # Request-specific options
2194
+ #
2195
+ # @yield [result, err] Result & error if block supplied
2196
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] parsed result object
2197
+ # @yieldparam err [StandardError] error object if request failed
2198
+ #
2199
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile]
2200
+ #
2201
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2202
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2203
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2204
+ def create_project_conversation_profile(parent, google_cloud_dialogflow_v2_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2205
+ command = make_simple_command(:post, 'v2/{+parent}/conversationProfiles', options)
2206
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
2207
+ command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
2208
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
2209
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
2210
+ command.params['parent'] = parent unless parent.nil?
2211
+ command.query['fields'] = fields unless fields.nil?
2212
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2213
+ execute_or_queue_command(command, &block)
2214
+ end
2215
+
2216
+ # Deletes the specified conversation profile.
2217
+ # @param [String] name
2218
+ # Required. The name of the conversation profile to delete. Format: `projects//
2219
+ # locations//conversationProfiles/`.
2220
+ # @param [String] fields
2221
+ # Selector specifying which fields to include in a partial response.
2222
+ # @param [String] quota_user
2223
+ # Available to use for quota purposes for server-side applications. Can be any
2224
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2225
+ # @param [Google::Apis::RequestOptions] options
2226
+ # Request-specific options
2227
+ #
2228
+ # @yield [result, err] Result & error if block supplied
2229
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
2230
+ # @yieldparam err [StandardError] error object if request failed
2231
+ #
2232
+ # @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
2233
+ #
2234
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2235
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2236
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2237
+ def delete_project_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block)
2238
+ command = make_simple_command(:delete, 'v2/{+name}', options)
2239
+ command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
2240
+ command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
2241
+ command.params['name'] = name unless name.nil?
2242
+ command.query['fields'] = fields unless fields.nil?
2243
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2244
+ execute_or_queue_command(command, &block)
2245
+ end
2246
+
2247
+ # Retrieves the specified conversation profile.
2248
+ # @param [String] name
2249
+ # Required. The resource name of the conversation profile. Format: `projects//
2250
+ # locations//conversationProfiles/`.
2251
+ # @param [String] fields
2252
+ # Selector specifying which fields to include in a partial response.
2253
+ # @param [String] quota_user
2254
+ # Available to use for quota purposes for server-side applications. Can be any
2255
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2256
+ # @param [Google::Apis::RequestOptions] options
2257
+ # Request-specific options
2258
+ #
2259
+ # @yield [result, err] Result & error if block supplied
2260
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] parsed result object
2261
+ # @yieldparam err [StandardError] error object if request failed
2262
+ #
2263
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile]
2264
+ #
2265
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2266
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2267
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2268
+ def get_project_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block)
2269
+ command = make_simple_command(:get, 'v2/{+name}', options)
2270
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
2271
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
2272
+ command.params['name'] = name unless name.nil?
2273
+ command.query['fields'] = fields unless fields.nil?
2274
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2275
+ execute_or_queue_command(command, &block)
2276
+ end
2277
+
2278
+ # Returns the list of all conversation profiles in the specified project.
2279
+ # @param [String] parent
2280
+ # Required. The project to list all conversation profiles from. Format: `
2281
+ # projects//locations/`.
2282
+ # @param [Fixnum] page_size
2283
+ # The maximum number of items to return in a single page. By default 100 and at
2284
+ # most 1000.
2285
+ # @param [String] page_token
2286
+ # The next_page_token value returned from a previous list request.
2287
+ # @param [String] fields
2288
+ # Selector specifying which fields to include in a partial response.
2289
+ # @param [String] quota_user
2290
+ # Available to use for quota purposes for server-side applications. Can be any
2291
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2292
+ # @param [Google::Apis::RequestOptions] options
2293
+ # Request-specific options
2294
+ #
2295
+ # @yield [result, err] Result & error if block supplied
2296
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse] parsed result object
2297
+ # @yieldparam err [StandardError] error object if request failed
2298
+ #
2299
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse]
2300
+ #
2301
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2302
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2303
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2304
+ def list_project_conversation_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2305
+ command = make_simple_command(:get, 'v2/{+parent}/conversationProfiles', options)
2306
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse::Representation
2307
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse
2308
+ command.params['parent'] = parent unless parent.nil?
2309
+ command.query['pageSize'] = page_size unless page_size.nil?
2310
+ command.query['pageToken'] = page_token unless page_token.nil?
2311
+ command.query['fields'] = fields unless fields.nil?
2312
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2313
+ execute_or_queue_command(command, &block)
2314
+ end
2315
+
2316
+ # Updates the specified conversation profile. ConversationProfile.CreateTime and
2317
+ # ConversationProfile.UpdateTime aren't populated in the response. You can
2318
+ # retrieve them via GetConversationProfile API.
2319
+ # @param [String] name
2320
+ # Optional. The unique identifier of this conversation profile. Format: `
2321
+ # projects//locations//conversationProfiles/`.
2322
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] google_cloud_dialogflow_v2_conversation_profile_object
2323
+ # @param [String] update_mask
2324
+ # Required. The mask to control which fields to update.
2325
+ # @param [String] fields
2326
+ # Selector specifying which fields to include in a partial response.
2327
+ # @param [String] quota_user
2328
+ # Available to use for quota purposes for server-side applications. Can be any
2329
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2330
+ # @param [Google::Apis::RequestOptions] options
2331
+ # Request-specific options
2332
+ #
2333
+ # @yield [result, err] Result & error if block supplied
2334
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] parsed result object
2335
+ # @yieldparam err [StandardError] error object if request failed
2336
+ #
2337
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile]
2338
+ #
2339
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2340
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2341
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2342
+ def patch_project_conversation_profile(name, google_cloud_dialogflow_v2_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2343
+ command = make_simple_command(:patch, 'v2/{+name}', options)
2344
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
2345
+ command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
2346
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
2347
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
2348
+ command.params['name'] = name unless name.nil?
2349
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2350
+ command.query['fields'] = fields unless fields.nil?
2351
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2352
+ execute_or_queue_command(command, &block)
2353
+ end
2354
+
2355
+ # Completes the specified conversation. Finished conversations are purged from
2356
+ # the database after 30 days.
2357
+ # @param [String] name
2358
+ # Required. Resource identifier of the conversation to close. Format: `projects//
2359
+ # locations//conversations/`.
2360
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest] google_cloud_dialogflow_v2_complete_conversation_request_object
2361
+ # @param [String] fields
2362
+ # Selector specifying which fields to include in a partial response.
2363
+ # @param [String] quota_user
2364
+ # Available to use for quota purposes for server-side applications. Can be any
2365
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2366
+ # @param [Google::Apis::RequestOptions] options
2367
+ # Request-specific options
2368
+ #
2369
+ # @yield [result, err] Result & error if block supplied
2370
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] parsed result object
2371
+ # @yieldparam err [StandardError] error object if request failed
2372
+ #
2373
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation]
2374
+ #
2375
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2376
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2377
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2378
+ def complete_project_conversation(name, google_cloud_dialogflow_v2_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2379
+ command = make_simple_command(:post, 'v2/{+name}:complete', options)
2380
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest::Representation
2381
+ command.request_object = google_cloud_dialogflow_v2_complete_conversation_request_object
2382
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
2383
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
2384
+ command.params['name'] = name unless name.nil?
2385
+ command.query['fields'] = fields unless fields.nil?
2386
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2387
+ execute_or_queue_command(command, &block)
2388
+ end
2389
+
2390
+ # Creates a new conversation. Conversations are auto-completed after 24 hours.
2391
+ # Conversation Lifecycle: There are two stages during a conversation: Automated
2392
+ # Agent Stage and Assist Stage. For Automated Agent Stage, there will be a
2393
+ # dialogflow agent responding to user queries. For Assist Stage, there's no
2394
+ # dialogflow agent responding to user queries. But we will provide suggestions
2395
+ # which are generated from conversation. If Conversation.conversation_profile is
2396
+ # configured for a dialogflow agent, conversation will start from `Automated
2397
+ # Agent Stage`, otherwise, it will start from `Assist Stage`. And during `
2398
+ # Automated Agent Stage`, once an Intent with Intent.live_agent_handoff is
2399
+ # triggered, conversation will transfer to Assist Stage.
2400
+ # @param [String] parent
2401
+ # Required. Resource identifier of the project creating the conversation. Format:
2402
+ # `projects//locations/`.
2403
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] google_cloud_dialogflow_v2_conversation_object
2404
+ # @param [String] conversation_id
2405
+ # Optional. Identifier of the conversation. Generally it's auto generated by
2406
+ # Google. Only set it if you cannot wait for the response to return a auto-
2407
+ # generated one to you. The conversation ID must be compliant with the
2408
+ # regression fomula "a-zA-Z*" with the characters length in range of [3,64]. If
2409
+ # the field is provided, the caller is resposible for 1. the uniqueness of the
2410
+ # ID, otherwise the request will be rejected. 2. the consistency for whether to
2411
+ # use custom ID or not under a project to better ensure uniqueness.
2412
+ # @param [String] fields
2413
+ # Selector specifying which fields to include in a partial response.
2414
+ # @param [String] quota_user
2415
+ # Available to use for quota purposes for server-side applications. Can be any
2416
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2417
+ # @param [Google::Apis::RequestOptions] options
2418
+ # Request-specific options
2419
+ #
2420
+ # @yield [result, err] Result & error if block supplied
2421
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] parsed result object
2422
+ # @yieldparam err [StandardError] error object if request failed
2423
+ #
2424
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation]
2425
+ #
2426
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2427
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2428
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2429
+ def create_project_conversation(parent, google_cloud_dialogflow_v2_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2430
+ command = make_simple_command(:post, 'v2/{+parent}/conversations', options)
2431
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
2432
+ command.request_object = google_cloud_dialogflow_v2_conversation_object
2433
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
2434
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
2435
+ command.params['parent'] = parent unless parent.nil?
2436
+ command.query['conversationId'] = conversation_id unless conversation_id.nil?
2437
+ command.query['fields'] = fields unless fields.nil?
2438
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2439
+ execute_or_queue_command(command, &block)
2440
+ end
2441
+
2442
+ # Retrieves the specific conversation.
2443
+ # @param [String] name
2444
+ # Required. The name of the conversation. Format: `projects//locations//
2445
+ # conversations/`.
2446
+ # @param [String] fields
2447
+ # Selector specifying which fields to include in a partial response.
2448
+ # @param [String] quota_user
2449
+ # Available to use for quota purposes for server-side applications. Can be any
2450
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2451
+ # @param [Google::Apis::RequestOptions] options
2452
+ # Request-specific options
2453
+ #
2454
+ # @yield [result, err] Result & error if block supplied
2455
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] parsed result object
2456
+ # @yieldparam err [StandardError] error object if request failed
2457
+ #
2458
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation]
2459
+ #
2460
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2461
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2462
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2463
+ def get_project_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
2464
+ command = make_simple_command(:get, 'v2/{+name}', options)
2465
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
2466
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
2467
+ command.params['name'] = name unless name.nil?
2468
+ command.query['fields'] = fields unless fields.nil?
2469
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2470
+ execute_or_queue_command(command, &block)
2471
+ end
2472
+
2473
+ # Returns the list of all conversations in the specified project.
2474
+ # @param [String] parent
2475
+ # Required. The project from which to list all conversation. Format: `projects//
2476
+ # locations/`.
2477
+ # @param [String] filter
2478
+ # A filter expression that filters conversations listed in the response. In
2479
+ # general, the expression must specify the field name, a comparison operator,
2480
+ # and the value to use for filtering: - The value must be a string, a number, or
2481
+ # a boolean. - The comparison operator must be either `=`,`!=`, `>`, or `<`. -
2482
+ # To filter on multiple expressions, separate the expressions with `AND` or `OR`
2483
+ # (omitting both implies `AND`). - For clarity, expressions can be enclosed in
2484
+ # parentheses. Only `lifecycle_state` can be filtered on in this way. For
2485
+ # example, the following expression only returns `COMPLETED` conversations: `
2486
+ # lifecycle_state = "COMPLETED"` For more information about filtering, see [API
2487
+ # Filtering](https://aip.dev/160).
2488
+ # @param [Fixnum] page_size
2489
+ # Optional. The maximum number of items to return in a single page. By default
2490
+ # 100 and at most 1000.
2491
+ # @param [String] page_token
2492
+ # Optional. The next_page_token value returned from a previous list request.
2493
+ # @param [String] fields
2494
+ # Selector specifying which fields to include in a partial response.
2495
+ # @param [String] quota_user
2496
+ # Available to use for quota purposes for server-side applications. Can be any
2497
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2498
+ # @param [Google::Apis::RequestOptions] options
2499
+ # Request-specific options
2500
+ #
2501
+ # @yield [result, err] Result & error if block supplied
2502
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse] parsed result object
2503
+ # @yieldparam err [StandardError] error object if request failed
2504
+ #
2505
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse]
2506
+ #
2507
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2508
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2509
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2510
+ def list_project_conversations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2511
+ command = make_simple_command(:get, 'v2/{+parent}/conversations', options)
2512
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse::Representation
2513
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse
2514
+ command.params['parent'] = parent unless parent.nil?
2515
+ command.query['filter'] = filter unless filter.nil?
2516
+ command.query['pageSize'] = page_size unless page_size.nil?
2517
+ command.query['pageToken'] = page_token unless page_token.nil?
2518
+ command.query['fields'] = fields unless fields.nil?
2519
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2520
+ execute_or_queue_command(command, &block)
2521
+ end
2522
+
2523
+ # Creates a call matcher that links incoming SIP calls to the specified
2524
+ # conversation if they fulfill specified criteria.
2525
+ # @param [String] parent
2526
+ # Required. Resource identifier of the conversation adding the call matcher.
2527
+ # Format: `projects//locations//conversations/`.
2528
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher] google_cloud_dialogflow_v2_call_matcher_object
2529
+ # @param [String] fields
2530
+ # Selector specifying which fields to include in a partial response.
2531
+ # @param [String] quota_user
2532
+ # Available to use for quota purposes for server-side applications. Can be any
2533
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2534
+ # @param [Google::Apis::RequestOptions] options
2535
+ # Request-specific options
2536
+ #
2537
+ # @yield [result, err] Result & error if block supplied
2538
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher] parsed result object
2539
+ # @yieldparam err [StandardError] error object if request failed
2540
+ #
2541
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher]
2542
+ #
2543
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2544
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2545
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2546
+ def create_project_conversation_call_matcher(parent, google_cloud_dialogflow_v2_call_matcher_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2547
+ command = make_simple_command(:post, 'v2/{+parent}/callMatchers', options)
2548
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher::Representation
2549
+ command.request_object = google_cloud_dialogflow_v2_call_matcher_object
2550
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher::Representation
2551
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher
2552
+ command.params['parent'] = parent unless parent.nil?
2553
+ command.query['fields'] = fields unless fields.nil?
2554
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2555
+ execute_or_queue_command(command, &block)
2556
+ end
2557
+
2558
+ # Requests deletion of a call matcher.
2559
+ # @param [String] name
2560
+ # Required. The unique identifier of the CallMatcher to delete. Format: `
2561
+ # projects//locations//conversations//callMatchers/`.
2562
+ # @param [String] fields
2563
+ # Selector specifying which fields to include in a partial response.
2564
+ # @param [String] quota_user
2565
+ # Available to use for quota purposes for server-side applications. Can be any
2566
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2567
+ # @param [Google::Apis::RequestOptions] options
2568
+ # Request-specific options
2569
+ #
2570
+ # @yield [result, err] Result & error if block supplied
2571
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
2572
+ # @yieldparam err [StandardError] error object if request failed
2573
+ #
2574
+ # @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
2575
+ #
2576
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2577
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2578
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2579
+ def delete_project_conversation_call_matcher(name, fields: nil, quota_user: nil, options: nil, &block)
2580
+ command = make_simple_command(:delete, 'v2/{+name}', options)
2581
+ command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
2582
+ command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
2583
+ command.params['name'] = name unless name.nil?
2584
+ command.query['fields'] = fields unless fields.nil?
2585
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2586
+ execute_or_queue_command(command, &block)
2587
+ end
2588
+
2589
+ # Returns the list of all call matchers in the specified conversation.
2590
+ # @param [String] parent
2591
+ # Required. The conversation to list all call matchers from. Format: `projects//
2592
+ # locations//conversations/`.
2593
+ # @param [Fixnum] page_size
2594
+ # Optional. The maximum number of items to return in a single page. By default
2595
+ # 100 and at most 1000.
2596
+ # @param [String] page_token
2597
+ # Optional. The next_page_token value returned from a previous list request.
2598
+ # @param [String] fields
2599
+ # Selector specifying which fields to include in a partial response.
2600
+ # @param [String] quota_user
2601
+ # Available to use for quota purposes for server-side applications. Can be any
2602
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2603
+ # @param [Google::Apis::RequestOptions] options
2604
+ # Request-specific options
2605
+ #
2606
+ # @yield [result, err] Result & error if block supplied
2607
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse] parsed result object
2608
+ # @yieldparam err [StandardError] error object if request failed
2609
+ #
2610
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse]
2611
+ #
2612
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2613
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2614
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2615
+ def list_project_conversation_call_matchers(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2616
+ command = make_simple_command(:get, 'v2/{+parent}/callMatchers', options)
2617
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse::Representation
2618
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse
2619
+ command.params['parent'] = parent unless parent.nil?
2620
+ command.query['pageSize'] = page_size unless page_size.nil?
2621
+ command.query['pageToken'] = page_token unless page_token.nil?
2622
+ command.query['fields'] = fields unless fields.nil?
2623
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2624
+ execute_or_queue_command(command, &block)
2625
+ end
2626
+
2627
+ # Lists messages that belong to a given conversation. `messages` are ordered by `
2628
+ # create_time` in descending order. To fetch updates without duplication, send
2629
+ # request with filter `create_time_epoch_microseconds > [first item's
2630
+ # create_time of previous request]` and empty page_token.
2631
+ # @param [String] parent
2632
+ # Required. The name of the conversation to list messages for. Format: `projects/
2633
+ # /locations//conversations/`
2634
+ # @param [String] filter
2635
+ # Optional. Filter on message fields. Currently predicates on `create_time` and `
2636
+ # create_time_epoch_microseconds` are supported. `create_time` only support
2637
+ # milliseconds accuracy. E.g., `create_time_epoch_microseconds >
2638
+ # 1551790877964485` or `create_time > 2017-01-15T01:30:15.01Z`. For more
2639
+ # information about filtering, see [API Filtering](https://aip.dev/160).
2640
+ # @param [Fixnum] page_size
2641
+ # Optional. The maximum number of items to return in a single page. By default
2642
+ # 100 and at most 1000.
2643
+ # @param [String] page_token
2644
+ # Optional. The next_page_token value returned from a previous list request.
2645
+ # @param [String] fields
2646
+ # Selector specifying which fields to include in a partial response.
2647
+ # @param [String] quota_user
2648
+ # Available to use for quota purposes for server-side applications. Can be any
2649
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2650
+ # @param [Google::Apis::RequestOptions] options
2651
+ # Request-specific options
2652
+ #
2653
+ # @yield [result, err] Result & error if block supplied
2654
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse] parsed result object
2655
+ # @yieldparam err [StandardError] error object if request failed
2656
+ #
2657
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse]
2658
+ #
2659
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2660
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2661
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2662
+ def list_project_conversation_messages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2663
+ command = make_simple_command(:get, 'v2/{+parent}/messages', options)
2664
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse::Representation
2665
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse
2666
+ command.params['parent'] = parent unless parent.nil?
2667
+ command.query['filter'] = filter unless filter.nil?
2668
+ command.query['pageSize'] = page_size unless page_size.nil?
2669
+ command.query['pageToken'] = page_token unless page_token.nil?
2670
+ command.query['fields'] = fields unless fields.nil?
2671
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2672
+ execute_or_queue_command(command, &block)
2673
+ end
2674
+
2675
+ # Adds a text (chat, for example), or audio (phone recording, for example)
2676
+ # message from a participant into the conversation. Note: Always use agent
2677
+ # versions for production traffic sent to virtual agents. See [Versions and
2678
+ # environments(https://cloud.google.com/dialogflow/es/docs/agents-versions).
2679
+ # @param [String] participant
2680
+ # Required. The name of the participant this text comes from. Format: `projects//
2681
+ # locations//conversations//participants/`.
2682
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest] google_cloud_dialogflow_v2_analyze_content_request_object
2683
+ # @param [String] fields
2684
+ # Selector specifying which fields to include in a partial response.
2685
+ # @param [String] quota_user
2686
+ # Available to use for quota purposes for server-side applications. Can be any
2687
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2688
+ # @param [Google::Apis::RequestOptions] options
2689
+ # Request-specific options
2690
+ #
2691
+ # @yield [result, err] Result & error if block supplied
2692
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse] parsed result object
2693
+ # @yieldparam err [StandardError] error object if request failed
2694
+ #
2695
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse]
2696
+ #
2697
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2698
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2699
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2700
+ def analyze_project_conversation_participant_content(participant, google_cloud_dialogflow_v2_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2701
+ command = make_simple_command(:post, 'v2/{+participant}:analyzeContent', options)
2702
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest::Representation
2703
+ command.request_object = google_cloud_dialogflow_v2_analyze_content_request_object
2704
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse::Representation
2705
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse
2706
+ command.params['participant'] = participant unless participant.nil?
2707
+ command.query['fields'] = fields unless fields.nil?
2708
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2709
+ execute_or_queue_command(command, &block)
2710
+ end
2711
+
2712
+ # Creates a new participant in a conversation.
2713
+ # @param [String] parent
2714
+ # Required. Resource identifier of the conversation adding the participant.
2715
+ # Format: `projects//locations//conversations/`.
2716
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] google_cloud_dialogflow_v2_participant_object
2717
+ # @param [String] fields
2718
+ # Selector specifying which fields to include in a partial response.
2719
+ # @param [String] quota_user
2720
+ # Available to use for quota purposes for server-side applications. Can be any
2721
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2722
+ # @param [Google::Apis::RequestOptions] options
2723
+ # Request-specific options
2724
+ #
2725
+ # @yield [result, err] Result & error if block supplied
2726
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] parsed result object
2727
+ # @yieldparam err [StandardError] error object if request failed
2728
+ #
2729
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant]
2730
+ #
2731
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2732
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2733
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2734
+ def create_project_conversation_participant(parent, google_cloud_dialogflow_v2_participant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2735
+ command = make_simple_command(:post, 'v2/{+parent}/participants', options)
2736
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
2737
+ command.request_object = google_cloud_dialogflow_v2_participant_object
2738
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
2739
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
2740
+ command.params['parent'] = parent unless parent.nil?
2741
+ command.query['fields'] = fields unless fields.nil?
2742
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2743
+ execute_or_queue_command(command, &block)
2744
+ end
2745
+
2746
+ # Retrieves a conversation participant.
2747
+ # @param [String] name
2748
+ # Required. The name of the participant. Format: `projects//locations//
2749
+ # conversations//participants/`.
2750
+ # @param [String] fields
2751
+ # Selector specifying which fields to include in a partial response.
2752
+ # @param [String] quota_user
2753
+ # Available to use for quota purposes for server-side applications. Can be any
2754
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2755
+ # @param [Google::Apis::RequestOptions] options
2756
+ # Request-specific options
2757
+ #
2758
+ # @yield [result, err] Result & error if block supplied
2759
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] parsed result object
2760
+ # @yieldparam err [StandardError] error object if request failed
2761
+ #
2762
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant]
2763
+ #
2764
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2765
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2766
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2767
+ def get_project_conversation_participant(name, fields: nil, quota_user: nil, options: nil, &block)
2768
+ command = make_simple_command(:get, 'v2/{+name}', options)
2769
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
2770
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
2771
+ command.params['name'] = name unless name.nil?
2772
+ command.query['fields'] = fields unless fields.nil?
2773
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2774
+ execute_or_queue_command(command, &block)
2775
+ end
2776
+
2777
+ # Returns the list of all participants in the specified conversation.
2778
+ # @param [String] parent
2779
+ # Required. The conversation to list all participants from. Format: `projects//
2780
+ # locations//conversations/`.
2781
+ # @param [Fixnum] page_size
2782
+ # Optional. The maximum number of items to return in a single page. By default
2783
+ # 100 and at most 1000.
2784
+ # @param [String] page_token
2785
+ # Optional. The next_page_token value returned from a previous list request.
2786
+ # @param [String] fields
2787
+ # Selector specifying which fields to include in a partial response.
2788
+ # @param [String] quota_user
2789
+ # Available to use for quota purposes for server-side applications. Can be any
2790
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2791
+ # @param [Google::Apis::RequestOptions] options
2792
+ # Request-specific options
2793
+ #
2794
+ # @yield [result, err] Result & error if block supplied
2795
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse] parsed result object
2796
+ # @yieldparam err [StandardError] error object if request failed
2797
+ #
2798
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse]
2799
+ #
2800
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2801
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2802
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2803
+ def list_project_conversation_participants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2804
+ command = make_simple_command(:get, 'v2/{+parent}/participants', options)
2805
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse::Representation
2806
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse
2807
+ command.params['parent'] = parent unless parent.nil?
2808
+ command.query['pageSize'] = page_size unless page_size.nil?
2809
+ command.query['pageToken'] = page_token unless page_token.nil?
2810
+ command.query['fields'] = fields unless fields.nil?
2811
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2812
+ execute_or_queue_command(command, &block)
2813
+ end
2814
+
2815
+ # Updates the specified participant.
2816
+ # @param [String] name
2817
+ # Optional. The unique identifier of this participant. Format: `projects//
2818
+ # locations//conversations//participants/`.
2819
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] google_cloud_dialogflow_v2_participant_object
2820
+ # @param [String] update_mask
2821
+ # Required. The mask to specify which fields to update.
2822
+ # @param [String] fields
2823
+ # Selector specifying which fields to include in a partial response.
2824
+ # @param [String] quota_user
2825
+ # Available to use for quota purposes for server-side applications. Can be any
2826
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2827
+ # @param [Google::Apis::RequestOptions] options
2828
+ # Request-specific options
2829
+ #
2830
+ # @yield [result, err] Result & error if block supplied
2831
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] parsed result object
2832
+ # @yieldparam err [StandardError] error object if request failed
2833
+ #
2834
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant]
2835
+ #
2836
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2837
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2838
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2839
+ def patch_project_conversation_participant(name, google_cloud_dialogflow_v2_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2840
+ command = make_simple_command(:patch, 'v2/{+name}', options)
2841
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
2842
+ command.request_object = google_cloud_dialogflow_v2_participant_object
2843
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
2844
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
2845
+ command.params['name'] = name unless name.nil?
2846
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2847
+ command.query['fields'] = fields unless fields.nil?
2848
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2849
+ execute_or_queue_command(command, &block)
2850
+ end
2851
+
2852
+ # Gets suggested articles for a participant based on specific historical
2853
+ # messages.
2854
+ # @param [String] parent
2855
+ # Required. The name of the participant to fetch suggestion for. Format: `
2856
+ # projects//locations//conversations//participants/`.
2857
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest] google_cloud_dialogflow_v2_suggest_articles_request_object
2858
+ # @param [String] fields
2859
+ # Selector specifying which fields to include in a partial response.
2860
+ # @param [String] quota_user
2861
+ # Available to use for quota purposes for server-side applications. Can be any
2862
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2863
+ # @param [Google::Apis::RequestOptions] options
2864
+ # Request-specific options
2865
+ #
2866
+ # @yield [result, err] Result & error if block supplied
2867
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse] parsed result object
2868
+ # @yieldparam err [StandardError] error object if request failed
2869
+ #
2870
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse]
2871
+ #
2872
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2873
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2874
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2875
+ def suggest_project_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2876
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestArticles', options)
2877
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest::Representation
2878
+ command.request_object = google_cloud_dialogflow_v2_suggest_articles_request_object
2879
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse::Representation
2880
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse
2881
+ command.params['parent'] = parent unless parent.nil?
2882
+ command.query['fields'] = fields unless fields.nil?
2883
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2884
+ execute_or_queue_command(command, &block)
2885
+ end
2886
+
2887
+ # Gets suggested faq answers for a participant based on specific historical
2888
+ # messages.
2889
+ # @param [String] parent
2890
+ # Required. The name of the participant to fetch suggestion for. Format: `
2891
+ # projects//locations//conversations//participants/`.
2892
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest] google_cloud_dialogflow_v2_suggest_faq_answers_request_object
2893
+ # @param [String] fields
2894
+ # Selector specifying which fields to include in a partial response.
2895
+ # @param [String] quota_user
2896
+ # Available to use for quota purposes for server-side applications. Can be any
2897
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2898
+ # @param [Google::Apis::RequestOptions] options
2899
+ # Request-specific options
2900
+ #
2901
+ # @yield [result, err] Result & error if block supplied
2902
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse] parsed result object
2903
+ # @yieldparam err [StandardError] error object if request failed
2904
+ #
2905
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
2906
+ #
2907
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2908
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2909
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2910
+ def suggest_project_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2911
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestFaqAnswers', options)
2912
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest::Representation
2913
+ command.request_object = google_cloud_dialogflow_v2_suggest_faq_answers_request_object
2914
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse::Representation
2915
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse
2916
+ command.params['parent'] = parent unless parent.nil?
2917
+ command.query['fields'] = fields unless fields.nil?
2918
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2919
+ execute_or_queue_command(command, &block)
2920
+ end
2921
+
2922
+ # Creates a knowledge base.
2923
+ # @param [String] parent
2924
+ # Required. The project to create a knowledge base for. Format: `projects//
2925
+ # locations/`.
2926
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] google_cloud_dialogflow_v2_knowledge_base_object
2927
+ # @param [String] fields
2928
+ # Selector specifying which fields to include in a partial response.
2929
+ # @param [String] quota_user
2930
+ # Available to use for quota purposes for server-side applications. Can be any
2931
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2932
+ # @param [Google::Apis::RequestOptions] options
2933
+ # Request-specific options
2934
+ #
2935
+ # @yield [result, err] Result & error if block supplied
2936
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] parsed result object
2937
+ # @yieldparam err [StandardError] error object if request failed
2938
+ #
2939
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase]
2940
+ #
2941
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2942
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2943
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2944
+ def create_project_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2945
+ command = make_simple_command(:post, 'v2/{+parent}/knowledgeBases', options)
2946
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
2947
+ command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
2948
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
2949
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
2950
+ command.params['parent'] = parent unless parent.nil?
2951
+ command.query['fields'] = fields unless fields.nil?
2952
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2953
+ execute_or_queue_command(command, &block)
2954
+ end
2955
+
2956
+ # Deletes the specified knowledge base.
2957
+ # @param [String] name
2958
+ # Required. The name of the knowledge base to delete. Format: `projects//
2959
+ # locations//knowledgeBases/`.
2960
+ # @param [Boolean] force
2961
+ # Optional. Force deletes the knowledge base. When set to true, any documents in
2962
+ # the knowledge base are also deleted.
2963
+ # @param [String] fields
2964
+ # Selector specifying which fields to include in a partial response.
2965
+ # @param [String] quota_user
2966
+ # Available to use for quota purposes for server-side applications. Can be any
2967
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2968
+ # @param [Google::Apis::RequestOptions] options
2969
+ # Request-specific options
2970
+ #
2971
+ # @yield [result, err] Result & error if block supplied
2972
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
2973
+ # @yieldparam err [StandardError] error object if request failed
2974
+ #
2975
+ # @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
2976
+ #
2977
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2978
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2979
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2980
+ def delete_project_knowledge_basis(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
2981
+ command = make_simple_command(:delete, 'v2/{+name}', options)
2982
+ command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
2983
+ command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
2984
+ command.params['name'] = name unless name.nil?
2985
+ command.query['force'] = force unless force.nil?
2986
+ command.query['fields'] = fields unless fields.nil?
2987
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2988
+ execute_or_queue_command(command, &block)
2989
+ end
2990
+
2991
+ # Retrieves the specified knowledge base.
2992
+ # @param [String] name
2993
+ # Required. The name of the knowledge base to retrieve. Format `projects//
2994
+ # locations//knowledgeBases/`.
2995
+ # @param [String] fields
2996
+ # Selector specifying which fields to include in a partial response.
2997
+ # @param [String] quota_user
2998
+ # Available to use for quota purposes for server-side applications. Can be any
2999
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3000
+ # @param [Google::Apis::RequestOptions] options
3001
+ # Request-specific options
3002
+ #
3003
+ # @yield [result, err] Result & error if block supplied
3004
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] parsed result object
3005
+ # @yieldparam err [StandardError] error object if request failed
3006
+ #
3007
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase]
3008
+ #
3009
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3010
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3011
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3012
+ def get_project_knowledge_basis(name, fields: nil, quota_user: nil, options: nil, &block)
3013
+ command = make_simple_command(:get, 'v2/{+name}', options)
3014
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
3015
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
3016
+ command.params['name'] = name unless name.nil?
3017
+ command.query['fields'] = fields unless fields.nil?
3018
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3019
+ execute_or_queue_command(command, &block)
3020
+ end
3021
+
3022
+ # Returns the list of all knowledge bases of the specified agent.
3023
+ # @param [String] parent
3024
+ # Required. The project to list of knowledge bases for. Format: `projects//
3025
+ # locations/`.
3026
+ # @param [Fixnum] page_size
3027
+ # The maximum number of items to return in a single page. By default 10 and at
3028
+ # most 100.
3029
+ # @param [String] page_token
3030
+ # The next_page_token value returned from a previous list request.
3031
+ # @param [String] fields
3032
+ # Selector specifying which fields to include in a partial response.
3033
+ # @param [String] quota_user
3034
+ # Available to use for quota purposes for server-side applications. Can be any
3035
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3036
+ # @param [Google::Apis::RequestOptions] options
3037
+ # Request-specific options
3038
+ #
3039
+ # @yield [result, err] Result & error if block supplied
3040
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse] parsed result object
3041
+ # @yieldparam err [StandardError] error object if request failed
3042
+ #
3043
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse]
3044
+ #
3045
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3046
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3047
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3048
+ def list_project_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3049
+ command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
3050
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
3051
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
3052
+ command.params['parent'] = parent unless parent.nil?
3053
+ command.query['pageSize'] = page_size unless page_size.nil?
3054
+ command.query['pageToken'] = page_token unless page_token.nil?
3055
+ command.query['fields'] = fields unless fields.nil?
3056
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3057
+ execute_or_queue_command(command, &block)
3058
+ end
3059
+
3060
+ # Updates the specified knowledge base.
3061
+ # @param [String] name
3062
+ # The knowledge base resource name. The name must be empty when creating a
3063
+ # knowledge base. Format: `projects//locations//knowledgeBases/`.
3064
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] google_cloud_dialogflow_v2_knowledge_base_object
3065
+ # @param [String] update_mask
3066
+ # Optional. Not specified means `update all`. Currently, only `display_name` can
3067
+ # be updated, an InvalidArgument will be returned for attempting to update other
3068
+ # fields.
3069
+ # @param [String] fields
3070
+ # Selector specifying which fields to include in a partial response.
3071
+ # @param [String] quota_user
3072
+ # Available to use for quota purposes for server-side applications. Can be any
3073
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3074
+ # @param [Google::Apis::RequestOptions] options
3075
+ # Request-specific options
3076
+ #
3077
+ # @yield [result, err] Result & error if block supplied
3078
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] parsed result object
3079
+ # @yieldparam err [StandardError] error object if request failed
3080
+ #
3081
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase]
3082
+ #
3083
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3084
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3085
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3086
+ def patch_project_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3087
+ command = make_simple_command(:patch, 'v2/{+name}', options)
3088
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
3089
+ command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
3090
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
3091
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
3092
+ command.params['name'] = name unless name.nil?
3093
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3094
+ command.query['fields'] = fields unless fields.nil?
3095
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3096
+ execute_or_queue_command(command, &block)
3097
+ end
3098
+
3099
+ # Creates a new document. Operation
3100
+ # @param [String] parent
3101
+ # Required. The knowledge base to create a document for. Format: `projects//
3102
+ # locations//knowledgeBases/`.
3103
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document] google_cloud_dialogflow_v2_document_object
3104
+ # @param [String] fields
3105
+ # Selector specifying which fields to include in a partial response.
3106
+ # @param [String] quota_user
3107
+ # Available to use for quota purposes for server-side applications. Can be any
3108
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3109
+ # @param [Google::Apis::RequestOptions] options
3110
+ # Request-specific options
3111
+ #
3112
+ # @yield [result, err] Result & error if block supplied
3113
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
3114
+ # @yieldparam err [StandardError] error object if request failed
3115
+ #
3116
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
3117
+ #
3118
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3119
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3120
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3121
+ def create_project_knowledge_basis_document(parent, google_cloud_dialogflow_v2_document_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3122
+ command = make_simple_command(:post, 'v2/{+parent}/documents', options)
3123
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
3124
+ command.request_object = google_cloud_dialogflow_v2_document_object
3125
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
3126
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
3127
+ command.params['parent'] = parent unless parent.nil?
3128
+ command.query['fields'] = fields unless fields.nil?
3129
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3130
+ execute_or_queue_command(command, &block)
3131
+ end
3132
+
3133
+ # Deletes the specified document. Operation
3134
+ # @param [String] name
3135
+ # Required. The name of the document to delete. Format: `projects//locations//
3136
+ # knowledgeBases//documents/`.
3137
+ # @param [String] fields
3138
+ # Selector specifying which fields to include in a partial response.
3139
+ # @param [String] quota_user
3140
+ # Available to use for quota purposes for server-side applications. Can be any
3141
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3142
+ # @param [Google::Apis::RequestOptions] options
3143
+ # Request-specific options
3144
+ #
3145
+ # @yield [result, err] Result & error if block supplied
3146
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
3147
+ # @yieldparam err [StandardError] error object if request failed
3148
+ #
3149
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
3150
+ #
3151
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3152
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3153
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3154
+ def delete_project_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
3155
+ command = make_simple_command(:delete, 'v2/{+name}', options)
3156
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
3157
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
3158
+ command.params['name'] = name unless name.nil?
3159
+ command.query['fields'] = fields unless fields.nil?
3160
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3161
+ execute_or_queue_command(command, &block)
3162
+ end
3163
+
3164
+ # Retrieves the specified document.
3165
+ # @param [String] name
3166
+ # Required. The name of the document to retrieve. Format `projects//locations//
3167
+ # knowledgeBases//documents/`.
3168
+ # @param [String] fields
3169
+ # Selector specifying which fields to include in a partial response.
3170
+ # @param [String] quota_user
3171
+ # Available to use for quota purposes for server-side applications. Can be any
3172
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3173
+ # @param [Google::Apis::RequestOptions] options
3174
+ # Request-specific options
3175
+ #
3176
+ # @yield [result, err] Result & error if block supplied
3177
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document] parsed result object
3178
+ # @yieldparam err [StandardError] error object if request failed
3179
+ #
3180
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document]
3181
+ #
3182
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3183
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3184
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3185
+ def get_project_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
3186
+ command = make_simple_command(:get, 'v2/{+name}', options)
3187
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
3188
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document
3189
+ command.params['name'] = name unless name.nil?
3190
+ command.query['fields'] = fields unless fields.nil?
3191
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3192
+ execute_or_queue_command(command, &block)
3193
+ end
3194
+
3195
+ # Returns the list of all documents of the knowledge base.
3196
+ # @param [String] parent
3197
+ # Required. The knowledge base to list all documents for. Format: `projects//
3198
+ # locations//knowledgeBases/`.
3199
+ # @param [Fixnum] page_size
3200
+ # The maximum number of items to return in a single page. By default 10 and at
3201
+ # most 100.
3202
+ # @param [String] page_token
3203
+ # The next_page_token value returned from a previous list request.
3204
+ # @param [String] fields
3205
+ # Selector specifying which fields to include in a partial response.
3206
+ # @param [String] quota_user
3207
+ # Available to use for quota purposes for server-side applications. Can be any
3208
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3209
+ # @param [Google::Apis::RequestOptions] options
3210
+ # Request-specific options
3211
+ #
3212
+ # @yield [result, err] Result & error if block supplied
3213
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse] parsed result object
3214
+ # @yieldparam err [StandardError] error object if request failed
3215
+ #
3216
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse]
3217
+ #
3218
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3219
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3220
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3221
+ def list_project_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3222
+ command = make_simple_command(:get, 'v2/{+parent}/documents', options)
3223
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
3224
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
3225
+ command.params['parent'] = parent unless parent.nil?
3226
+ command.query['pageSize'] = page_size unless page_size.nil?
3227
+ command.query['pageToken'] = page_token unless page_token.nil?
3228
+ command.query['fields'] = fields unless fields.nil?
3229
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3230
+ execute_or_queue_command(command, &block)
3231
+ end
3232
+
3233
+ # Updates the specified document. Operation
3234
+ # @param [String] name
3235
+ # Optional. The document resource name. The name must be empty when creating a
3236
+ # document. Format: `projects//locations//knowledgeBases//documents/`.
3237
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document] google_cloud_dialogflow_v2_document_object
3238
+ # @param [String] update_mask
3239
+ # Optional. Not specified means `update all`. Currently, only `display_name` can
3240
+ # be updated, an InvalidArgument will be returned for attempting to update other
3241
+ # fields.
3242
+ # @param [String] fields
3243
+ # Selector specifying which fields to include in a partial response.
3244
+ # @param [String] quota_user
3245
+ # Available to use for quota purposes for server-side applications. Can be any
3246
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3247
+ # @param [Google::Apis::RequestOptions] options
3248
+ # Request-specific options
3249
+ #
3250
+ # @yield [result, err] Result & error if block supplied
3251
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
3252
+ # @yieldparam err [StandardError] error object if request failed
3253
+ #
3254
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
3255
+ #
3256
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3257
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3258
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3259
+ def patch_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3260
+ command = make_simple_command(:patch, 'v2/{+name}', options)
3261
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
3262
+ command.request_object = google_cloud_dialogflow_v2_document_object
3263
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
3264
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
3265
+ command.params['name'] = name unless name.nil?
3266
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3267
+ command.query['fields'] = fields unless fields.nil?
3268
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3269
+ execute_or_queue_command(command, &block)
3270
+ end
3271
+
3272
+ # Reloads the specified document from its specified source, content_uri or
3273
+ # content. The previously loaded content of the document will be deleted. Note:
3274
+ # Even when the content of the document has not changed, there still may be side
3275
+ # effects because of internal implementation changes. Note: The `projects.agent.
3276
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
3277
+ # knowledgeBases.documents`. Operation
3278
+ # @param [String] name
3279
+ # Required. The name of the document to reload. Format: `projects//locations//
3280
+ # knowledgeBases//documents/`
3281
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest] google_cloud_dialogflow_v2_reload_document_request_object
3282
+ # @param [String] fields
3283
+ # Selector specifying which fields to include in a partial response.
3284
+ # @param [String] quota_user
3285
+ # Available to use for quota purposes for server-side applications. Can be any
3286
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3287
+ # @param [Google::Apis::RequestOptions] options
3288
+ # Request-specific options
3289
+ #
3290
+ # @yield [result, err] Result & error if block supplied
3291
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
3292
+ # @yieldparam err [StandardError] error object if request failed
3293
+ #
3294
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
3295
+ #
3296
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3297
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3298
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3299
+ def reload_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3300
+ command = make_simple_command(:post, 'v2/{+name}:reload', options)
3301
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest::Representation
3302
+ command.request_object = google_cloud_dialogflow_v2_reload_document_request_object
3303
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
3304
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
3305
+ command.params['name'] = name unless name.nil?
3306
+ command.query['fields'] = fields unless fields.nil?
3307
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3308
+ execute_or_queue_command(command, &block)
3309
+ end
3310
+
3311
+ # Returns the list of all answer records in the specified project in reverse
3312
+ # chronological order.
3313
+ # @param [String] parent
3314
+ # Required. The project to list all answer records for in reverse chronological
3315
+ # order. Format: `projects//locations/`.
3316
+ # @param [String] filter
3317
+ # Required. Filters to restrict results to specific answer records. Filter on
3318
+ # answer record type. Currently predicates on `type` is supported, valid values
3319
+ # are `ARTICLE_ANSWER`, `FAQ_ANSWER`. For more information about filtering, see [
3320
+ # API Filtering](https://aip.dev/160).
3321
+ # @param [Fixnum] page_size
3322
+ # Optional. The maximum number of records to return in a single page. The server
3323
+ # may return fewer records than this. If unspecified, we use 10. The maximum is
3324
+ # 100.
3325
+ # @param [String] page_token
3326
+ # Optional. The ListAnswerRecordsResponse.next_page_token value returned from a
3327
+ # previous list request used to continue listing on the next page.
3328
+ # @param [String] fields
3329
+ # Selector specifying which fields to include in a partial response.
3330
+ # @param [String] quota_user
3331
+ # Available to use for quota purposes for server-side applications. Can be any
3332
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3333
+ # @param [Google::Apis::RequestOptions] options
3334
+ # Request-specific options
3335
+ #
3336
+ # @yield [result, err] Result & error if block supplied
3337
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse] parsed result object
3338
+ # @yieldparam err [StandardError] error object if request failed
3339
+ #
3340
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse]
3341
+ #
3342
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3343
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3344
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3345
+ def list_project_location_answer_records(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3346
+ command = make_simple_command(:get, 'v2/{+parent}/answerRecords', options)
3347
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse::Representation
3348
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse
3349
+ command.params['parent'] = parent unless parent.nil?
3350
+ command.query['filter'] = filter unless filter.nil?
3351
+ command.query['pageSize'] = page_size unless page_size.nil?
3352
+ command.query['pageToken'] = page_token unless page_token.nil?
3353
+ command.query['fields'] = fields unless fields.nil?
3354
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3355
+ execute_or_queue_command(command, &block)
3356
+ end
3357
+
3358
+ # Updates the specified answer record.
3359
+ # @param [String] name
3360
+ # The unique identifier of this answer record. Format: `projects//locations//
3361
+ # answerRecords/`.
3362
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord] google_cloud_dialogflow_v2_answer_record_object
3363
+ # @param [String] update_mask
3364
+ # Required. The mask to control which fields get updated.
3365
+ # @param [String] fields
3366
+ # Selector specifying which fields to include in a partial response.
3367
+ # @param [String] quota_user
3368
+ # Available to use for quota purposes for server-side applications. Can be any
3369
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3370
+ # @param [Google::Apis::RequestOptions] options
3371
+ # Request-specific options
3372
+ #
3373
+ # @yield [result, err] Result & error if block supplied
3374
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord] parsed result object
3375
+ # @yieldparam err [StandardError] error object if request failed
3376
+ #
3377
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord]
3378
+ #
3379
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3380
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3381
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3382
+ def patch_project_location_answer_record(name, google_cloud_dialogflow_v2_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3383
+ command = make_simple_command(:patch, 'v2/{+name}', options)
3384
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord::Representation
3385
+ command.request_object = google_cloud_dialogflow_v2_answer_record_object
3386
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord::Representation
3387
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord
3388
+ command.params['name'] = name unless name.nil?
3389
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3390
+ command.query['fields'] = fields unless fields.nil?
3391
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3392
+ execute_or_queue_command(command, &block)
3393
+ end
3394
+
3395
+ # Creates a conversation profile in the specified project. ConversationProfile.
3396
+ # CreateTime and ConversationProfile.UpdateTime aren't populated in the response.
3397
+ # You can retrieve them via GetConversationProfile API.
3398
+ # @param [String] parent
3399
+ # Required. The project to create a conversation profile for. Format: `projects//
3400
+ # locations/`.
3401
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] google_cloud_dialogflow_v2_conversation_profile_object
3402
+ # @param [String] fields
3403
+ # Selector specifying which fields to include in a partial response.
3404
+ # @param [String] quota_user
3405
+ # Available to use for quota purposes for server-side applications. Can be any
3406
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3407
+ # @param [Google::Apis::RequestOptions] options
3408
+ # Request-specific options
3409
+ #
3410
+ # @yield [result, err] Result & error if block supplied
3411
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] parsed result object
3412
+ # @yieldparam err [StandardError] error object if request failed
3413
+ #
3414
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile]
3415
+ #
3416
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3417
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3418
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3419
+ def create_project_location_conversation_profile(parent, google_cloud_dialogflow_v2_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3420
+ command = make_simple_command(:post, 'v2/{+parent}/conversationProfiles', options)
3421
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
3422
+ command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
3423
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
3424
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
3425
+ command.params['parent'] = parent unless parent.nil?
3426
+ command.query['fields'] = fields unless fields.nil?
3427
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3428
+ execute_or_queue_command(command, &block)
3429
+ end
3430
+
3431
+ # Deletes the specified conversation profile.
3432
+ # @param [String] name
3433
+ # Required. The name of the conversation profile to delete. Format: `projects//
3434
+ # locations//conversationProfiles/`.
3435
+ # @param [String] fields
3436
+ # Selector specifying which fields to include in a partial response.
3437
+ # @param [String] quota_user
3438
+ # Available to use for quota purposes for server-side applications. Can be any
3439
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3440
+ # @param [Google::Apis::RequestOptions] options
3441
+ # Request-specific options
3442
+ #
3443
+ # @yield [result, err] Result & error if block supplied
3444
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
3445
+ # @yieldparam err [StandardError] error object if request failed
3446
+ #
3447
+ # @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
3448
+ #
3449
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3450
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3451
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3452
+ def delete_project_location_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block)
3453
+ command = make_simple_command(:delete, 'v2/{+name}', options)
3454
+ command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
3455
+ command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
3456
+ command.params['name'] = name unless name.nil?
3457
+ command.query['fields'] = fields unless fields.nil?
3458
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3459
+ execute_or_queue_command(command, &block)
3460
+ end
3461
+
3462
+ # Retrieves the specified conversation profile.
3463
+ # @param [String] name
3464
+ # Required. The resource name of the conversation profile. Format: `projects//
3465
+ # locations//conversationProfiles/`.
3466
+ # @param [String] fields
3467
+ # Selector specifying which fields to include in a partial response.
3468
+ # @param [String] quota_user
3469
+ # Available to use for quota purposes for server-side applications. Can be any
3470
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3471
+ # @param [Google::Apis::RequestOptions] options
3472
+ # Request-specific options
3473
+ #
3474
+ # @yield [result, err] Result & error if block supplied
3475
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] parsed result object
3476
+ # @yieldparam err [StandardError] error object if request failed
3477
+ #
3478
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile]
3479
+ #
3480
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3481
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3482
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3483
+ def get_project_location_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block)
3484
+ command = make_simple_command(:get, 'v2/{+name}', options)
3485
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
3486
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
3487
+ command.params['name'] = name unless name.nil?
3488
+ command.query['fields'] = fields unless fields.nil?
3489
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3490
+ execute_or_queue_command(command, &block)
3491
+ end
3492
+
3493
+ # Returns the list of all conversation profiles in the specified project.
3494
+ # @param [String] parent
3495
+ # Required. The project to list all conversation profiles from. Format: `
3496
+ # projects//locations/`.
3497
+ # @param [Fixnum] page_size
3498
+ # The maximum number of items to return in a single page. By default 100 and at
3499
+ # most 1000.
3500
+ # @param [String] page_token
3501
+ # The next_page_token value returned from a previous list request.
3502
+ # @param [String] fields
3503
+ # Selector specifying which fields to include in a partial response.
3504
+ # @param [String] quota_user
3505
+ # Available to use for quota purposes for server-side applications. Can be any
3506
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3507
+ # @param [Google::Apis::RequestOptions] options
3508
+ # Request-specific options
3509
+ #
3510
+ # @yield [result, err] Result & error if block supplied
3511
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse] parsed result object
3512
+ # @yieldparam err [StandardError] error object if request failed
3513
+ #
3514
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse]
3515
+ #
3516
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3517
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3518
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3519
+ def list_project_location_conversation_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3520
+ command = make_simple_command(:get, 'v2/{+parent}/conversationProfiles', options)
3521
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse::Representation
3522
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse
3523
+ command.params['parent'] = parent unless parent.nil?
3524
+ command.query['pageSize'] = page_size unless page_size.nil?
3525
+ command.query['pageToken'] = page_token unless page_token.nil?
3526
+ command.query['fields'] = fields unless fields.nil?
3527
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3528
+ execute_or_queue_command(command, &block)
3529
+ end
3530
+
3531
+ # Updates the specified conversation profile. ConversationProfile.CreateTime and
3532
+ # ConversationProfile.UpdateTime aren't populated in the response. You can
3533
+ # retrieve them via GetConversationProfile API.
3534
+ # @param [String] name
3535
+ # Optional. The unique identifier of this conversation profile. Format: `
3536
+ # projects//locations//conversationProfiles/`.
3537
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] google_cloud_dialogflow_v2_conversation_profile_object
3538
+ # @param [String] update_mask
3539
+ # Required. The mask to control which fields to update.
3540
+ # @param [String] fields
3541
+ # Selector specifying which fields to include in a partial response.
3542
+ # @param [String] quota_user
3543
+ # Available to use for quota purposes for server-side applications. Can be any
3544
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3545
+ # @param [Google::Apis::RequestOptions] options
3546
+ # Request-specific options
3547
+ #
3548
+ # @yield [result, err] Result & error if block supplied
3549
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile] parsed result object
3550
+ # @yieldparam err [StandardError] error object if request failed
3551
+ #
3552
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile]
3553
+ #
3554
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3555
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3556
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3557
+ def patch_project_location_conversation_profile(name, google_cloud_dialogflow_v2_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3558
+ command = make_simple_command(:patch, 'v2/{+name}', options)
3559
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
3560
+ command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
3561
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
3562
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
3563
+ command.params['name'] = name unless name.nil?
3564
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3565
+ command.query['fields'] = fields unless fields.nil?
3566
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3567
+ execute_or_queue_command(command, &block)
3568
+ end
3569
+
3570
+ # Completes the specified conversation. Finished conversations are purged from
3571
+ # the database after 30 days.
3572
+ # @param [String] name
3573
+ # Required. Resource identifier of the conversation to close. Format: `projects//
3574
+ # locations//conversations/`.
3575
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest] google_cloud_dialogflow_v2_complete_conversation_request_object
3576
+ # @param [String] fields
3577
+ # Selector specifying which fields to include in a partial response.
3578
+ # @param [String] quota_user
3579
+ # Available to use for quota purposes for server-side applications. Can be any
3580
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3581
+ # @param [Google::Apis::RequestOptions] options
3582
+ # Request-specific options
3583
+ #
3584
+ # @yield [result, err] Result & error if block supplied
3585
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] parsed result object
3586
+ # @yieldparam err [StandardError] error object if request failed
3587
+ #
3588
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation]
3589
+ #
3590
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3591
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3592
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3593
+ def complete_project_location_conversation(name, google_cloud_dialogflow_v2_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3594
+ command = make_simple_command(:post, 'v2/{+name}:complete', options)
3595
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest::Representation
3596
+ command.request_object = google_cloud_dialogflow_v2_complete_conversation_request_object
3597
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
3598
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
3599
+ command.params['name'] = name unless name.nil?
3600
+ command.query['fields'] = fields unless fields.nil?
3601
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3602
+ execute_or_queue_command(command, &block)
3603
+ end
3604
+
3605
+ # Creates a new conversation. Conversations are auto-completed after 24 hours.
3606
+ # Conversation Lifecycle: There are two stages during a conversation: Automated
3607
+ # Agent Stage and Assist Stage. For Automated Agent Stage, there will be a
3608
+ # dialogflow agent responding to user queries. For Assist Stage, there's no
3609
+ # dialogflow agent responding to user queries. But we will provide suggestions
3610
+ # which are generated from conversation. If Conversation.conversation_profile is
3611
+ # configured for a dialogflow agent, conversation will start from `Automated
3612
+ # Agent Stage`, otherwise, it will start from `Assist Stage`. And during `
3613
+ # Automated Agent Stage`, once an Intent with Intent.live_agent_handoff is
3614
+ # triggered, conversation will transfer to Assist Stage.
3615
+ # @param [String] parent
3616
+ # Required. Resource identifier of the project creating the conversation. Format:
3617
+ # `projects//locations/`.
3618
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] google_cloud_dialogflow_v2_conversation_object
3619
+ # @param [String] conversation_id
3620
+ # Optional. Identifier of the conversation. Generally it's auto generated by
3621
+ # Google. Only set it if you cannot wait for the response to return a auto-
3622
+ # generated one to you. The conversation ID must be compliant with the
3623
+ # regression fomula "a-zA-Z*" with the characters length in range of [3,64]. If
3624
+ # the field is provided, the caller is resposible for 1. the uniqueness of the
3625
+ # ID, otherwise the request will be rejected. 2. the consistency for whether to
3626
+ # use custom ID or not under a project to better ensure uniqueness.
3627
+ # @param [String] fields
3628
+ # Selector specifying which fields to include in a partial response.
3629
+ # @param [String] quota_user
3630
+ # Available to use for quota purposes for server-side applications. Can be any
3631
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3632
+ # @param [Google::Apis::RequestOptions] options
3633
+ # Request-specific options
3634
+ #
3635
+ # @yield [result, err] Result & error if block supplied
3636
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] parsed result object
3637
+ # @yieldparam err [StandardError] error object if request failed
3638
+ #
3639
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation]
3640
+ #
3641
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3642
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3643
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3644
+ def create_project_location_conversation(parent, google_cloud_dialogflow_v2_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
3645
+ command = make_simple_command(:post, 'v2/{+parent}/conversations', options)
3646
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
3647
+ command.request_object = google_cloud_dialogflow_v2_conversation_object
3648
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
3649
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
3650
+ command.params['parent'] = parent unless parent.nil?
3651
+ command.query['conversationId'] = conversation_id unless conversation_id.nil?
3652
+ command.query['fields'] = fields unless fields.nil?
3653
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3654
+ execute_or_queue_command(command, &block)
3655
+ end
3656
+
3657
+ # Retrieves the specific conversation.
3658
+ # @param [String] name
3659
+ # Required. The name of the conversation. Format: `projects//locations//
3660
+ # conversations/`.
3661
+ # @param [String] fields
3662
+ # Selector specifying which fields to include in a partial response.
3663
+ # @param [String] quota_user
3664
+ # Available to use for quota purposes for server-side applications. Can be any
3665
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3666
+ # @param [Google::Apis::RequestOptions] options
3667
+ # Request-specific options
3668
+ #
3669
+ # @yield [result, err] Result & error if block supplied
3670
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation] parsed result object
3671
+ # @yieldparam err [StandardError] error object if request failed
3672
+ #
3673
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation]
3674
+ #
3675
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3676
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3677
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3678
+ def get_project_location_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
3679
+ command = make_simple_command(:get, 'v2/{+name}', options)
3680
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
3681
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
3682
+ command.params['name'] = name unless name.nil?
3683
+ command.query['fields'] = fields unless fields.nil?
3684
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3685
+ execute_or_queue_command(command, &block)
3686
+ end
3687
+
3688
+ # Returns the list of all conversations in the specified project.
3689
+ # @param [String] parent
3690
+ # Required. The project from which to list all conversation. Format: `projects//
3691
+ # locations/`.
3692
+ # @param [String] filter
3693
+ # A filter expression that filters conversations listed in the response. In
3694
+ # general, the expression must specify the field name, a comparison operator,
3695
+ # and the value to use for filtering: - The value must be a string, a number, or
3696
+ # a boolean. - The comparison operator must be either `=`,`!=`, `>`, or `<`. -
3697
+ # To filter on multiple expressions, separate the expressions with `AND` or `OR`
3698
+ # (omitting both implies `AND`). - For clarity, expressions can be enclosed in
3699
+ # parentheses. Only `lifecycle_state` can be filtered on in this way. For
3700
+ # example, the following expression only returns `COMPLETED` conversations: `
3701
+ # lifecycle_state = "COMPLETED"` For more information about filtering, see [API
3702
+ # Filtering](https://aip.dev/160).
3703
+ # @param [Fixnum] page_size
3704
+ # Optional. The maximum number of items to return in a single page. By default
3705
+ # 100 and at most 1000.
3706
+ # @param [String] page_token
3707
+ # Optional. The next_page_token value returned from a previous list request.
3708
+ # @param [String] fields
3709
+ # Selector specifying which fields to include in a partial response.
3710
+ # @param [String] quota_user
3711
+ # Available to use for quota purposes for server-side applications. Can be any
3712
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3713
+ # @param [Google::Apis::RequestOptions] options
3714
+ # Request-specific options
3715
+ #
3716
+ # @yield [result, err] Result & error if block supplied
3717
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse] parsed result object
3718
+ # @yieldparam err [StandardError] error object if request failed
3719
+ #
3720
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse]
3721
+ #
3722
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3723
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3724
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3725
+ def list_project_location_conversations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3726
+ command = make_simple_command(:get, 'v2/{+parent}/conversations', options)
3727
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse::Representation
3728
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse
3729
+ command.params['parent'] = parent unless parent.nil?
3730
+ command.query['filter'] = filter unless filter.nil?
3731
+ command.query['pageSize'] = page_size unless page_size.nil?
3732
+ command.query['pageToken'] = page_token unless page_token.nil?
3733
+ command.query['fields'] = fields unless fields.nil?
3734
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3735
+ execute_or_queue_command(command, &block)
3736
+ end
3737
+
3738
+ # Creates a call matcher that links incoming SIP calls to the specified
3739
+ # conversation if they fulfill specified criteria.
3740
+ # @param [String] parent
3741
+ # Required. Resource identifier of the conversation adding the call matcher.
3742
+ # Format: `projects//locations//conversations/`.
3743
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CreateCallMatcherRequest] google_cloud_dialogflow_v2_create_call_matcher_request_object
3744
+ # @param [String] fields
3745
+ # Selector specifying which fields to include in a partial response.
3746
+ # @param [String] quota_user
3747
+ # Available to use for quota purposes for server-side applications. Can be any
3748
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3749
+ # @param [Google::Apis::RequestOptions] options
3750
+ # Request-specific options
3751
+ #
3752
+ # @yield [result, err] Result & error if block supplied
3753
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher] parsed result object
3754
+ # @yieldparam err [StandardError] error object if request failed
3755
+ #
3756
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher]
3757
+ #
3758
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3759
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3760
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3761
+ def create_project_location_conversation_call_matcher(parent, google_cloud_dialogflow_v2_create_call_matcher_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3762
+ command = make_simple_command(:post, 'v2/{+parent}/callMatchers', options)
3763
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CreateCallMatcherRequest::Representation
3764
+ command.request_object = google_cloud_dialogflow_v2_create_call_matcher_request_object
3765
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher::Representation
3766
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CallMatcher
3767
+ command.params['parent'] = parent unless parent.nil?
3768
+ command.query['fields'] = fields unless fields.nil?
3769
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3770
+ execute_or_queue_command(command, &block)
3771
+ end
3772
+
3773
+ # Requests deletion of a call matcher.
3774
+ # @param [String] name
3775
+ # Required. The unique identifier of the CallMatcher to delete. Format: `
3776
+ # projects//locations//conversations//callMatchers/`.
3777
+ # @param [String] fields
3778
+ # Selector specifying which fields to include in a partial response.
3779
+ # @param [String] quota_user
3780
+ # Available to use for quota purposes for server-side applications. Can be any
3781
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3782
+ # @param [Google::Apis::RequestOptions] options
3783
+ # Request-specific options
3784
+ #
3785
+ # @yield [result, err] Result & error if block supplied
3786
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
3787
+ # @yieldparam err [StandardError] error object if request failed
3788
+ #
3789
+ # @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
3790
+ #
3791
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3792
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3793
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3794
+ def delete_project_location_conversation_call_matcher(name, fields: nil, quota_user: nil, options: nil, &block)
3795
+ command = make_simple_command(:delete, 'v2/{+name}', options)
3796
+ command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
3797
+ command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
3798
+ command.params['name'] = name unless name.nil?
3799
+ command.query['fields'] = fields unless fields.nil?
3800
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3801
+ execute_or_queue_command(command, &block)
3802
+ end
3803
+
3804
+ # Returns the list of all call matchers in the specified conversation.
3805
+ # @param [String] parent
3806
+ # Required. The conversation to list all call matchers from. Format: `projects//
3807
+ # locations//conversations/`.
3808
+ # @param [Fixnum] page_size
3809
+ # Optional. The maximum number of items to return in a single page. By default
3810
+ # 100 and at most 1000.
3811
+ # @param [String] page_token
3812
+ # Optional. The next_page_token value returned from a previous list request.
3813
+ # @param [String] fields
3814
+ # Selector specifying which fields to include in a partial response.
3815
+ # @param [String] quota_user
3816
+ # Available to use for quota purposes for server-side applications. Can be any
3817
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3818
+ # @param [Google::Apis::RequestOptions] options
3819
+ # Request-specific options
3820
+ #
3821
+ # @yield [result, err] Result & error if block supplied
3822
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse] parsed result object
3823
+ # @yieldparam err [StandardError] error object if request failed
3824
+ #
3825
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse]
3826
+ #
3827
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3828
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3829
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3830
+ def list_project_location_conversation_call_matchers(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3831
+ command = make_simple_command(:get, 'v2/{+parent}/callMatchers', options)
3832
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse::Representation
3833
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListCallMatchersResponse
3834
+ command.params['parent'] = parent unless parent.nil?
3835
+ command.query['pageSize'] = page_size unless page_size.nil?
3836
+ command.query['pageToken'] = page_token unless page_token.nil?
3837
+ command.query['fields'] = fields unless fields.nil?
3838
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3839
+ execute_or_queue_command(command, &block)
3840
+ end
3841
+
3842
+ # Lists messages that belong to a given conversation. `messages` are ordered by `
3843
+ # create_time` in descending order. To fetch updates without duplication, send
3844
+ # request with filter `create_time_epoch_microseconds > [first item's
3845
+ # create_time of previous request]` and empty page_token.
3846
+ # @param [String] parent
3847
+ # Required. The name of the conversation to list messages for. Format: `projects/
3848
+ # /locations//conversations/`
3849
+ # @param [String] filter
3850
+ # Optional. Filter on message fields. Currently predicates on `create_time` and `
3851
+ # create_time_epoch_microseconds` are supported. `create_time` only support
3852
+ # milliseconds accuracy. E.g., `create_time_epoch_microseconds >
3853
+ # 1551790877964485` or `create_time > 2017-01-15T01:30:15.01Z`. For more
3854
+ # information about filtering, see [API Filtering](https://aip.dev/160).
3855
+ # @param [Fixnum] page_size
3856
+ # Optional. The maximum number of items to return in a single page. By default
3857
+ # 100 and at most 1000.
3858
+ # @param [String] page_token
3859
+ # Optional. The next_page_token value returned from a previous list request.
3860
+ # @param [String] fields
3861
+ # Selector specifying which fields to include in a partial response.
3862
+ # @param [String] quota_user
3863
+ # Available to use for quota purposes for server-side applications. Can be any
3864
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3865
+ # @param [Google::Apis::RequestOptions] options
3866
+ # Request-specific options
3867
+ #
3868
+ # @yield [result, err] Result & error if block supplied
3869
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse] parsed result object
3870
+ # @yieldparam err [StandardError] error object if request failed
3871
+ #
3872
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse]
3873
+ #
3874
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3875
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3876
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3877
+ def list_project_location_conversation_messages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3878
+ command = make_simple_command(:get, 'v2/{+parent}/messages', options)
3879
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse::Representation
3880
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse
3881
+ command.params['parent'] = parent unless parent.nil?
3882
+ command.query['filter'] = filter unless filter.nil?
3883
+ command.query['pageSize'] = page_size unless page_size.nil?
3884
+ command.query['pageToken'] = page_token unless page_token.nil?
3885
+ command.query['fields'] = fields unless fields.nil?
3886
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3887
+ execute_or_queue_command(command, &block)
3888
+ end
3889
+
3890
+ # Adds a text (chat, for example), or audio (phone recording, for example)
3891
+ # message from a participant into the conversation. Note: Always use agent
3892
+ # versions for production traffic sent to virtual agents. See [Versions and
3893
+ # environments(https://cloud.google.com/dialogflow/es/docs/agents-versions).
3894
+ # @param [String] participant
3895
+ # Required. The name of the participant this text comes from. Format: `projects//
3896
+ # locations//conversations//participants/`.
3897
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest] google_cloud_dialogflow_v2_analyze_content_request_object
3898
+ # @param [String] fields
3899
+ # Selector specifying which fields to include in a partial response.
3900
+ # @param [String] quota_user
3901
+ # Available to use for quota purposes for server-side applications. Can be any
3902
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3903
+ # @param [Google::Apis::RequestOptions] options
3904
+ # Request-specific options
3905
+ #
3906
+ # @yield [result, err] Result & error if block supplied
3907
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse] parsed result object
3908
+ # @yieldparam err [StandardError] error object if request failed
3909
+ #
3910
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse]
3911
+ #
3912
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3913
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3914
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3915
+ def analyze_project_location_conversation_participant_content(participant, google_cloud_dialogflow_v2_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3916
+ command = make_simple_command(:post, 'v2/{+participant}:analyzeContent', options)
3917
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest::Representation
3918
+ command.request_object = google_cloud_dialogflow_v2_analyze_content_request_object
3919
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse::Representation
3920
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse
3921
+ command.params['participant'] = participant unless participant.nil?
3922
+ command.query['fields'] = fields unless fields.nil?
3923
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3924
+ execute_or_queue_command(command, &block)
3925
+ end
3926
+
3927
+ # Creates a new participant in a conversation.
3928
+ # @param [String] parent
3929
+ # Required. Resource identifier of the conversation adding the participant.
3930
+ # Format: `projects//locations//conversations/`.
3931
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] google_cloud_dialogflow_v2_participant_object
3932
+ # @param [String] fields
3933
+ # Selector specifying which fields to include in a partial response.
3934
+ # @param [String] quota_user
3935
+ # Available to use for quota purposes for server-side applications. Can be any
3936
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3937
+ # @param [Google::Apis::RequestOptions] options
3938
+ # Request-specific options
3939
+ #
3940
+ # @yield [result, err] Result & error if block supplied
3941
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] parsed result object
3942
+ # @yieldparam err [StandardError] error object if request failed
3943
+ #
3944
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant]
3945
+ #
3946
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3947
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3948
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3949
+ def create_project_location_conversation_participant(parent, google_cloud_dialogflow_v2_participant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3950
+ command = make_simple_command(:post, 'v2/{+parent}/participants', options)
3951
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
3952
+ command.request_object = google_cloud_dialogflow_v2_participant_object
3953
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
3954
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
3955
+ command.params['parent'] = parent unless parent.nil?
3956
+ command.query['fields'] = fields unless fields.nil?
3957
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3958
+ execute_or_queue_command(command, &block)
3959
+ end
3960
+
3961
+ # Retrieves a conversation participant.
3962
+ # @param [String] name
3963
+ # Required. The name of the participant. Format: `projects//locations//
3964
+ # conversations//participants/`.
3965
+ # @param [String] fields
3966
+ # Selector specifying which fields to include in a partial response.
3967
+ # @param [String] quota_user
3968
+ # Available to use for quota purposes for server-side applications. Can be any
3969
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3970
+ # @param [Google::Apis::RequestOptions] options
3971
+ # Request-specific options
3972
+ #
3973
+ # @yield [result, err] Result & error if block supplied
3974
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] parsed result object
3975
+ # @yieldparam err [StandardError] error object if request failed
3976
+ #
3977
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant]
3978
+ #
3979
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3980
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3981
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3982
+ def get_project_location_conversation_participant(name, fields: nil, quota_user: nil, options: nil, &block)
3983
+ command = make_simple_command(:get, 'v2/{+name}', options)
3984
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
3985
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
3986
+ command.params['name'] = name unless name.nil?
3987
+ command.query['fields'] = fields unless fields.nil?
3988
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3989
+ execute_or_queue_command(command, &block)
3990
+ end
3991
+
3992
+ # Returns the list of all participants in the specified conversation.
3993
+ # @param [String] parent
3994
+ # Required. The conversation to list all participants from. Format: `projects//
3995
+ # locations//conversations/`.
3996
+ # @param [Fixnum] page_size
3997
+ # Optional. The maximum number of items to return in a single page. By default
3998
+ # 100 and at most 1000.
3999
+ # @param [String] page_token
4000
+ # Optional. The next_page_token value returned from a previous list request.
4001
+ # @param [String] fields
4002
+ # Selector specifying which fields to include in a partial response.
4003
+ # @param [String] quota_user
4004
+ # Available to use for quota purposes for server-side applications. Can be any
4005
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4006
+ # @param [Google::Apis::RequestOptions] options
4007
+ # Request-specific options
4008
+ #
4009
+ # @yield [result, err] Result & error if block supplied
4010
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse] parsed result object
4011
+ # @yieldparam err [StandardError] error object if request failed
4012
+ #
4013
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse]
4014
+ #
4015
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4016
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4017
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4018
+ def list_project_location_conversation_participants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4019
+ command = make_simple_command(:get, 'v2/{+parent}/participants', options)
4020
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse::Representation
4021
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListParticipantsResponse
4022
+ command.params['parent'] = parent unless parent.nil?
4023
+ command.query['pageSize'] = page_size unless page_size.nil?
4024
+ command.query['pageToken'] = page_token unless page_token.nil?
4025
+ command.query['fields'] = fields unless fields.nil?
4026
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4027
+ execute_or_queue_command(command, &block)
4028
+ end
4029
+
4030
+ # Updates the specified participant.
4031
+ # @param [String] name
4032
+ # Optional. The unique identifier of this participant. Format: `projects//
4033
+ # locations//conversations//participants/`.
4034
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] google_cloud_dialogflow_v2_participant_object
4035
+ # @param [String] update_mask
4036
+ # Required. The mask to specify which fields to update.
4037
+ # @param [String] fields
4038
+ # Selector specifying which fields to include in a partial response.
4039
+ # @param [String] quota_user
4040
+ # Available to use for quota purposes for server-side applications. Can be any
4041
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4042
+ # @param [Google::Apis::RequestOptions] options
4043
+ # Request-specific options
4044
+ #
4045
+ # @yield [result, err] Result & error if block supplied
4046
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant] parsed result object
4047
+ # @yieldparam err [StandardError] error object if request failed
4048
+ #
4049
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant]
4050
+ #
4051
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4052
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4053
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4054
+ def patch_project_location_conversation_participant(name, google_cloud_dialogflow_v2_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4055
+ command = make_simple_command(:patch, 'v2/{+name}', options)
4056
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
4057
+ command.request_object = google_cloud_dialogflow_v2_participant_object
4058
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
4059
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
4060
+ command.params['name'] = name unless name.nil?
4061
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4062
+ command.query['fields'] = fields unless fields.nil?
4063
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4064
+ execute_or_queue_command(command, &block)
4065
+ end
4066
+
4067
+ # Gets suggested articles for a participant based on specific historical
4068
+ # messages.
4069
+ # @param [String] parent
4070
+ # Required. The name of the participant to fetch suggestion for. Format: `
4071
+ # projects//locations//conversations//participants/`.
4072
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest] google_cloud_dialogflow_v2_suggest_articles_request_object
4073
+ # @param [String] fields
4074
+ # Selector specifying which fields to include in a partial response.
4075
+ # @param [String] quota_user
4076
+ # Available to use for quota purposes for server-side applications. Can be any
4077
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4078
+ # @param [Google::Apis::RequestOptions] options
4079
+ # Request-specific options
4080
+ #
4081
+ # @yield [result, err] Result & error if block supplied
4082
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse] parsed result object
4083
+ # @yieldparam err [StandardError] error object if request failed
4084
+ #
4085
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse]
4086
+ #
4087
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4088
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4089
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4090
+ def suggest_project_location_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4091
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestArticles', options)
4092
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest::Representation
4093
+ command.request_object = google_cloud_dialogflow_v2_suggest_articles_request_object
4094
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse::Representation
4095
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse
4096
+ command.params['parent'] = parent unless parent.nil?
4097
+ command.query['fields'] = fields unless fields.nil?
4098
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4099
+ execute_or_queue_command(command, &block)
4100
+ end
4101
+
4102
+ # Gets suggested faq answers for a participant based on specific historical
4103
+ # messages.
4104
+ # @param [String] parent
4105
+ # Required. The name of the participant to fetch suggestion for. Format: `
4106
+ # projects//locations//conversations//participants/`.
4107
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest] google_cloud_dialogflow_v2_suggest_faq_answers_request_object
4108
+ # @param [String] fields
4109
+ # Selector specifying which fields to include in a partial response.
4110
+ # @param [String] quota_user
4111
+ # Available to use for quota purposes for server-side applications. Can be any
4112
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4113
+ # @param [Google::Apis::RequestOptions] options
4114
+ # Request-specific options
4115
+ #
4116
+ # @yield [result, err] Result & error if block supplied
4117
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse] parsed result object
4118
+ # @yieldparam err [StandardError] error object if request failed
4119
+ #
4120
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
4121
+ #
4122
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4123
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4124
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4125
+ def suggest_project_location_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4126
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestFaqAnswers', options)
4127
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest::Representation
4128
+ command.request_object = google_cloud_dialogflow_v2_suggest_faq_answers_request_object
4129
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse::Representation
4130
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse
4131
+ command.params['parent'] = parent unless parent.nil?
4132
+ command.query['fields'] = fields unless fields.nil?
4133
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4134
+ execute_or_queue_command(command, &block)
4135
+ end
4136
+
4137
+ # Creates a knowledge base.
4138
+ # @param [String] parent
4139
+ # Required. The project to create a knowledge base for. Format: `projects//
4140
+ # locations/`.
4141
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] google_cloud_dialogflow_v2_knowledge_base_object
4142
+ # @param [String] fields
4143
+ # Selector specifying which fields to include in a partial response.
4144
+ # @param [String] quota_user
4145
+ # Available to use for quota purposes for server-side applications. Can be any
4146
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4147
+ # @param [Google::Apis::RequestOptions] options
4148
+ # Request-specific options
4149
+ #
4150
+ # @yield [result, err] Result & error if block supplied
4151
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] parsed result object
4152
+ # @yieldparam err [StandardError] error object if request failed
4153
+ #
4154
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase]
4155
+ #
4156
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4157
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4158
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4159
+ def create_project_location_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4160
+ command = make_simple_command(:post, 'v2/{+parent}/knowledgeBases', options)
4161
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
4162
+ command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
4163
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
4164
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
4165
+ command.params['parent'] = parent unless parent.nil?
4166
+ command.query['fields'] = fields unless fields.nil?
4167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4168
+ execute_or_queue_command(command, &block)
4169
+ end
4170
+
4171
+ # Deletes the specified knowledge base.
4172
+ # @param [String] name
4173
+ # Required. The name of the knowledge base to delete. Format: `projects//
4174
+ # locations//knowledgeBases/`.
4175
+ # @param [Boolean] force
4176
+ # Optional. Force deletes the knowledge base. When set to true, any documents in
4177
+ # the knowledge base are also deleted.
4178
+ # @param [String] fields
4179
+ # Selector specifying which fields to include in a partial response.
4180
+ # @param [String] quota_user
4181
+ # Available to use for quota purposes for server-side applications. Can be any
4182
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4183
+ # @param [Google::Apis::RequestOptions] options
4184
+ # Request-specific options
4185
+ #
4186
+ # @yield [result, err] Result & error if block supplied
4187
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
4188
+ # @yieldparam err [StandardError] error object if request failed
4189
+ #
4190
+ # @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
4191
+ #
4192
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4193
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4194
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4195
+ def delete_project_location_knowledge_basis(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
4196
+ command = make_simple_command(:delete, 'v2/{+name}', options)
4197
+ command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
4198
+ command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
4199
+ command.params['name'] = name unless name.nil?
4200
+ command.query['force'] = force unless force.nil?
4201
+ command.query['fields'] = fields unless fields.nil?
4202
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4203
+ execute_or_queue_command(command, &block)
4204
+ end
4205
+
4206
+ # Retrieves the specified knowledge base.
4207
+ # @param [String] name
4208
+ # Required. The name of the knowledge base to retrieve. Format `projects//
4209
+ # locations//knowledgeBases/`.
4210
+ # @param [String] fields
4211
+ # Selector specifying which fields to include in a partial response.
4212
+ # @param [String] quota_user
4213
+ # Available to use for quota purposes for server-side applications. Can be any
4214
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4215
+ # @param [Google::Apis::RequestOptions] options
4216
+ # Request-specific options
4217
+ #
4218
+ # @yield [result, err] Result & error if block supplied
4219
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] parsed result object
4220
+ # @yieldparam err [StandardError] error object if request failed
4221
+ #
4222
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase]
4223
+ #
4224
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4225
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4226
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4227
+ def get_project_location_knowledge_basis(name, fields: nil, quota_user: nil, options: nil, &block)
4228
+ command = make_simple_command(:get, 'v2/{+name}', options)
4229
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
4230
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
4231
+ command.params['name'] = name unless name.nil?
4232
+ command.query['fields'] = fields unless fields.nil?
4233
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4234
+ execute_or_queue_command(command, &block)
4235
+ end
4236
+
4237
+ # Returns the list of all knowledge bases of the specified agent.
4238
+ # @param [String] parent
4239
+ # Required. The project to list of knowledge bases for. Format: `projects//
4240
+ # locations/`.
4241
+ # @param [Fixnum] page_size
4242
+ # The maximum number of items to return in a single page. By default 10 and at
4243
+ # most 100.
4244
+ # @param [String] page_token
4245
+ # The next_page_token value returned from a previous list request.
4246
+ # @param [String] fields
4247
+ # Selector specifying which fields to include in a partial response.
4248
+ # @param [String] quota_user
4249
+ # Available to use for quota purposes for server-side applications. Can be any
4250
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4251
+ # @param [Google::Apis::RequestOptions] options
4252
+ # Request-specific options
4253
+ #
4254
+ # @yield [result, err] Result & error if block supplied
4255
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse] parsed result object
4256
+ # @yieldparam err [StandardError] error object if request failed
4257
+ #
4258
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse]
4259
+ #
4260
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4261
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4262
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4263
+ def list_project_location_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4264
+ command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
4265
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
4266
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
4267
+ command.params['parent'] = parent unless parent.nil?
4268
+ command.query['pageSize'] = page_size unless page_size.nil?
4269
+ command.query['pageToken'] = page_token unless page_token.nil?
4270
+ command.query['fields'] = fields unless fields.nil?
4271
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4272
+ execute_or_queue_command(command, &block)
4273
+ end
4274
+
4275
+ # Updates the specified knowledge base.
4276
+ # @param [String] name
4277
+ # The knowledge base resource name. The name must be empty when creating a
4278
+ # knowledge base. Format: `projects//locations//knowledgeBases/`.
4279
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] google_cloud_dialogflow_v2_knowledge_base_object
4280
+ # @param [String] update_mask
4281
+ # Optional. Not specified means `update all`. Currently, only `display_name` can
4282
+ # be updated, an InvalidArgument will be returned for attempting to update other
4283
+ # fields.
4284
+ # @param [String] fields
4285
+ # Selector specifying which fields to include in a partial response.
4286
+ # @param [String] quota_user
4287
+ # Available to use for quota purposes for server-side applications. Can be any
4288
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4289
+ # @param [Google::Apis::RequestOptions] options
4290
+ # Request-specific options
4291
+ #
4292
+ # @yield [result, err] Result & error if block supplied
4293
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase] parsed result object
4294
+ # @yieldparam err [StandardError] error object if request failed
4295
+ #
4296
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase]
4297
+ #
4298
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4299
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4300
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4301
+ def patch_project_location_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4302
+ command = make_simple_command(:patch, 'v2/{+name}', options)
4303
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
4304
+ command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
4305
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
4306
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
4307
+ command.params['name'] = name unless name.nil?
4308
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4309
+ command.query['fields'] = fields unless fields.nil?
4310
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4311
+ execute_or_queue_command(command, &block)
4312
+ end
4313
+
4314
+ # Creates a new document. Operation
4315
+ # @param [String] parent
4316
+ # Required. The knowledge base to create a document for. Format: `projects//
4317
+ # locations//knowledgeBases/`.
4318
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document] google_cloud_dialogflow_v2_document_object
4319
+ # @param [String] fields
4320
+ # Selector specifying which fields to include in a partial response.
4321
+ # @param [String] quota_user
4322
+ # Available to use for quota purposes for server-side applications. Can be any
4323
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4324
+ # @param [Google::Apis::RequestOptions] options
4325
+ # Request-specific options
4326
+ #
4327
+ # @yield [result, err] Result & error if block supplied
4328
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
4329
+ # @yieldparam err [StandardError] error object if request failed
4330
+ #
4331
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
4332
+ #
4333
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4334
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4335
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4336
+ def create_project_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2_document_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4337
+ command = make_simple_command(:post, 'v2/{+parent}/documents', options)
4338
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
4339
+ command.request_object = google_cloud_dialogflow_v2_document_object
4340
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
4341
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
4342
+ command.params['parent'] = parent unless parent.nil?
4343
+ command.query['fields'] = fields unless fields.nil?
4344
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4345
+ execute_or_queue_command(command, &block)
4346
+ end
4347
+
4348
+ # Deletes the specified document. Operation
4349
+ # @param [String] name
4350
+ # Required. The name of the document to delete. Format: `projects//locations//
4351
+ # knowledgeBases//documents/`.
4352
+ # @param [String] fields
4353
+ # Selector specifying which fields to include in a partial response.
4354
+ # @param [String] quota_user
4355
+ # Available to use for quota purposes for server-side applications. Can be any
4356
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4357
+ # @param [Google::Apis::RequestOptions] options
4358
+ # Request-specific options
4359
+ #
4360
+ # @yield [result, err] Result & error if block supplied
4361
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
4362
+ # @yieldparam err [StandardError] error object if request failed
4363
+ #
4364
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
4365
+ #
4366
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4367
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4368
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4369
+ def delete_project_location_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
4370
+ command = make_simple_command(:delete, 'v2/{+name}', options)
4371
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
4372
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
4373
+ command.params['name'] = name unless name.nil?
4374
+ command.query['fields'] = fields unless fields.nil?
4375
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4376
+ execute_or_queue_command(command, &block)
4377
+ end
4378
+
4379
+ # Retrieves the specified document.
4380
+ # @param [String] name
4381
+ # Required. The name of the document to retrieve. Format `projects//locations//
4382
+ # knowledgeBases//documents/`.
4383
+ # @param [String] fields
4384
+ # Selector specifying which fields to include in a partial response.
4385
+ # @param [String] quota_user
4386
+ # Available to use for quota purposes for server-side applications. Can be any
4387
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4388
+ # @param [Google::Apis::RequestOptions] options
4389
+ # Request-specific options
4390
+ #
4391
+ # @yield [result, err] Result & error if block supplied
4392
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document] parsed result object
4393
+ # @yieldparam err [StandardError] error object if request failed
4394
+ #
4395
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document]
4396
+ #
4397
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4398
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4399
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4400
+ def get_project_location_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
4401
+ command = make_simple_command(:get, 'v2/{+name}', options)
4402
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
4403
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document
4404
+ command.params['name'] = name unless name.nil?
4405
+ command.query['fields'] = fields unless fields.nil?
4406
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4407
+ execute_or_queue_command(command, &block)
4408
+ end
4409
+
4410
+ # Returns the list of all documents of the knowledge base.
4411
+ # @param [String] parent
4412
+ # Required. The knowledge base to list all documents for. Format: `projects//
4413
+ # locations//knowledgeBases/`.
4414
+ # @param [Fixnum] page_size
4415
+ # The maximum number of items to return in a single page. By default 10 and at
4416
+ # most 100.
4417
+ # @param [String] page_token
4418
+ # The next_page_token value returned from a previous list request.
4419
+ # @param [String] fields
4420
+ # Selector specifying which fields to include in a partial response.
4421
+ # @param [String] quota_user
4422
+ # Available to use for quota purposes for server-side applications. Can be any
4423
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4424
+ # @param [Google::Apis::RequestOptions] options
4425
+ # Request-specific options
4426
+ #
4427
+ # @yield [result, err] Result & error if block supplied
4428
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse] parsed result object
4429
+ # @yieldparam err [StandardError] error object if request failed
4430
+ #
4431
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse]
4432
+ #
4433
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4434
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4435
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4436
+ def list_project_location_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4437
+ command = make_simple_command(:get, 'v2/{+parent}/documents', options)
4438
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
4439
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
4440
+ command.params['parent'] = parent unless parent.nil?
4441
+ command.query['pageSize'] = page_size unless page_size.nil?
4442
+ command.query['pageToken'] = page_token unless page_token.nil?
4443
+ command.query['fields'] = fields unless fields.nil?
4444
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4445
+ execute_or_queue_command(command, &block)
4446
+ end
4447
+
4448
+ # Updates the specified document. Operation
4449
+ # @param [String] name
4450
+ # Optional. The document resource name. The name must be empty when creating a
4451
+ # document. Format: `projects//locations//knowledgeBases//documents/`.
4452
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document] google_cloud_dialogflow_v2_document_object
4453
+ # @param [String] update_mask
4454
+ # Optional. Not specified means `update all`. Currently, only `display_name` can
4455
+ # be updated, an InvalidArgument will be returned for attempting to update other
4456
+ # fields.
4457
+ # @param [String] fields
4458
+ # Selector specifying which fields to include in a partial response.
4459
+ # @param [String] quota_user
4460
+ # Available to use for quota purposes for server-side applications. Can be any
4461
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4462
+ # @param [Google::Apis::RequestOptions] options
4463
+ # Request-specific options
4464
+ #
4465
+ # @yield [result, err] Result & error if block supplied
4466
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
4467
+ # @yieldparam err [StandardError] error object if request failed
4468
+ #
4469
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
4470
+ #
4471
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4472
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4473
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4474
+ def patch_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4475
+ command = make_simple_command(:patch, 'v2/{+name}', options)
4476
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
4477
+ command.request_object = google_cloud_dialogflow_v2_document_object
4478
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
4479
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
4480
+ command.params['name'] = name unless name.nil?
4481
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4482
+ command.query['fields'] = fields unless fields.nil?
4483
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4484
+ execute_or_queue_command(command, &block)
4485
+ end
4486
+
4487
+ # Reloads the specified document from its specified source, content_uri or
4488
+ # content. The previously loaded content of the document will be deleted. Note:
4489
+ # Even when the content of the document has not changed, there still may be side
4490
+ # effects because of internal implementation changes. Note: The `projects.agent.
4491
+ # knowledgeBases.documents` resource is deprecated; only use `projects.
4492
+ # knowledgeBases.documents`. Operation
4493
+ # @param [String] name
4494
+ # Required. The name of the document to reload. Format: `projects//locations//
4495
+ # knowledgeBases//documents/`
4496
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest] google_cloud_dialogflow_v2_reload_document_request_object
4497
+ # @param [String] fields
4498
+ # Selector specifying which fields to include in a partial response.
4499
+ # @param [String] quota_user
4500
+ # Available to use for quota purposes for server-side applications. Can be any
4501
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4502
+ # @param [Google::Apis::RequestOptions] options
4503
+ # Request-specific options
4504
+ #
4505
+ # @yield [result, err] Result & error if block supplied
4506
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
4507
+ # @yieldparam err [StandardError] error object if request failed
4508
+ #
4509
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
4510
+ #
4511
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4512
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4513
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4514
+ def reload_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4515
+ command = make_simple_command(:post, 'v2/{+name}:reload', options)
4516
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest::Representation
4517
+ command.request_object = google_cloud_dialogflow_v2_reload_document_request_object
4518
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
4519
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
4520
+ command.params['name'] = name unless name.nil?
4521
+ command.query['fields'] = fields unless fields.nil?
4522
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4523
+ execute_or_queue_command(command, &block)
4524
+ end
4525
+
2096
4526
  # Starts asynchronous cancellation on a long-running operation. The server makes
2097
4527
  # a best effort to cancel the operation, but success is not guaranteed. If the
2098
4528
  # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.