google-apis-dialogflow_v3 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-dialogflow_v3.rb +15 -0
- data/lib/google/apis/dialogflow_v3.rb +40 -0
- data/lib/google/apis/dialogflow_v3/classes.rb +12305 -0
- data/lib/google/apis/dialogflow_v3/gem_version.rb +28 -0
- data/lib/google/apis/dialogflow_v3/representations.rb +5435 -0
- data/lib/google/apis/dialogflow_v3/service.rb +3797 -0
- metadata +76 -0
@@ -0,0 +1,3797 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module DialogflowV3
|
23
|
+
# Dialogflow API
|
24
|
+
#
|
25
|
+
# Builds conversational interfaces (for example, chatbots, and voice-powered
|
26
|
+
# apps and devices).
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# require 'google/apis/dialogflow_v3'
|
30
|
+
#
|
31
|
+
# Dialogflow = Google::Apis::DialogflowV3 # Alias the module
|
32
|
+
# service = Dialogflow::DialogflowService.new
|
33
|
+
#
|
34
|
+
# @see https://cloud.google.com/dialogflow/
|
35
|
+
class DialogflowService < Google::Apis::Core::BaseService
|
36
|
+
# @return [String]
|
37
|
+
# API key. Your API key identifies your project and provides you with API access,
|
38
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
39
|
+
attr_accessor :key
|
40
|
+
|
41
|
+
# @return [String]
|
42
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
43
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
44
|
+
attr_accessor :quota_user
|
45
|
+
|
46
|
+
def initialize
|
47
|
+
super('https://dialogflow.googleapis.com/', '',
|
48
|
+
client_name: 'google-apis-dialogflow_v3',
|
49
|
+
client_version: Google::Apis::DialogflowV3::GEM_VERSION)
|
50
|
+
@batch_path = 'batch'
|
51
|
+
end
|
52
|
+
|
53
|
+
# Creates an agent in the specified location.
|
54
|
+
# @param [String] parent
|
55
|
+
# Required. The location to create a agent for. Format: `projects//locations/`.
|
56
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent] google_cloud_dialogflow_cx_v3_agent_object
|
57
|
+
# @param [String] fields
|
58
|
+
# Selector specifying which fields to include in a partial response.
|
59
|
+
# @param [String] quota_user
|
60
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
61
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
62
|
+
# @param [Google::Apis::RequestOptions] options
|
63
|
+
# Request-specific options
|
64
|
+
#
|
65
|
+
# @yield [result, err] Result & error if block supplied
|
66
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent] parsed result object
|
67
|
+
# @yieldparam err [StandardError] error object if request failed
|
68
|
+
#
|
69
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent]
|
70
|
+
#
|
71
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
72
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
73
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
74
|
+
def create_project_location_agent(parent, google_cloud_dialogflow_cx_v3_agent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
75
|
+
command = make_simple_command(:post, 'v3/{+parent}/agents', options)
|
76
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
|
77
|
+
command.request_object = google_cloud_dialogflow_cx_v3_agent_object
|
78
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
|
79
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
|
80
|
+
command.params['parent'] = parent unless parent.nil?
|
81
|
+
command.query['fields'] = fields unless fields.nil?
|
82
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
83
|
+
execute_or_queue_command(command, &block)
|
84
|
+
end
|
85
|
+
|
86
|
+
# Deletes the specified agent.
|
87
|
+
# @param [String] name
|
88
|
+
# Required. The name of the agent to delete. Format: `projects//locations//
|
89
|
+
# agents/`.
|
90
|
+
# @param [String] fields
|
91
|
+
# Selector specifying which fields to include in a partial response.
|
92
|
+
# @param [String] quota_user
|
93
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
94
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
95
|
+
# @param [Google::Apis::RequestOptions] options
|
96
|
+
# Request-specific options
|
97
|
+
#
|
98
|
+
# @yield [result, err] Result & error if block supplied
|
99
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
100
|
+
# @yieldparam err [StandardError] error object if request failed
|
101
|
+
#
|
102
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
103
|
+
#
|
104
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
105
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
106
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
107
|
+
def delete_project_location_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
108
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
109
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
110
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
111
|
+
command.params['name'] = name unless name.nil?
|
112
|
+
command.query['fields'] = fields unless fields.nil?
|
113
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
114
|
+
execute_or_queue_command(command, &block)
|
115
|
+
end
|
116
|
+
|
117
|
+
# Exports the specified agent to a binary file.
|
118
|
+
# @param [String] name
|
119
|
+
# Required. The name of the agent to export. Format: `projects//locations//
|
120
|
+
# agents/`.
|
121
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportAgentRequest] google_cloud_dialogflow_cx_v3_export_agent_request_object
|
122
|
+
# @param [String] fields
|
123
|
+
# Selector specifying which fields to include in a partial response.
|
124
|
+
# @param [String] quota_user
|
125
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
126
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
127
|
+
# @param [Google::Apis::RequestOptions] options
|
128
|
+
# Request-specific options
|
129
|
+
#
|
130
|
+
# @yield [result, err] Result & error if block supplied
|
131
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
132
|
+
# @yieldparam err [StandardError] error object if request failed
|
133
|
+
#
|
134
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
135
|
+
#
|
136
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
137
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
138
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
139
|
+
def export_project_location_agent(name, google_cloud_dialogflow_cx_v3_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
140
|
+
command = make_simple_command(:post, 'v3/{+name}:export', options)
|
141
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportAgentRequest::Representation
|
142
|
+
command.request_object = google_cloud_dialogflow_cx_v3_export_agent_request_object
|
143
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
144
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
145
|
+
command.params['name'] = name unless name.nil?
|
146
|
+
command.query['fields'] = fields unless fields.nil?
|
147
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
148
|
+
execute_or_queue_command(command, &block)
|
149
|
+
end
|
150
|
+
|
151
|
+
# Retrieves the specified agent.
|
152
|
+
# @param [String] name
|
153
|
+
# Required. The name of the agent. Format: `projects//locations//agents/`.
|
154
|
+
# @param [String] fields
|
155
|
+
# Selector specifying which fields to include in a partial response.
|
156
|
+
# @param [String] quota_user
|
157
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
158
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
159
|
+
# @param [Google::Apis::RequestOptions] options
|
160
|
+
# Request-specific options
|
161
|
+
#
|
162
|
+
# @yield [result, err] Result & error if block supplied
|
163
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent] parsed result object
|
164
|
+
# @yieldparam err [StandardError] error object if request failed
|
165
|
+
#
|
166
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent]
|
167
|
+
#
|
168
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
169
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
170
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
171
|
+
def get_project_location_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
172
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
173
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
|
174
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
|
175
|
+
command.params['name'] = name unless name.nil?
|
176
|
+
command.query['fields'] = fields unless fields.nil?
|
177
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
178
|
+
execute_or_queue_command(command, &block)
|
179
|
+
end
|
180
|
+
|
181
|
+
# Gets the latest agent validation result. Agent validation is performed when
|
182
|
+
# ValidateAgent is called.
|
183
|
+
# @param [String] name
|
184
|
+
# Required. The agent name. Format: `projects//locations//agents//
|
185
|
+
# validationResult`.
|
186
|
+
# @param [String] language_code
|
187
|
+
# If not specified, the agent's default language is used.
|
188
|
+
# @param [String] fields
|
189
|
+
# Selector specifying which fields to include in a partial response.
|
190
|
+
# @param [String] quota_user
|
191
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
192
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
193
|
+
# @param [Google::Apis::RequestOptions] options
|
194
|
+
# Request-specific options
|
195
|
+
#
|
196
|
+
# @yield [result, err] Result & error if block supplied
|
197
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult] parsed result object
|
198
|
+
# @yieldparam err [StandardError] error object if request failed
|
199
|
+
#
|
200
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult]
|
201
|
+
#
|
202
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
203
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
204
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
205
|
+
def get_project_location_agent_validation_result(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
206
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
207
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult::Representation
|
208
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult
|
209
|
+
command.params['name'] = name unless name.nil?
|
210
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
211
|
+
command.query['fields'] = fields unless fields.nil?
|
212
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
213
|
+
execute_or_queue_command(command, &block)
|
214
|
+
end
|
215
|
+
|
216
|
+
# Returns the list of all agents in the specified location.
|
217
|
+
# @param [String] parent
|
218
|
+
# Required. The location to list all agents for. Format: `projects//locations/`.
|
219
|
+
# @param [Fixnum] page_size
|
220
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
221
|
+
# most 1000.
|
222
|
+
# @param [String] page_token
|
223
|
+
# The next_page_token value returned from a previous list request.
|
224
|
+
# @param [String] fields
|
225
|
+
# Selector specifying which fields to include in a partial response.
|
226
|
+
# @param [String] quota_user
|
227
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
228
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
229
|
+
# @param [Google::Apis::RequestOptions] options
|
230
|
+
# Request-specific options
|
231
|
+
#
|
232
|
+
# @yield [result, err] Result & error if block supplied
|
233
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListAgentsResponse] parsed result object
|
234
|
+
# @yieldparam err [StandardError] error object if request failed
|
235
|
+
#
|
236
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListAgentsResponse]
|
237
|
+
#
|
238
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
239
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
240
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
241
|
+
def list_project_location_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
242
|
+
command = make_simple_command(:get, 'v3/{+parent}/agents', options)
|
243
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListAgentsResponse::Representation
|
244
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListAgentsResponse
|
245
|
+
command.params['parent'] = parent unless parent.nil?
|
246
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
247
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
248
|
+
command.query['fields'] = fields unless fields.nil?
|
249
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
250
|
+
execute_or_queue_command(command, &block)
|
251
|
+
end
|
252
|
+
|
253
|
+
# Updates the specified agent.
|
254
|
+
# @param [String] name
|
255
|
+
# The unique identifier of the agent. Required for the Agents.UpdateAgent method.
|
256
|
+
# Agents.CreateAgent populates the name automatically. Format: `projects//
|
257
|
+
# locations//agents/`.
|
258
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent] google_cloud_dialogflow_cx_v3_agent_object
|
259
|
+
# @param [String] update_mask
|
260
|
+
# The mask to control which fields get updated. If the mask is not present, all
|
261
|
+
# fields will be updated.
|
262
|
+
# @param [String] fields
|
263
|
+
# Selector specifying which fields to include in a partial response.
|
264
|
+
# @param [String] quota_user
|
265
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
266
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
267
|
+
# @param [Google::Apis::RequestOptions] options
|
268
|
+
# Request-specific options
|
269
|
+
#
|
270
|
+
# @yield [result, err] Result & error if block supplied
|
271
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent] parsed result object
|
272
|
+
# @yieldparam err [StandardError] error object if request failed
|
273
|
+
#
|
274
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent]
|
275
|
+
#
|
276
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
277
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
278
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
279
|
+
def patch_project_location_agent(name, google_cloud_dialogflow_cx_v3_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
280
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
281
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
|
282
|
+
command.request_object = google_cloud_dialogflow_cx_v3_agent_object
|
283
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
|
284
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
|
285
|
+
command.params['name'] = name unless name.nil?
|
286
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
287
|
+
command.query['fields'] = fields unless fields.nil?
|
288
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
289
|
+
execute_or_queue_command(command, &block)
|
290
|
+
end
|
291
|
+
|
292
|
+
# Restores the specified agent from a binary file. Replaces the current agent
|
293
|
+
# with a new one. Note that all existing resources in agent (e.g. intents,
|
294
|
+
# entity types, flows) will be removed.
|
295
|
+
# @param [String] name
|
296
|
+
# Required. The name of the agent to restore into. Format: `projects//locations//
|
297
|
+
# agents/`.
|
298
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RestoreAgentRequest] google_cloud_dialogflow_cx_v3_restore_agent_request_object
|
299
|
+
# @param [String] fields
|
300
|
+
# Selector specifying which fields to include in a partial response.
|
301
|
+
# @param [String] quota_user
|
302
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
303
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
304
|
+
# @param [Google::Apis::RequestOptions] options
|
305
|
+
# Request-specific options
|
306
|
+
#
|
307
|
+
# @yield [result, err] Result & error if block supplied
|
308
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
309
|
+
# @yieldparam err [StandardError] error object if request failed
|
310
|
+
#
|
311
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
312
|
+
#
|
313
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
314
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
315
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
316
|
+
def restore_project_location_agent(name, google_cloud_dialogflow_cx_v3_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
317
|
+
command = make_simple_command(:post, 'v3/{+name}:restore', options)
|
318
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RestoreAgentRequest::Representation
|
319
|
+
command.request_object = google_cloud_dialogflow_cx_v3_restore_agent_request_object
|
320
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
321
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
322
|
+
command.params['name'] = name unless name.nil?
|
323
|
+
command.query['fields'] = fields unless fields.nil?
|
324
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
325
|
+
execute_or_queue_command(command, &block)
|
326
|
+
end
|
327
|
+
|
328
|
+
# Validates the specified agent and creates or updates validation results. The
|
329
|
+
# agent in draft version is validated. Please call this API after the training
|
330
|
+
# is completed to get the complete validation results.
|
331
|
+
# @param [String] name
|
332
|
+
# Required. The agent to validate. Format: `projects//locations//agents/`.
|
333
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateAgentRequest] google_cloud_dialogflow_cx_v3_validate_agent_request_object
|
334
|
+
# @param [String] fields
|
335
|
+
# Selector specifying which fields to include in a partial response.
|
336
|
+
# @param [String] quota_user
|
337
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
338
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
339
|
+
# @param [Google::Apis::RequestOptions] options
|
340
|
+
# Request-specific options
|
341
|
+
#
|
342
|
+
# @yield [result, err] Result & error if block supplied
|
343
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult] parsed result object
|
344
|
+
# @yieldparam err [StandardError] error object if request failed
|
345
|
+
#
|
346
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult]
|
347
|
+
#
|
348
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
349
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
350
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
351
|
+
def validate_project_location_agent(name, google_cloud_dialogflow_cx_v3_validate_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
352
|
+
command = make_simple_command(:post, 'v3/{+name}:validate', options)
|
353
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateAgentRequest::Representation
|
354
|
+
command.request_object = google_cloud_dialogflow_cx_v3_validate_agent_request_object
|
355
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult::Representation
|
356
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult
|
357
|
+
command.params['name'] = name unless name.nil?
|
358
|
+
command.query['fields'] = fields unless fields.nil?
|
359
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
360
|
+
execute_or_queue_command(command, &block)
|
361
|
+
end
|
362
|
+
|
363
|
+
# Creates an entity type in the specified agent.
|
364
|
+
# @param [String] parent
|
365
|
+
# Required. The agent to create a entity type for. Format: `projects//locations//
|
366
|
+
# agents/`.
|
367
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType] google_cloud_dialogflow_cx_v3_entity_type_object
|
368
|
+
# @param [String] language_code
|
369
|
+
# The language of the following fields in `entity_type`: * `EntityType.entities.
|
370
|
+
# value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value`
|
371
|
+
# If not specified, the agent's default language is used. [Many languages](https:
|
372
|
+
# //cloud.google.com/dialogflow/docs/reference/language) are supported. Note:
|
373
|
+
# languages must be enabled in the agent before they can be used.
|
374
|
+
# @param [String] fields
|
375
|
+
# Selector specifying which fields to include in a partial response.
|
376
|
+
# @param [String] quota_user
|
377
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
378
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
379
|
+
# @param [Google::Apis::RequestOptions] options
|
380
|
+
# Request-specific options
|
381
|
+
#
|
382
|
+
# @yield [result, err] Result & error if block supplied
|
383
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType] parsed result object
|
384
|
+
# @yieldparam err [StandardError] error object if request failed
|
385
|
+
#
|
386
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType]
|
387
|
+
#
|
388
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
389
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
390
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
391
|
+
def create_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
392
|
+
command = make_simple_command(:post, 'v3/{+parent}/entityTypes', options)
|
393
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
|
394
|
+
command.request_object = google_cloud_dialogflow_cx_v3_entity_type_object
|
395
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
|
396
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
|
397
|
+
command.params['parent'] = parent unless parent.nil?
|
398
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
399
|
+
command.query['fields'] = fields unless fields.nil?
|
400
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
401
|
+
execute_or_queue_command(command, &block)
|
402
|
+
end
|
403
|
+
|
404
|
+
# Deletes the specified entity type.
|
405
|
+
# @param [String] name
|
406
|
+
# Required. The name of the entity type to delete. Format: `projects//locations//
|
407
|
+
# agents//entityTypes/`.
|
408
|
+
# @param [Boolean] force
|
409
|
+
# This field has no effect for entity type not being used. For entity types that
|
410
|
+
# are used by intents or pages: * If `force` is set to false, an error will be
|
411
|
+
# returned with message indicating the referencing resources. * If `force` is
|
412
|
+
# set to true, Dialogflow will remove the entity type, as well as any references
|
413
|
+
# to the entity type (i.e. Page parameter of the entity type will be changed to '
|
414
|
+
# @sys.any' and intent parameter of the entity type will be removed).
|
415
|
+
# @param [String] fields
|
416
|
+
# Selector specifying which fields to include in a partial response.
|
417
|
+
# @param [String] quota_user
|
418
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
419
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
420
|
+
# @param [Google::Apis::RequestOptions] options
|
421
|
+
# Request-specific options
|
422
|
+
#
|
423
|
+
# @yield [result, err] Result & error if block supplied
|
424
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
425
|
+
# @yieldparam err [StandardError] error object if request failed
|
426
|
+
#
|
427
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
428
|
+
#
|
429
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
430
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
431
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
432
|
+
def delete_project_location_agent_entity_type(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
|
433
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
434
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
435
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
436
|
+
command.params['name'] = name unless name.nil?
|
437
|
+
command.query['force'] = force unless force.nil?
|
438
|
+
command.query['fields'] = fields unless fields.nil?
|
439
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
440
|
+
execute_or_queue_command(command, &block)
|
441
|
+
end
|
442
|
+
|
443
|
+
# Retrieves the specified entity type.
|
444
|
+
# @param [String] name
|
445
|
+
# Required. The name of the entity type. Format: `projects//locations//agents//
|
446
|
+
# entityTypes/`.
|
447
|
+
# @param [String] language_code
|
448
|
+
# The language to retrieve the entity type for. The following fields are
|
449
|
+
# language dependent: * `EntityType.entities.value` * `EntityType.entities.
|
450
|
+
# synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's
|
451
|
+
# default language is used. [Many languages](https://cloud.google.com/dialogflow/
|
452
|
+
# docs/reference/language) are supported. Note: languages must be enabled in the
|
453
|
+
# agent before they can be used.
|
454
|
+
# @param [String] fields
|
455
|
+
# Selector specifying which fields to include in a partial response.
|
456
|
+
# @param [String] quota_user
|
457
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
458
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
459
|
+
# @param [Google::Apis::RequestOptions] options
|
460
|
+
# Request-specific options
|
461
|
+
#
|
462
|
+
# @yield [result, err] Result & error if block supplied
|
463
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType] parsed result object
|
464
|
+
# @yieldparam err [StandardError] error object if request failed
|
465
|
+
#
|
466
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType]
|
467
|
+
#
|
468
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
469
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
470
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
471
|
+
def get_project_location_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
472
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
473
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
|
474
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
|
475
|
+
command.params['name'] = name unless name.nil?
|
476
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
477
|
+
command.query['fields'] = fields unless fields.nil?
|
478
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
479
|
+
execute_or_queue_command(command, &block)
|
480
|
+
end
|
481
|
+
|
482
|
+
# Returns the list of all entity types in the specified agent.
|
483
|
+
# @param [String] parent
|
484
|
+
# Required. The agent to list all entity types for. Format: `projects//locations/
|
485
|
+
# /agents/`.
|
486
|
+
# @param [String] language_code
|
487
|
+
# The language to list entity types for. The following fields are language
|
488
|
+
# dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `
|
489
|
+
# EntityType.excluded_phrases.value` If not specified, the agent's default
|
490
|
+
# language is used. [Many languages](https://cloud.google.com/dialogflow/docs/
|
491
|
+
# reference/language) are supported. Note: languages must be enabled in the
|
492
|
+
# agent before they can be used.
|
493
|
+
# @param [Fixnum] page_size
|
494
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
495
|
+
# most 1000.
|
496
|
+
# @param [String] page_token
|
497
|
+
# The next_page_token value returned from a previous list request.
|
498
|
+
# @param [String] fields
|
499
|
+
# Selector specifying which fields to include in a partial response.
|
500
|
+
# @param [String] quota_user
|
501
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
502
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
503
|
+
# @param [Google::Apis::RequestOptions] options
|
504
|
+
# Request-specific options
|
505
|
+
#
|
506
|
+
# @yield [result, err] Result & error if block supplied
|
507
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEntityTypesResponse] parsed result object
|
508
|
+
# @yieldparam err [StandardError] error object if request failed
|
509
|
+
#
|
510
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEntityTypesResponse]
|
511
|
+
#
|
512
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
513
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
514
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
515
|
+
def list_project_location_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
516
|
+
command = make_simple_command(:get, 'v3/{+parent}/entityTypes', options)
|
517
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEntityTypesResponse::Representation
|
518
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEntityTypesResponse
|
519
|
+
command.params['parent'] = parent unless parent.nil?
|
520
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
521
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
522
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
523
|
+
command.query['fields'] = fields unless fields.nil?
|
524
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
525
|
+
execute_or_queue_command(command, &block)
|
526
|
+
end
|
527
|
+
|
528
|
+
# Updates the specified entity type.
|
529
|
+
# @param [String] name
|
530
|
+
# The unique identifier of the entity type. Required for EntityTypes.
|
531
|
+
# UpdateEntityType. Format: `projects//locations//agents//entityTypes/`.
|
532
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType] google_cloud_dialogflow_cx_v3_entity_type_object
|
533
|
+
# @param [String] language_code
|
534
|
+
# The language of the following fields in `entity_type`: * `EntityType.entities.
|
535
|
+
# value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value`
|
536
|
+
# If not specified, the agent's default language is used. [Many languages](https:
|
537
|
+
# //cloud.google.com/dialogflow/docs/reference/language) are supported. Note:
|
538
|
+
# languages must be enabled in the agent before they can be used.
|
539
|
+
# @param [String] update_mask
|
540
|
+
# The mask to control which fields get updated.
|
541
|
+
# @param [String] fields
|
542
|
+
# Selector specifying which fields to include in a partial response.
|
543
|
+
# @param [String] quota_user
|
544
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
545
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
546
|
+
# @param [Google::Apis::RequestOptions] options
|
547
|
+
# Request-specific options
|
548
|
+
#
|
549
|
+
# @yield [result, err] Result & error if block supplied
|
550
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType] parsed result object
|
551
|
+
# @yieldparam err [StandardError] error object if request failed
|
552
|
+
#
|
553
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType]
|
554
|
+
#
|
555
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
556
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
557
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
558
|
+
def patch_project_location_agent_entity_type(name, google_cloud_dialogflow_cx_v3_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
559
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
560
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
|
561
|
+
command.request_object = google_cloud_dialogflow_cx_v3_entity_type_object
|
562
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
|
563
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
|
564
|
+
command.params['name'] = name unless name.nil?
|
565
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
566
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
567
|
+
command.query['fields'] = fields unless fields.nil?
|
568
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
569
|
+
execute_or_queue_command(command, &block)
|
570
|
+
end
|
571
|
+
|
572
|
+
# Creates an Environment in the specified Agent.
|
573
|
+
# @param [String] parent
|
574
|
+
# Required. The Agent to create an Environment for. Format: `projects//locations/
|
575
|
+
# /agents/`.
|
576
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment] google_cloud_dialogflow_cx_v3_environment_object
|
577
|
+
# @param [String] fields
|
578
|
+
# Selector specifying which fields to include in a partial response.
|
579
|
+
# @param [String] quota_user
|
580
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
581
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
582
|
+
# @param [Google::Apis::RequestOptions] options
|
583
|
+
# Request-specific options
|
584
|
+
#
|
585
|
+
# @yield [result, err] Result & error if block supplied
|
586
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
587
|
+
# @yieldparam err [StandardError] error object if request failed
|
588
|
+
#
|
589
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
590
|
+
#
|
591
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
592
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
593
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
594
|
+
def create_project_location_agent_environment(parent, google_cloud_dialogflow_cx_v3_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
595
|
+
command = make_simple_command(:post, 'v3/{+parent}/environments', options)
|
596
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment::Representation
|
597
|
+
command.request_object = google_cloud_dialogflow_cx_v3_environment_object
|
598
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
599
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
600
|
+
command.params['parent'] = parent unless parent.nil?
|
601
|
+
command.query['fields'] = fields unless fields.nil?
|
602
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
603
|
+
execute_or_queue_command(command, &block)
|
604
|
+
end
|
605
|
+
|
606
|
+
# Deletes the specified Environment.
|
607
|
+
# @param [String] name
|
608
|
+
# Required. The name of the Environment to delete. Format: `projects//locations//
|
609
|
+
# agents//environments/`.
|
610
|
+
# @param [String] fields
|
611
|
+
# Selector specifying which fields to include in a partial response.
|
612
|
+
# @param [String] quota_user
|
613
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
614
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
615
|
+
# @param [Google::Apis::RequestOptions] options
|
616
|
+
# Request-specific options
|
617
|
+
#
|
618
|
+
# @yield [result, err] Result & error if block supplied
|
619
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
620
|
+
# @yieldparam err [StandardError] error object if request failed
|
621
|
+
#
|
622
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
623
|
+
#
|
624
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
625
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
626
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
627
|
+
def delete_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
|
628
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
629
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
630
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
631
|
+
command.params['name'] = name unless name.nil?
|
632
|
+
command.query['fields'] = fields unless fields.nil?
|
633
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
634
|
+
execute_or_queue_command(command, &block)
|
635
|
+
end
|
636
|
+
|
637
|
+
# Retrieves the specified Environment.
|
638
|
+
# @param [String] name
|
639
|
+
# Required. The name of the Environment. Format: `projects//locations//agents//
|
640
|
+
# environments/`.
|
641
|
+
# @param [String] fields
|
642
|
+
# Selector specifying which fields to include in a partial response.
|
643
|
+
# @param [String] quota_user
|
644
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
645
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
646
|
+
# @param [Google::Apis::RequestOptions] options
|
647
|
+
# Request-specific options
|
648
|
+
#
|
649
|
+
# @yield [result, err] Result & error if block supplied
|
650
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment] parsed result object
|
651
|
+
# @yieldparam err [StandardError] error object if request failed
|
652
|
+
#
|
653
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment]
|
654
|
+
#
|
655
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
656
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
657
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
658
|
+
def get_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
|
659
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
660
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment::Representation
|
661
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment
|
662
|
+
command.params['name'] = name unless name.nil?
|
663
|
+
command.query['fields'] = fields unless fields.nil?
|
664
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
665
|
+
execute_or_queue_command(command, &block)
|
666
|
+
end
|
667
|
+
|
668
|
+
# Returns the list of all environments in the specified Agent.
|
669
|
+
# @param [String] parent
|
670
|
+
# Required. The Agent to list all environments for. Format: `projects//locations/
|
671
|
+
# /agents/`.
|
672
|
+
# @param [Fixnum] page_size
|
673
|
+
# The maximum number of items to return in a single page. By default 20 and at
|
674
|
+
# most 100.
|
675
|
+
# @param [String] page_token
|
676
|
+
# The next_page_token value returned from a previous list request.
|
677
|
+
# @param [String] fields
|
678
|
+
# Selector specifying which fields to include in a partial response.
|
679
|
+
# @param [String] quota_user
|
680
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
681
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
682
|
+
# @param [Google::Apis::RequestOptions] options
|
683
|
+
# Request-specific options
|
684
|
+
#
|
685
|
+
# @yield [result, err] Result & error if block supplied
|
686
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEnvironmentsResponse] parsed result object
|
687
|
+
# @yieldparam err [StandardError] error object if request failed
|
688
|
+
#
|
689
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEnvironmentsResponse]
|
690
|
+
#
|
691
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
692
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
693
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
694
|
+
def list_project_location_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
695
|
+
command = make_simple_command(:get, 'v3/{+parent}/environments', options)
|
696
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEnvironmentsResponse::Representation
|
697
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEnvironmentsResponse
|
698
|
+
command.params['parent'] = parent unless parent.nil?
|
699
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
700
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
701
|
+
command.query['fields'] = fields unless fields.nil?
|
702
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
703
|
+
execute_or_queue_command(command, &block)
|
704
|
+
end
|
705
|
+
|
706
|
+
# Looks up the history of the specified Environment.
|
707
|
+
# @param [String] name
|
708
|
+
# Required. Resource name of the environment to look up the history for. Format:
|
709
|
+
# `projects//locations//agents//environments/`.
|
710
|
+
# @param [Fixnum] page_size
|
711
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
712
|
+
# most 1000.
|
713
|
+
# @param [String] page_token
|
714
|
+
# The next_page_token value returned from a previous list request.
|
715
|
+
# @param [String] fields
|
716
|
+
# Selector specifying which fields to include in a partial response.
|
717
|
+
# @param [String] quota_user
|
718
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
719
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
720
|
+
# @param [Google::Apis::RequestOptions] options
|
721
|
+
# Request-specific options
|
722
|
+
#
|
723
|
+
# @yield [result, err] Result & error if block supplied
|
724
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse] parsed result object
|
725
|
+
# @yieldparam err [StandardError] error object if request failed
|
726
|
+
#
|
727
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse]
|
728
|
+
#
|
729
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
730
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
731
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
732
|
+
def lookup_project_location_agent_environment_environment_history(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
733
|
+
command = make_simple_command(:get, 'v3/{+name}:lookupEnvironmentHistory', options)
|
734
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse::Representation
|
735
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse
|
736
|
+
command.params['name'] = name unless name.nil?
|
737
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
738
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
739
|
+
command.query['fields'] = fields unless fields.nil?
|
740
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
741
|
+
execute_or_queue_command(command, &block)
|
742
|
+
end
|
743
|
+
|
744
|
+
# Updates the specified Environment.
|
745
|
+
# @param [String] name
|
746
|
+
# The name of the environment. Format: `projects//locations//agents//
|
747
|
+
# environments/`.
|
748
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment] google_cloud_dialogflow_cx_v3_environment_object
|
749
|
+
# @param [String] update_mask
|
750
|
+
# Required. The mask to control which fields get updated.
|
751
|
+
# @param [String] fields
|
752
|
+
# Selector specifying which fields to include in a partial response.
|
753
|
+
# @param [String] quota_user
|
754
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
755
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
756
|
+
# @param [Google::Apis::RequestOptions] options
|
757
|
+
# Request-specific options
|
758
|
+
#
|
759
|
+
# @yield [result, err] Result & error if block supplied
|
760
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
761
|
+
# @yieldparam err [StandardError] error object if request failed
|
762
|
+
#
|
763
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
764
|
+
#
|
765
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
766
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
767
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
768
|
+
def patch_project_location_agent_environment(name, google_cloud_dialogflow_cx_v3_environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
769
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
770
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment::Representation
|
771
|
+
command.request_object = google_cloud_dialogflow_cx_v3_environment_object
|
772
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
773
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
774
|
+
command.params['name'] = name unless name.nil?
|
775
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
776
|
+
command.query['fields'] = fields unless fields.nil?
|
777
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
778
|
+
execute_or_queue_command(command, &block)
|
779
|
+
end
|
780
|
+
|
781
|
+
# Creates an Experiment in the specified Environment.
|
782
|
+
# @param [String] parent
|
783
|
+
# Required. The Agent to create an Environment for. Format: `projects//locations/
|
784
|
+
# /agents//environments/`.
|
785
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] google_cloud_dialogflow_cx_v3_experiment_object
|
786
|
+
# @param [String] fields
|
787
|
+
# Selector specifying which fields to include in a partial response.
|
788
|
+
# @param [String] quota_user
|
789
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
790
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
791
|
+
# @param [Google::Apis::RequestOptions] options
|
792
|
+
# Request-specific options
|
793
|
+
#
|
794
|
+
# @yield [result, err] Result & error if block supplied
|
795
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] parsed result object
|
796
|
+
# @yieldparam err [StandardError] error object if request failed
|
797
|
+
#
|
798
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment]
|
799
|
+
#
|
800
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
801
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
802
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
803
|
+
def create_project_location_agent_environment_experiment(parent, google_cloud_dialogflow_cx_v3_experiment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
804
|
+
command = make_simple_command(:post, 'v3/{+parent}/experiments', options)
|
805
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
|
806
|
+
command.request_object = google_cloud_dialogflow_cx_v3_experiment_object
|
807
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
|
808
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
|
809
|
+
command.params['parent'] = parent unless parent.nil?
|
810
|
+
command.query['fields'] = fields unless fields.nil?
|
811
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
812
|
+
execute_or_queue_command(command, &block)
|
813
|
+
end
|
814
|
+
|
815
|
+
# Deletes the specified Experiment.
|
816
|
+
# @param [String] name
|
817
|
+
# Required. The name of the Environment to delete. Format: `projects//locations//
|
818
|
+
# agents//environments//experiments/`.
|
819
|
+
# @param [String] fields
|
820
|
+
# Selector specifying which fields to include in a partial response.
|
821
|
+
# @param [String] quota_user
|
822
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
823
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
824
|
+
# @param [Google::Apis::RequestOptions] options
|
825
|
+
# Request-specific options
|
826
|
+
#
|
827
|
+
# @yield [result, err] Result & error if block supplied
|
828
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
829
|
+
# @yieldparam err [StandardError] error object if request failed
|
830
|
+
#
|
831
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
832
|
+
#
|
833
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
834
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
835
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
836
|
+
def delete_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
|
837
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
838
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
839
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
840
|
+
command.params['name'] = name unless name.nil?
|
841
|
+
command.query['fields'] = fields unless fields.nil?
|
842
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
843
|
+
execute_or_queue_command(command, &block)
|
844
|
+
end
|
845
|
+
|
846
|
+
# Retrieves the specified Experiment.
|
847
|
+
# @param [String] name
|
848
|
+
# Required. The name of the Environment. Format: `projects//locations//agents//
|
849
|
+
# environments//experiments/`.
|
850
|
+
# @param [String] fields
|
851
|
+
# Selector specifying which fields to include in a partial response.
|
852
|
+
# @param [String] quota_user
|
853
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
854
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
855
|
+
# @param [Google::Apis::RequestOptions] options
|
856
|
+
# Request-specific options
|
857
|
+
#
|
858
|
+
# @yield [result, err] Result & error if block supplied
|
859
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] parsed result object
|
860
|
+
# @yieldparam err [StandardError] error object if request failed
|
861
|
+
#
|
862
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment]
|
863
|
+
#
|
864
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
865
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
866
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
867
|
+
def get_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
|
868
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
869
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
|
870
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
|
871
|
+
command.params['name'] = name unless name.nil?
|
872
|
+
command.query['fields'] = fields unless fields.nil?
|
873
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
874
|
+
execute_or_queue_command(command, &block)
|
875
|
+
end
|
876
|
+
|
877
|
+
# Returns the list of all experiments in the specified Environment.
|
878
|
+
# @param [String] parent
|
879
|
+
# Required. The Environment to list all environments for. Format: `projects//
|
880
|
+
# locations//agents//environments/`.
|
881
|
+
# @param [Fixnum] page_size
|
882
|
+
# The maximum number of items to return in a single page. By default 20 and at
|
883
|
+
# most 100.
|
884
|
+
# @param [String] page_token
|
885
|
+
# The next_page_token value returned from a previous list request.
|
886
|
+
# @param [String] fields
|
887
|
+
# Selector specifying which fields to include in a partial response.
|
888
|
+
# @param [String] quota_user
|
889
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
890
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
891
|
+
# @param [Google::Apis::RequestOptions] options
|
892
|
+
# Request-specific options
|
893
|
+
#
|
894
|
+
# @yield [result, err] Result & error if block supplied
|
895
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListExperimentsResponse] parsed result object
|
896
|
+
# @yieldparam err [StandardError] error object if request failed
|
897
|
+
#
|
898
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListExperimentsResponse]
|
899
|
+
#
|
900
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
901
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
902
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
903
|
+
def list_project_location_agent_environment_experiments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
904
|
+
command = make_simple_command(:get, 'v3/{+parent}/experiments', options)
|
905
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListExperimentsResponse::Representation
|
906
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListExperimentsResponse
|
907
|
+
command.params['parent'] = parent unless parent.nil?
|
908
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
909
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
910
|
+
command.query['fields'] = fields unless fields.nil?
|
911
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
912
|
+
execute_or_queue_command(command, &block)
|
913
|
+
end
|
914
|
+
|
915
|
+
# Updates the specified Experiment.
|
916
|
+
# @param [String] name
|
917
|
+
# The name of the experiment. Format: projects//locations//agents//environments//
|
918
|
+
# experiments/..
|
919
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] google_cloud_dialogflow_cx_v3_experiment_object
|
920
|
+
# @param [String] update_mask
|
921
|
+
# Required. The mask to control which fields get updated.
|
922
|
+
# @param [String] fields
|
923
|
+
# Selector specifying which fields to include in a partial response.
|
924
|
+
# @param [String] quota_user
|
925
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
926
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
927
|
+
# @param [Google::Apis::RequestOptions] options
|
928
|
+
# Request-specific options
|
929
|
+
#
|
930
|
+
# @yield [result, err] Result & error if block supplied
|
931
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] parsed result object
|
932
|
+
# @yieldparam err [StandardError] error object if request failed
|
933
|
+
#
|
934
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment]
|
935
|
+
#
|
936
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
937
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
938
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
939
|
+
def patch_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
940
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
941
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
|
942
|
+
command.request_object = google_cloud_dialogflow_cx_v3_experiment_object
|
943
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
|
944
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
|
945
|
+
command.params['name'] = name unless name.nil?
|
946
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
947
|
+
command.query['fields'] = fields unless fields.nil?
|
948
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
949
|
+
execute_or_queue_command(command, &block)
|
950
|
+
end
|
951
|
+
|
952
|
+
# Starts the specified Experiment. This rpc only changes the state of experiment
|
953
|
+
# from PENDING to RUNNING.
|
954
|
+
# @param [String] name
|
955
|
+
# Required. Resource name of the experiment to start. Format: `projects//
|
956
|
+
# locations//agents//environments//experiments/`.
|
957
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StartExperimentRequest] google_cloud_dialogflow_cx_v3_start_experiment_request_object
|
958
|
+
# @param [String] fields
|
959
|
+
# Selector specifying which fields to include in a partial response.
|
960
|
+
# @param [String] quota_user
|
961
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
962
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
963
|
+
# @param [Google::Apis::RequestOptions] options
|
964
|
+
# Request-specific options
|
965
|
+
#
|
966
|
+
# @yield [result, err] Result & error if block supplied
|
967
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] parsed result object
|
968
|
+
# @yieldparam err [StandardError] error object if request failed
|
969
|
+
#
|
970
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment]
|
971
|
+
#
|
972
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
973
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
974
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
975
|
+
def start_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3_start_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
976
|
+
command = make_simple_command(:post, 'v3/{+name}:start', options)
|
977
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StartExperimentRequest::Representation
|
978
|
+
command.request_object = google_cloud_dialogflow_cx_v3_start_experiment_request_object
|
979
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
|
980
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
|
981
|
+
command.params['name'] = name unless name.nil?
|
982
|
+
command.query['fields'] = fields unless fields.nil?
|
983
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
984
|
+
execute_or_queue_command(command, &block)
|
985
|
+
end
|
986
|
+
|
987
|
+
# Stops the specified Experiment. This rpc only changes the state of experiment
|
988
|
+
# from RUNNING to DONE.
|
989
|
+
# @param [String] name
|
990
|
+
# Required. Resource name of the experiment to stop. Format: `projects//
|
991
|
+
# locations//agents//environments//experiments/`.
|
992
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StopExperimentRequest] google_cloud_dialogflow_cx_v3_stop_experiment_request_object
|
993
|
+
# @param [String] fields
|
994
|
+
# Selector specifying which fields to include in a partial response.
|
995
|
+
# @param [String] quota_user
|
996
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
997
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
998
|
+
# @param [Google::Apis::RequestOptions] options
|
999
|
+
# Request-specific options
|
1000
|
+
#
|
1001
|
+
# @yield [result, err] Result & error if block supplied
|
1002
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment] parsed result object
|
1003
|
+
# @yieldparam err [StandardError] error object if request failed
|
1004
|
+
#
|
1005
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment]
|
1006
|
+
#
|
1007
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1008
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1009
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1010
|
+
def stop_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3_stop_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1011
|
+
command = make_simple_command(:post, 'v3/{+name}:stop', options)
|
1012
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StopExperimentRequest::Representation
|
1013
|
+
command.request_object = google_cloud_dialogflow_cx_v3_stop_experiment_request_object
|
1014
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
|
1015
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
|
1016
|
+
command.params['name'] = name unless name.nil?
|
1017
|
+
command.query['fields'] = fields unless fields.nil?
|
1018
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1019
|
+
execute_or_queue_command(command, &block)
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
# Processes a natural language query and returns structured, actionable data as
|
1023
|
+
# a result. This method is not idempotent, because it may cause session entity
|
1024
|
+
# types to be updated, which in turn might affect results of future queries.
|
1025
|
+
# Note: Always use agent versions for production traffic. See [Versions and
|
1026
|
+
# environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
|
1027
|
+
# @param [String] session
|
1028
|
+
# Required. The name of the session this query is sent to. Format: `projects//
|
1029
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
1030
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
1031
|
+
# environment. It's up to the API caller to choose an appropriate `Session ID`.
|
1032
|
+
# It can be a random number or some type of session identifiers (preferably
|
1033
|
+
# hashed). The length of the `Session ID` must not exceed 36 characters. For
|
1034
|
+
# more information, see the [sessions guide](https://cloud.google.com/dialogflow/
|
1035
|
+
# cx/docs/concept/session). Note: Always use agent versions for production
|
1036
|
+
# traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
|
1037
|
+
# cx/docs/concept/version).
|
1038
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest] google_cloud_dialogflow_cx_v3_detect_intent_request_object
|
1039
|
+
# @param [String] fields
|
1040
|
+
# Selector specifying which fields to include in a partial response.
|
1041
|
+
# @param [String] quota_user
|
1042
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1043
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1044
|
+
# @param [Google::Apis::RequestOptions] options
|
1045
|
+
# Request-specific options
|
1046
|
+
#
|
1047
|
+
# @yield [result, err] Result & error if block supplied
|
1048
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse] parsed result object
|
1049
|
+
# @yieldparam err [StandardError] error object if request failed
|
1050
|
+
#
|
1051
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse]
|
1052
|
+
#
|
1053
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1054
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1055
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1056
|
+
def detect_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1057
|
+
command = make_simple_command(:post, 'v3/{+session}:detectIntent', options)
|
1058
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest::Representation
|
1059
|
+
command.request_object = google_cloud_dialogflow_cx_v3_detect_intent_request_object
|
1060
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse::Representation
|
1061
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse
|
1062
|
+
command.params['session'] = session unless session.nil?
|
1063
|
+
command.query['fields'] = fields unless fields.nil?
|
1064
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1065
|
+
execute_or_queue_command(command, &block)
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# Fulfills a matched intent returned by MatchIntent. Must be called after
|
1069
|
+
# MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is
|
1070
|
+
# undefined.
|
1071
|
+
# @param [String] session
|
1072
|
+
# Required. The name of the session this query is sent to. Format: `projects//
|
1073
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
1074
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
1075
|
+
# environment. It's up to the API caller to choose an appropriate `Session ID`.
|
1076
|
+
# It can be a random number or some type of session identifiers (preferably
|
1077
|
+
# hashed). The length of the `Session ID` must not exceed 36 characters. For
|
1078
|
+
# more information, see the [sessions guide](https://cloud.google.com/dialogflow/
|
1079
|
+
# cx/docs/concept/session).
|
1080
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest] google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
|
1081
|
+
# @param [String] fields
|
1082
|
+
# Selector specifying which fields to include in a partial response.
|
1083
|
+
# @param [String] quota_user
|
1084
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1085
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1086
|
+
# @param [Google::Apis::RequestOptions] options
|
1087
|
+
# Request-specific options
|
1088
|
+
#
|
1089
|
+
# @yield [result, err] Result & error if block supplied
|
1090
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse] parsed result object
|
1091
|
+
# @yieldparam err [StandardError] error object if request failed
|
1092
|
+
#
|
1093
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse]
|
1094
|
+
#
|
1095
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1096
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1097
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1098
|
+
def fulfill_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1099
|
+
command = make_simple_command(:post, 'v3/{+session}:fulfillIntent', options)
|
1100
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest::Representation
|
1101
|
+
command.request_object = google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
|
1102
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse::Representation
|
1103
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse
|
1104
|
+
command.params['session'] = session unless session.nil?
|
1105
|
+
command.query['fields'] = fields unless fields.nil?
|
1106
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1107
|
+
execute_or_queue_command(command, &block)
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
# Returns preliminary intent match results, doesn't change the session status.
|
1111
|
+
# @param [String] session
|
1112
|
+
# Required. The name of the session this query is sent to. Format: `projects//
|
1113
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
1114
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
1115
|
+
# environment. It's up to the API caller to choose an appropriate `Session ID`.
|
1116
|
+
# It can be a random number or some type of session identifiers (preferably
|
1117
|
+
# hashed). The length of the `Session ID` must not exceed 36 characters. For
|
1118
|
+
# more information, see the [sessions guide](https://cloud.google.com/dialogflow/
|
1119
|
+
# cx/docs/concept/session).
|
1120
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest] google_cloud_dialogflow_cx_v3_match_intent_request_object
|
1121
|
+
# @param [String] fields
|
1122
|
+
# Selector specifying which fields to include in a partial response.
|
1123
|
+
# @param [String] quota_user
|
1124
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1125
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1126
|
+
# @param [Google::Apis::RequestOptions] options
|
1127
|
+
# Request-specific options
|
1128
|
+
#
|
1129
|
+
# @yield [result, err] Result & error if block supplied
|
1130
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse] parsed result object
|
1131
|
+
# @yieldparam err [StandardError] error object if request failed
|
1132
|
+
#
|
1133
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse]
|
1134
|
+
#
|
1135
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1136
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1137
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1138
|
+
def match_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1139
|
+
command = make_simple_command(:post, 'v3/{+session}:matchIntent', options)
|
1140
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest::Representation
|
1141
|
+
command.request_object = google_cloud_dialogflow_cx_v3_match_intent_request_object
|
1142
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse::Representation
|
1143
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse
|
1144
|
+
command.params['session'] = session unless session.nil?
|
1145
|
+
command.query['fields'] = fields unless fields.nil?
|
1146
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1147
|
+
execute_or_queue_command(command, &block)
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# Creates a session entity type. If the specified session entity type already
|
1151
|
+
# exists, overrides the session entity type.
|
1152
|
+
# @param [String] parent
|
1153
|
+
# Required. The session to create a session entity type for. Format: `projects//
|
1154
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
1155
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
1156
|
+
# environment.
|
1157
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
|
1158
|
+
# @param [String] fields
|
1159
|
+
# Selector specifying which fields to include in a partial response.
|
1160
|
+
# @param [String] quota_user
|
1161
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1162
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1163
|
+
# @param [Google::Apis::RequestOptions] options
|
1164
|
+
# Request-specific options
|
1165
|
+
#
|
1166
|
+
# @yield [result, err] Result & error if block supplied
|
1167
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] parsed result object
|
1168
|
+
# @yieldparam err [StandardError] error object if request failed
|
1169
|
+
#
|
1170
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType]
|
1171
|
+
#
|
1172
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1173
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1174
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1175
|
+
def create_project_location_agent_environment_session_entity_type(parent, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1176
|
+
command = make_simple_command(:post, 'v3/{+parent}/entityTypes', options)
|
1177
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
1178
|
+
command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
|
1179
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
1180
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
|
1181
|
+
command.params['parent'] = parent unless parent.nil?
|
1182
|
+
command.query['fields'] = fields unless fields.nil?
|
1183
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1184
|
+
execute_or_queue_command(command, &block)
|
1185
|
+
end
|
1186
|
+
|
1187
|
+
# Deletes the specified session entity type.
|
1188
|
+
# @param [String] name
|
1189
|
+
# Required. The name of the session entity type to delete. Format: `projects//
|
1190
|
+
# locations//agents//sessions//entityTypes/` or `projects//locations//agents//
|
1191
|
+
# environments//sessions//entityTypes/`. If `Environment ID` is not specified,
|
1192
|
+
# we assume default 'draft' environment.
|
1193
|
+
# @param [String] fields
|
1194
|
+
# Selector specifying which fields to include in a partial response.
|
1195
|
+
# @param [String] quota_user
|
1196
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1197
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1198
|
+
# @param [Google::Apis::RequestOptions] options
|
1199
|
+
# Request-specific options
|
1200
|
+
#
|
1201
|
+
# @yield [result, err] Result & error if block supplied
|
1202
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
1203
|
+
# @yieldparam err [StandardError] error object if request failed
|
1204
|
+
#
|
1205
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
1206
|
+
#
|
1207
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1208
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1209
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1210
|
+
def delete_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
|
1211
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
1212
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
1213
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
1214
|
+
command.params['name'] = name unless name.nil?
|
1215
|
+
command.query['fields'] = fields unless fields.nil?
|
1216
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1217
|
+
execute_or_queue_command(command, &block)
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
# Retrieves the specified session entity type.
|
1221
|
+
# @param [String] name
|
1222
|
+
# Required. The name of the session entity type. Format: `projects//locations//
|
1223
|
+
# agents//sessions//entityTypes/` or `projects//locations//agents//environments//
|
1224
|
+
# sessions//entityTypes/`. If `Environment ID` is not specified, we assume
|
1225
|
+
# default 'draft' environment.
|
1226
|
+
# @param [String] fields
|
1227
|
+
# Selector specifying which fields to include in a partial response.
|
1228
|
+
# @param [String] quota_user
|
1229
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1230
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1231
|
+
# @param [Google::Apis::RequestOptions] options
|
1232
|
+
# Request-specific options
|
1233
|
+
#
|
1234
|
+
# @yield [result, err] Result & error if block supplied
|
1235
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] parsed result object
|
1236
|
+
# @yieldparam err [StandardError] error object if request failed
|
1237
|
+
#
|
1238
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType]
|
1239
|
+
#
|
1240
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1241
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1242
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1243
|
+
def get_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
|
1244
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
1245
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
1246
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
|
1247
|
+
command.params['name'] = name unless name.nil?
|
1248
|
+
command.query['fields'] = fields unless fields.nil?
|
1249
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1250
|
+
execute_or_queue_command(command, &block)
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# Returns the list of all session entity types in the specified session.
|
1254
|
+
# @param [String] parent
|
1255
|
+
# Required. The session to list all session entity types from. Format: `projects/
|
1256
|
+
# /locations//agents//sessions/` or `projects//locations//agents//environments//
|
1257
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
1258
|
+
# environment.
|
1259
|
+
# @param [Fixnum] page_size
|
1260
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
1261
|
+
# most 1000.
|
1262
|
+
# @param [String] page_token
|
1263
|
+
# The next_page_token value returned from a previous list request.
|
1264
|
+
# @param [String] fields
|
1265
|
+
# Selector specifying which fields to include in a partial response.
|
1266
|
+
# @param [String] quota_user
|
1267
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1268
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1269
|
+
# @param [Google::Apis::RequestOptions] options
|
1270
|
+
# Request-specific options
|
1271
|
+
#
|
1272
|
+
# @yield [result, err] Result & error if block supplied
|
1273
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse] parsed result object
|
1274
|
+
# @yieldparam err [StandardError] error object if request failed
|
1275
|
+
#
|
1276
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse]
|
1277
|
+
#
|
1278
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1279
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1280
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1281
|
+
def list_project_location_agent_environment_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1282
|
+
command = make_simple_command(:get, 'v3/{+parent}/entityTypes', options)
|
1283
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse::Representation
|
1284
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse
|
1285
|
+
command.params['parent'] = parent unless parent.nil?
|
1286
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1287
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1288
|
+
command.query['fields'] = fields unless fields.nil?
|
1289
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1290
|
+
execute_or_queue_command(command, &block)
|
1291
|
+
end
|
1292
|
+
|
1293
|
+
# Updates the specified session entity type.
|
1294
|
+
# @param [String] name
|
1295
|
+
# Required. The unique identifier of the session entity type. Format: `projects//
|
1296
|
+
# locations//agents//sessions//entityTypes/` or `projects//locations//agents//
|
1297
|
+
# environments//sessions//entityTypes/`. If `Environment ID` is not specified,
|
1298
|
+
# we assume default 'draft' environment.
|
1299
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
|
1300
|
+
# @param [String] update_mask
|
1301
|
+
# The mask to control which fields get updated.
|
1302
|
+
# @param [String] fields
|
1303
|
+
# Selector specifying which fields to include in a partial response.
|
1304
|
+
# @param [String] quota_user
|
1305
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1306
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1307
|
+
# @param [Google::Apis::RequestOptions] options
|
1308
|
+
# Request-specific options
|
1309
|
+
#
|
1310
|
+
# @yield [result, err] Result & error if block supplied
|
1311
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] parsed result object
|
1312
|
+
# @yieldparam err [StandardError] error object if request failed
|
1313
|
+
#
|
1314
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType]
|
1315
|
+
#
|
1316
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1317
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1318
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1319
|
+
def patch_project_location_agent_environment_session_entity_type(name, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1320
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
1321
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
1322
|
+
command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
|
1323
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
1324
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
|
1325
|
+
command.params['name'] = name unless name.nil?
|
1326
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1327
|
+
command.query['fields'] = fields unless fields.nil?
|
1328
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1329
|
+
execute_or_queue_command(command, &block)
|
1330
|
+
end
|
1331
|
+
|
1332
|
+
# Creates a flow in the specified agent.
|
1333
|
+
# @param [String] parent
|
1334
|
+
# Required. The agent to create a flow for. Format: `projects//locations//agents/
|
1335
|
+
# `.
|
1336
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow] google_cloud_dialogflow_cx_v3_flow_object
|
1337
|
+
# @param [String] language_code
|
1338
|
+
# The language of the following fields in `flow`: * `Flow.event_handlers.
|
1339
|
+
# trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.
|
1340
|
+
# messages` If not specified, the agent's default language is used. [Many
|
1341
|
+
# languages](https://cloud.google.com/dialogflow/docs/reference/language) are
|
1342
|
+
# supported. Note: languages must be enabled in the agent before they can be
|
1343
|
+
# used.
|
1344
|
+
# @param [String] fields
|
1345
|
+
# Selector specifying which fields to include in a partial response.
|
1346
|
+
# @param [String] quota_user
|
1347
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1348
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1349
|
+
# @param [Google::Apis::RequestOptions] options
|
1350
|
+
# Request-specific options
|
1351
|
+
#
|
1352
|
+
# @yield [result, err] Result & error if block supplied
|
1353
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow] parsed result object
|
1354
|
+
# @yieldparam err [StandardError] error object if request failed
|
1355
|
+
#
|
1356
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow]
|
1357
|
+
#
|
1358
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1359
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1360
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1361
|
+
def create_project_location_agent_flow(parent, google_cloud_dialogflow_cx_v3_flow_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1362
|
+
command = make_simple_command(:post, 'v3/{+parent}/flows', options)
|
1363
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
|
1364
|
+
command.request_object = google_cloud_dialogflow_cx_v3_flow_object
|
1365
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
|
1366
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
|
1367
|
+
command.params['parent'] = parent unless parent.nil?
|
1368
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1369
|
+
command.query['fields'] = fields unless fields.nil?
|
1370
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1371
|
+
execute_or_queue_command(command, &block)
|
1372
|
+
end
|
1373
|
+
|
1374
|
+
# Deletes a specified flow.
|
1375
|
+
# @param [String] name
|
1376
|
+
# Required. The name of the flow to delete. Format: `projects//locations//agents/
|
1377
|
+
# /flows/`.
|
1378
|
+
# @param [Boolean] force
|
1379
|
+
# This field has no effect for flows with no incoming transitions. For flows
|
1380
|
+
# with incoming transitions: * If `force` is set to false, an error will be
|
1381
|
+
# returned with message indicating the incoming transitions. * If `force` is set
|
1382
|
+
# to true, Dialogflow will remove the flow, as well as any transitions to the
|
1383
|
+
# flow (i.e. Target flow in event handlers or Target flow in transition routes
|
1384
|
+
# that point to this flow will be cleared).
|
1385
|
+
# @param [String] fields
|
1386
|
+
# Selector specifying which fields to include in a partial response.
|
1387
|
+
# @param [String] quota_user
|
1388
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1389
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1390
|
+
# @param [Google::Apis::RequestOptions] options
|
1391
|
+
# Request-specific options
|
1392
|
+
#
|
1393
|
+
# @yield [result, err] Result & error if block supplied
|
1394
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
1395
|
+
# @yieldparam err [StandardError] error object if request failed
|
1396
|
+
#
|
1397
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
1398
|
+
#
|
1399
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1400
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1401
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1402
|
+
def delete_project_location_agent_flow(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1403
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
1404
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
1405
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
1406
|
+
command.params['name'] = name unless name.nil?
|
1407
|
+
command.query['force'] = force unless force.nil?
|
1408
|
+
command.query['fields'] = fields unless fields.nil?
|
1409
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1410
|
+
execute_or_queue_command(command, &block)
|
1411
|
+
end
|
1412
|
+
|
1413
|
+
# Retrieves the specified flow.
|
1414
|
+
# @param [String] name
|
1415
|
+
# Required. The name of the flow to get. Format: `projects//locations//agents//
|
1416
|
+
# flows/`.
|
1417
|
+
# @param [String] language_code
|
1418
|
+
# The language to retrieve the flow for. The following fields are language
|
1419
|
+
# dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.
|
1420
|
+
# transition_routes.trigger_fulfillment.messages` If not specified, the agent's
|
1421
|
+
# default language is used. [Many languages](https://cloud.google.com/dialogflow/
|
1422
|
+
# docs/reference/language) are supported. Note: languages must be enabled in the
|
1423
|
+
# agent before they can be used.
|
1424
|
+
# @param [String] fields
|
1425
|
+
# Selector specifying which fields to include in a partial response.
|
1426
|
+
# @param [String] quota_user
|
1427
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1428
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1429
|
+
# @param [Google::Apis::RequestOptions] options
|
1430
|
+
# Request-specific options
|
1431
|
+
#
|
1432
|
+
# @yield [result, err] Result & error if block supplied
|
1433
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow] parsed result object
|
1434
|
+
# @yieldparam err [StandardError] error object if request failed
|
1435
|
+
#
|
1436
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow]
|
1437
|
+
#
|
1438
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1439
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1440
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1441
|
+
def get_project_location_agent_flow(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1442
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
1443
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
|
1444
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
|
1445
|
+
command.params['name'] = name unless name.nil?
|
1446
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1447
|
+
command.query['fields'] = fields unless fields.nil?
|
1448
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1449
|
+
execute_or_queue_command(command, &block)
|
1450
|
+
end
|
1451
|
+
|
1452
|
+
# Gets the latest flow validation result. Flow validation is performed when
|
1453
|
+
# ValidateFlow is called.
|
1454
|
+
# @param [String] name
|
1455
|
+
# Required. The flow name. Format: `projects//locations//agents//flows//
|
1456
|
+
# validationResult`.
|
1457
|
+
# @param [String] language_code
|
1458
|
+
# If not specified, the agent's default language is used.
|
1459
|
+
# @param [String] fields
|
1460
|
+
# Selector specifying which fields to include in a partial response.
|
1461
|
+
# @param [String] quota_user
|
1462
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1463
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1464
|
+
# @param [Google::Apis::RequestOptions] options
|
1465
|
+
# Request-specific options
|
1466
|
+
#
|
1467
|
+
# @yield [result, err] Result & error if block supplied
|
1468
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult] parsed result object
|
1469
|
+
# @yieldparam err [StandardError] error object if request failed
|
1470
|
+
#
|
1471
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult]
|
1472
|
+
#
|
1473
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1474
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1475
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1476
|
+
def get_project_location_agent_flow_validation_result(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1477
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
1478
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult::Representation
|
1479
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult
|
1480
|
+
command.params['name'] = name unless name.nil?
|
1481
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1482
|
+
command.query['fields'] = fields unless fields.nil?
|
1483
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1484
|
+
execute_or_queue_command(command, &block)
|
1485
|
+
end
|
1486
|
+
|
1487
|
+
# Returns the list of all flows in the specified agent.
|
1488
|
+
# @param [String] parent
|
1489
|
+
# Required. The agent containing the flows. Format: `projects//locations//agents/
|
1490
|
+
# `.
|
1491
|
+
# @param [String] language_code
|
1492
|
+
# The language to list flows for. The following fields are language dependent: *
|
1493
|
+
# `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.
|
1494
|
+
# trigger_fulfillment.messages` If not specified, the agent's default language
|
1495
|
+
# is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/
|
1496
|
+
# language) are supported. Note: languages must be enabled in the agent before
|
1497
|
+
# they can be used.
|
1498
|
+
# @param [Fixnum] page_size
|
1499
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
1500
|
+
# most 1000.
|
1501
|
+
# @param [String] page_token
|
1502
|
+
# The next_page_token value returned from a previous list request.
|
1503
|
+
# @param [String] fields
|
1504
|
+
# Selector specifying which fields to include in a partial response.
|
1505
|
+
# @param [String] quota_user
|
1506
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1507
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1508
|
+
# @param [Google::Apis::RequestOptions] options
|
1509
|
+
# Request-specific options
|
1510
|
+
#
|
1511
|
+
# @yield [result, err] Result & error if block supplied
|
1512
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListFlowsResponse] parsed result object
|
1513
|
+
# @yieldparam err [StandardError] error object if request failed
|
1514
|
+
#
|
1515
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListFlowsResponse]
|
1516
|
+
#
|
1517
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1518
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1519
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1520
|
+
def list_project_location_agent_flows(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1521
|
+
command = make_simple_command(:get, 'v3/{+parent}/flows', options)
|
1522
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListFlowsResponse::Representation
|
1523
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListFlowsResponse
|
1524
|
+
command.params['parent'] = parent unless parent.nil?
|
1525
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1526
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1527
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1528
|
+
command.query['fields'] = fields unless fields.nil?
|
1529
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1530
|
+
execute_or_queue_command(command, &block)
|
1531
|
+
end
|
1532
|
+
|
1533
|
+
# Updates the specified flow.
|
1534
|
+
# @param [String] name
|
1535
|
+
# The unique identifier of the flow. Format: `projects//locations//agents//flows/
|
1536
|
+
# `.
|
1537
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow] google_cloud_dialogflow_cx_v3_flow_object
|
1538
|
+
# @param [String] language_code
|
1539
|
+
# The language of the following fields in `flow`: * `Flow.event_handlers.
|
1540
|
+
# trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.
|
1541
|
+
# messages` If not specified, the agent's default language is used. [Many
|
1542
|
+
# languages](https://cloud.google.com/dialogflow/docs/reference/language) are
|
1543
|
+
# supported. Note: languages must be enabled in the agent before they can be
|
1544
|
+
# used.
|
1545
|
+
# @param [String] update_mask
|
1546
|
+
# Required. The mask to control which fields get updated. If `update_mask` is
|
1547
|
+
# not specified, an error will be returned.
|
1548
|
+
# @param [String] fields
|
1549
|
+
# Selector specifying which fields to include in a partial response.
|
1550
|
+
# @param [String] quota_user
|
1551
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1552
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1553
|
+
# @param [Google::Apis::RequestOptions] options
|
1554
|
+
# Request-specific options
|
1555
|
+
#
|
1556
|
+
# @yield [result, err] Result & error if block supplied
|
1557
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow] parsed result object
|
1558
|
+
# @yieldparam err [StandardError] error object if request failed
|
1559
|
+
#
|
1560
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow]
|
1561
|
+
#
|
1562
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1563
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1564
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1565
|
+
def patch_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3_flow_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1566
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
1567
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
|
1568
|
+
command.request_object = google_cloud_dialogflow_cx_v3_flow_object
|
1569
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
|
1570
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
|
1571
|
+
command.params['name'] = name unless name.nil?
|
1572
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1573
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1574
|
+
command.query['fields'] = fields unless fields.nil?
|
1575
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1576
|
+
execute_or_queue_command(command, &block)
|
1577
|
+
end
|
1578
|
+
|
1579
|
+
# Trains the specified flow. Note that only the flow in 'draft' environment is
|
1580
|
+
# trained.
|
1581
|
+
# @param [String] name
|
1582
|
+
# Required. The flow to train. Format: `projects//locations//agents//flows/`.
|
1583
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TrainFlowRequest] google_cloud_dialogflow_cx_v3_train_flow_request_object
|
1584
|
+
# @param [String] fields
|
1585
|
+
# Selector specifying which fields to include in a partial response.
|
1586
|
+
# @param [String] quota_user
|
1587
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1588
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1589
|
+
# @param [Google::Apis::RequestOptions] options
|
1590
|
+
# Request-specific options
|
1591
|
+
#
|
1592
|
+
# @yield [result, err] Result & error if block supplied
|
1593
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
1594
|
+
# @yieldparam err [StandardError] error object if request failed
|
1595
|
+
#
|
1596
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
1597
|
+
#
|
1598
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1599
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1600
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1601
|
+
def train_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3_train_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1602
|
+
command = make_simple_command(:post, 'v3/{+name}:train', options)
|
1603
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TrainFlowRequest::Representation
|
1604
|
+
command.request_object = google_cloud_dialogflow_cx_v3_train_flow_request_object
|
1605
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
1606
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
1607
|
+
command.params['name'] = name unless name.nil?
|
1608
|
+
command.query['fields'] = fields unless fields.nil?
|
1609
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1610
|
+
execute_or_queue_command(command, &block)
|
1611
|
+
end
|
1612
|
+
|
1613
|
+
# Validates the specified flow and creates or updates validation results. Please
|
1614
|
+
# call this API after the training is completed to get the complete validation
|
1615
|
+
# results.
|
1616
|
+
# @param [String] name
|
1617
|
+
# Required. The flow to validate. Format: `projects//locations//agents//flows/`.
|
1618
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateFlowRequest] google_cloud_dialogflow_cx_v3_validate_flow_request_object
|
1619
|
+
# @param [String] fields
|
1620
|
+
# Selector specifying which fields to include in a partial response.
|
1621
|
+
# @param [String] quota_user
|
1622
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1623
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1624
|
+
# @param [Google::Apis::RequestOptions] options
|
1625
|
+
# Request-specific options
|
1626
|
+
#
|
1627
|
+
# @yield [result, err] Result & error if block supplied
|
1628
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult] parsed result object
|
1629
|
+
# @yieldparam err [StandardError] error object if request failed
|
1630
|
+
#
|
1631
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult]
|
1632
|
+
#
|
1633
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1634
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1635
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1636
|
+
def validate_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3_validate_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1637
|
+
command = make_simple_command(:post, 'v3/{+name}:validate', options)
|
1638
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateFlowRequest::Representation
|
1639
|
+
command.request_object = google_cloud_dialogflow_cx_v3_validate_flow_request_object
|
1640
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult::Representation
|
1641
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult
|
1642
|
+
command.params['name'] = name unless name.nil?
|
1643
|
+
command.query['fields'] = fields unless fields.nil?
|
1644
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1645
|
+
execute_or_queue_command(command, &block)
|
1646
|
+
end
|
1647
|
+
|
1648
|
+
# Creates a page in the specified flow.
|
1649
|
+
# @param [String] parent
|
1650
|
+
# Required. The flow to create a page for. Format: `projects//locations//agents//
|
1651
|
+
# flows/`.
|
1652
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page] google_cloud_dialogflow_cx_v3_page_object
|
1653
|
+
# @param [String] language_code
|
1654
|
+
# The language of the following fields in `page`: * `Page.entry_fulfillment.
|
1655
|
+
# messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.
|
1656
|
+
# messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.
|
1657
|
+
# messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.
|
1658
|
+
# transition_route_groups.transition_routes.trigger_fulfillment.messages` If not
|
1659
|
+
# specified, the agent's default language is used. [Many languages](https://
|
1660
|
+
# cloud.google.com/dialogflow/docs/reference/language) are supported. Note:
|
1661
|
+
# languages must be enabled in the agent before they can be used.
|
1662
|
+
# @param [String] fields
|
1663
|
+
# Selector specifying which fields to include in a partial response.
|
1664
|
+
# @param [String] quota_user
|
1665
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1666
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1667
|
+
# @param [Google::Apis::RequestOptions] options
|
1668
|
+
# Request-specific options
|
1669
|
+
#
|
1670
|
+
# @yield [result, err] Result & error if block supplied
|
1671
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page] parsed result object
|
1672
|
+
# @yieldparam err [StandardError] error object if request failed
|
1673
|
+
#
|
1674
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page]
|
1675
|
+
#
|
1676
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1677
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1678
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1679
|
+
def create_project_location_agent_flow_page(parent, google_cloud_dialogflow_cx_v3_page_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1680
|
+
command = make_simple_command(:post, 'v3/{+parent}/pages', options)
|
1681
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
|
1682
|
+
command.request_object = google_cloud_dialogflow_cx_v3_page_object
|
1683
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
|
1684
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
|
1685
|
+
command.params['parent'] = parent unless parent.nil?
|
1686
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1687
|
+
command.query['fields'] = fields unless fields.nil?
|
1688
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1689
|
+
execute_or_queue_command(command, &block)
|
1690
|
+
end
|
1691
|
+
|
1692
|
+
# Deletes the specified page.
|
1693
|
+
# @param [String] name
|
1694
|
+
# Required. The name of the page to delete. Format: `projects//locations//agents/
|
1695
|
+
# /Flows//pages/`.
|
1696
|
+
# @param [Boolean] force
|
1697
|
+
# This field has no effect for pages with no incoming transitions. For pages
|
1698
|
+
# with incoming transitions: * If `force` is set to false, an error will be
|
1699
|
+
# returned with message indicating the incoming transitions. * If `force` is set
|
1700
|
+
# to true, Dialogflow will remove the page, as well as any transitions to the
|
1701
|
+
# page (i.e. Target page in event handlers or Target page in transition routes
|
1702
|
+
# that point to this page will be cleared).
|
1703
|
+
# @param [String] fields
|
1704
|
+
# Selector specifying which fields to include in a partial response.
|
1705
|
+
# @param [String] quota_user
|
1706
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1707
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1708
|
+
# @param [Google::Apis::RequestOptions] options
|
1709
|
+
# Request-specific options
|
1710
|
+
#
|
1711
|
+
# @yield [result, err] Result & error if block supplied
|
1712
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
1713
|
+
# @yieldparam err [StandardError] error object if request failed
|
1714
|
+
#
|
1715
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
1716
|
+
#
|
1717
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1718
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1719
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1720
|
+
def delete_project_location_agent_flow_page(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1721
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
1722
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
1723
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
1724
|
+
command.params['name'] = name unless name.nil?
|
1725
|
+
command.query['force'] = force unless force.nil?
|
1726
|
+
command.query['fields'] = fields unless fields.nil?
|
1727
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1728
|
+
execute_or_queue_command(command, &block)
|
1729
|
+
end
|
1730
|
+
|
1731
|
+
# Retrieves the specified page.
|
1732
|
+
# @param [String] name
|
1733
|
+
# Required. The name of the page. Format: `projects//locations//agents//flows//
|
1734
|
+
# pages/`.
|
1735
|
+
# @param [String] language_code
|
1736
|
+
# The language to retrieve the page for. The following fields are language
|
1737
|
+
# dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.
|
1738
|
+
# fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.
|
1739
|
+
# fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.
|
1740
|
+
# trigger_fulfillment.messages` * `Page.transition_route_groups.
|
1741
|
+
# transition_routes.trigger_fulfillment.messages` If not specified, the agent's
|
1742
|
+
# default language is used. [Many languages](https://cloud.google.com/dialogflow/
|
1743
|
+
# docs/reference/language) are supported. Note: languages must be enabled in the
|
1744
|
+
# agent before they can be used.
|
1745
|
+
# @param [String] fields
|
1746
|
+
# Selector specifying which fields to include in a partial response.
|
1747
|
+
# @param [String] quota_user
|
1748
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1749
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1750
|
+
# @param [Google::Apis::RequestOptions] options
|
1751
|
+
# Request-specific options
|
1752
|
+
#
|
1753
|
+
# @yield [result, err] Result & error if block supplied
|
1754
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page] parsed result object
|
1755
|
+
# @yieldparam err [StandardError] error object if request failed
|
1756
|
+
#
|
1757
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page]
|
1758
|
+
#
|
1759
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1760
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1761
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1762
|
+
def get_project_location_agent_flow_page(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1763
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
1764
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
|
1765
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
|
1766
|
+
command.params['name'] = name unless name.nil?
|
1767
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1768
|
+
command.query['fields'] = fields unless fields.nil?
|
1769
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1770
|
+
execute_or_queue_command(command, &block)
|
1771
|
+
end
|
1772
|
+
|
1773
|
+
# Returns the list of all pages in the specified flow.
|
1774
|
+
# @param [String] parent
|
1775
|
+
# Required. The flow to list all pages for. Format: `projects//locations//agents/
|
1776
|
+
# /flows/`.
|
1777
|
+
# @param [String] language_code
|
1778
|
+
# The language to list pages for. The following fields are language dependent: *
|
1779
|
+
# `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.
|
1780
|
+
# initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.
|
1781
|
+
# reprompt_event_handlers.messages` * `Page.transition_routes.
|
1782
|
+
# trigger_fulfillment.messages` * `Page.transition_route_groups.
|
1783
|
+
# transition_routes.trigger_fulfillment.messages` If not specified, the agent's
|
1784
|
+
# default language is used. [Many languages](https://cloud.google.com/dialogflow/
|
1785
|
+
# docs/reference/language) are supported. Note: languages must be enabled in the
|
1786
|
+
# agent before they can be used.
|
1787
|
+
# @param [Fixnum] page_size
|
1788
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
1789
|
+
# most 1000.
|
1790
|
+
# @param [String] page_token
|
1791
|
+
# The next_page_token value returned from a previous list request.
|
1792
|
+
# @param [String] fields
|
1793
|
+
# Selector specifying which fields to include in a partial response.
|
1794
|
+
# @param [String] quota_user
|
1795
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1796
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1797
|
+
# @param [Google::Apis::RequestOptions] options
|
1798
|
+
# Request-specific options
|
1799
|
+
#
|
1800
|
+
# @yield [result, err] Result & error if block supplied
|
1801
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListPagesResponse] parsed result object
|
1802
|
+
# @yieldparam err [StandardError] error object if request failed
|
1803
|
+
#
|
1804
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListPagesResponse]
|
1805
|
+
#
|
1806
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1807
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1808
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1809
|
+
def list_project_location_agent_flow_pages(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1810
|
+
command = make_simple_command(:get, 'v3/{+parent}/pages', options)
|
1811
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListPagesResponse::Representation
|
1812
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListPagesResponse
|
1813
|
+
command.params['parent'] = parent unless parent.nil?
|
1814
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1815
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1816
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1817
|
+
command.query['fields'] = fields unless fields.nil?
|
1818
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1819
|
+
execute_or_queue_command(command, &block)
|
1820
|
+
end
|
1821
|
+
|
1822
|
+
# Updates the specified page.
|
1823
|
+
# @param [String] name
|
1824
|
+
# The unique identifier of the page. Required for the Pages.UpdatePage method.
|
1825
|
+
# Pages.CreatePage populates the name automatically. Format: `projects//
|
1826
|
+
# locations//agents//flows//pages/`.
|
1827
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page] google_cloud_dialogflow_cx_v3_page_object
|
1828
|
+
# @param [String] language_code
|
1829
|
+
# The language of the following fields in `page`: * `Page.entry_fulfillment.
|
1830
|
+
# messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.
|
1831
|
+
# messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.
|
1832
|
+
# messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.
|
1833
|
+
# transition_route_groups.transition_routes.trigger_fulfillment.messages` If not
|
1834
|
+
# specified, the agent's default language is used. [Many languages](https://
|
1835
|
+
# cloud.google.com/dialogflow/docs/reference/language) are supported. Note:
|
1836
|
+
# languages must be enabled in the agent before they can be used.
|
1837
|
+
# @param [String] update_mask
|
1838
|
+
# The mask to control which fields get updated. If the mask is not present, all
|
1839
|
+
# fields will be updated.
|
1840
|
+
# @param [String] fields
|
1841
|
+
# Selector specifying which fields to include in a partial response.
|
1842
|
+
# @param [String] quota_user
|
1843
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1844
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1845
|
+
# @param [Google::Apis::RequestOptions] options
|
1846
|
+
# Request-specific options
|
1847
|
+
#
|
1848
|
+
# @yield [result, err] Result & error if block supplied
|
1849
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page] parsed result object
|
1850
|
+
# @yieldparam err [StandardError] error object if request failed
|
1851
|
+
#
|
1852
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page]
|
1853
|
+
#
|
1854
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1855
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1856
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1857
|
+
def patch_project_location_agent_flow_page(name, google_cloud_dialogflow_cx_v3_page_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1858
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
1859
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
|
1860
|
+
command.request_object = google_cloud_dialogflow_cx_v3_page_object
|
1861
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
|
1862
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
|
1863
|
+
command.params['name'] = name unless name.nil?
|
1864
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1865
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1866
|
+
command.query['fields'] = fields unless fields.nil?
|
1867
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1868
|
+
execute_or_queue_command(command, &block)
|
1869
|
+
end
|
1870
|
+
|
1871
|
+
# Creates an TransitionRouteGroup in the specified flow.
|
1872
|
+
# @param [String] parent
|
1873
|
+
# Required. The flow to create an TransitionRouteGroup for. Format: `projects//
|
1874
|
+
# locations//agents//flows/`.
|
1875
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] google_cloud_dialogflow_cx_v3_transition_route_group_object
|
1876
|
+
# @param [String] language_code
|
1877
|
+
# The language to list transition route groups for. The field `messages` in
|
1878
|
+
# TransitionRoute is language dependent. If not specified, the agent's default
|
1879
|
+
# language is used. [Many languages](https://cloud.google.com/dialogflow/docs/
|
1880
|
+
# reference/language) are supported. Note: languages must be enabled in the
|
1881
|
+
# agent before they can be used.
|
1882
|
+
# @param [String] fields
|
1883
|
+
# Selector specifying which fields to include in a partial response.
|
1884
|
+
# @param [String] quota_user
|
1885
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1886
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1887
|
+
# @param [Google::Apis::RequestOptions] options
|
1888
|
+
# Request-specific options
|
1889
|
+
#
|
1890
|
+
# @yield [result, err] Result & error if block supplied
|
1891
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] parsed result object
|
1892
|
+
# @yieldparam err [StandardError] error object if request failed
|
1893
|
+
#
|
1894
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup]
|
1895
|
+
#
|
1896
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1897
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1898
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1899
|
+
def create_project_location_agent_flow_transition_route_group(parent, google_cloud_dialogflow_cx_v3_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1900
|
+
command = make_simple_command(:post, 'v3/{+parent}/transitionRouteGroups', options)
|
1901
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
|
1902
|
+
command.request_object = google_cloud_dialogflow_cx_v3_transition_route_group_object
|
1903
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
|
1904
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
|
1905
|
+
command.params['parent'] = parent unless parent.nil?
|
1906
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1907
|
+
command.query['fields'] = fields unless fields.nil?
|
1908
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1909
|
+
execute_or_queue_command(command, &block)
|
1910
|
+
end
|
1911
|
+
|
1912
|
+
# Deletes the specified TransitionRouteGroup.
|
1913
|
+
# @param [String] name
|
1914
|
+
# Required. The name of the TransitionRouteGroup to delete. Format: `projects//
|
1915
|
+
# locations//agents//flows//transitionRouteGroups/`.
|
1916
|
+
# @param [Boolean] force
|
1917
|
+
# This field has no effect for transition route group that no page is using. If
|
1918
|
+
# the transition route group is referenced by any page: * If `force` is set to
|
1919
|
+
# false, an error will be returned with message indicating pages that reference
|
1920
|
+
# the transition route group. * If `force` is set to true, Dialogflow will
|
1921
|
+
# remove the transition route group, as well as any reference to it.
|
1922
|
+
# @param [String] fields
|
1923
|
+
# Selector specifying which fields to include in a partial response.
|
1924
|
+
# @param [String] quota_user
|
1925
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1926
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1927
|
+
# @param [Google::Apis::RequestOptions] options
|
1928
|
+
# Request-specific options
|
1929
|
+
#
|
1930
|
+
# @yield [result, err] Result & error if block supplied
|
1931
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
1932
|
+
# @yieldparam err [StandardError] error object if request failed
|
1933
|
+
#
|
1934
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
1935
|
+
#
|
1936
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1937
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1938
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1939
|
+
def delete_project_location_agent_flow_transition_route_group(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1940
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
1941
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
1942
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
1943
|
+
command.params['name'] = name unless name.nil?
|
1944
|
+
command.query['force'] = force unless force.nil?
|
1945
|
+
command.query['fields'] = fields unless fields.nil?
|
1946
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1947
|
+
execute_or_queue_command(command, &block)
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# Retrieves the specified TransitionRouteGroup.
|
1951
|
+
# @param [String] name
|
1952
|
+
# Required. The name of the TransitionRouteGroup. Format: `projects//locations//
|
1953
|
+
# agents//flows//transitionRouteGroups/`.
|
1954
|
+
# @param [String] language_code
|
1955
|
+
# The language to list transition route groups for. The field `messages` in
|
1956
|
+
# TransitionRoute is language dependent. If not specified, the agent's default
|
1957
|
+
# language is used. [Many languages](https://cloud.google.com/dialogflow/docs/
|
1958
|
+
# reference/language) are supported. Note: languages must be enabled in the
|
1959
|
+
# agent before they can be used.
|
1960
|
+
# @param [String] fields
|
1961
|
+
# Selector specifying which fields to include in a partial response.
|
1962
|
+
# @param [String] quota_user
|
1963
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1964
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1965
|
+
# @param [Google::Apis::RequestOptions] options
|
1966
|
+
# Request-specific options
|
1967
|
+
#
|
1968
|
+
# @yield [result, err] Result & error if block supplied
|
1969
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] parsed result object
|
1970
|
+
# @yieldparam err [StandardError] error object if request failed
|
1971
|
+
#
|
1972
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup]
|
1973
|
+
#
|
1974
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1975
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1976
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1977
|
+
def get_project_location_agent_flow_transition_route_group(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1978
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
1979
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
|
1980
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
|
1981
|
+
command.params['name'] = name unless name.nil?
|
1982
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
1983
|
+
command.query['fields'] = fields unless fields.nil?
|
1984
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1985
|
+
execute_or_queue_command(command, &block)
|
1986
|
+
end
|
1987
|
+
|
1988
|
+
# Returns the list of all transition route groups in the specified flow.
|
1989
|
+
# @param [String] parent
|
1990
|
+
# Required. The flow to list all transition route groups for. Format: `projects//
|
1991
|
+
# locations//agents//flows/`.
|
1992
|
+
# @param [String] language_code
|
1993
|
+
# The language to list transition route groups for. The field `messages` in
|
1994
|
+
# TransitionRoute is language dependent. If not specified, the agent's default
|
1995
|
+
# language is used. [Many languages](https://cloud.google.com/dialogflow/docs/
|
1996
|
+
# reference/language) are supported. Note: languages must be enabled in the
|
1997
|
+
# agent before they can be used.
|
1998
|
+
# @param [Fixnum] page_size
|
1999
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
2000
|
+
# most 1000.
|
2001
|
+
# @param [String] page_token
|
2002
|
+
# The next_page_token value returned from a previous list request.
|
2003
|
+
# @param [String] fields
|
2004
|
+
# Selector specifying which fields to include in a partial response.
|
2005
|
+
# @param [String] quota_user
|
2006
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2007
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2008
|
+
# @param [Google::Apis::RequestOptions] options
|
2009
|
+
# Request-specific options
|
2010
|
+
#
|
2011
|
+
# @yield [result, err] Result & error if block supplied
|
2012
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse] parsed result object
|
2013
|
+
# @yieldparam err [StandardError] error object if request failed
|
2014
|
+
#
|
2015
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse]
|
2016
|
+
#
|
2017
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2018
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2019
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020
|
+
def list_project_location_agent_flow_transition_route_groups(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2021
|
+
command = make_simple_command(:get, 'v3/{+parent}/transitionRouteGroups', options)
|
2022
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse::Representation
|
2023
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse
|
2024
|
+
command.params['parent'] = parent unless parent.nil?
|
2025
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
2026
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2027
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2028
|
+
command.query['fields'] = fields unless fields.nil?
|
2029
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2030
|
+
execute_or_queue_command(command, &block)
|
2031
|
+
end
|
2032
|
+
|
2033
|
+
# Updates the specified TransitionRouteGroup.
|
2034
|
+
# @param [String] name
|
2035
|
+
# The unique identifier of the transition route group. TransitionRouteGroups.
|
2036
|
+
# CreateTransitionRouteGroup populates the name automatically. Format: `projects/
|
2037
|
+
# /locations//agents//flows//transitionRouteGroups/`.
|
2038
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] google_cloud_dialogflow_cx_v3_transition_route_group_object
|
2039
|
+
# @param [String] language_code
|
2040
|
+
# The language to list transition route groups for. The field `messages` in
|
2041
|
+
# TransitionRoute is language dependent. If not specified, the agent's default
|
2042
|
+
# language is used. [Many languages](https://cloud.google.com/dialogflow/docs/
|
2043
|
+
# reference/language) are supported. Note: languages must be enabled in the
|
2044
|
+
# agent before they can be used.
|
2045
|
+
# @param [String] update_mask
|
2046
|
+
# The mask to control which fields get updated.
|
2047
|
+
# @param [String] fields
|
2048
|
+
# Selector specifying which fields to include in a partial response.
|
2049
|
+
# @param [String] quota_user
|
2050
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2051
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2052
|
+
# @param [Google::Apis::RequestOptions] options
|
2053
|
+
# Request-specific options
|
2054
|
+
#
|
2055
|
+
# @yield [result, err] Result & error if block supplied
|
2056
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup] parsed result object
|
2057
|
+
# @yieldparam err [StandardError] error object if request failed
|
2058
|
+
#
|
2059
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup]
|
2060
|
+
#
|
2061
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2062
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2063
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2064
|
+
def patch_project_location_agent_flow_transition_route_group(name, google_cloud_dialogflow_cx_v3_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2065
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
2066
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
|
2067
|
+
command.request_object = google_cloud_dialogflow_cx_v3_transition_route_group_object
|
2068
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
|
2069
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
|
2070
|
+
command.params['name'] = name unless name.nil?
|
2071
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
2072
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2073
|
+
command.query['fields'] = fields unless fields.nil?
|
2074
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2075
|
+
execute_or_queue_command(command, &block)
|
2076
|
+
end
|
2077
|
+
|
2078
|
+
# Creates a Version in the specified Flow.
|
2079
|
+
# @param [String] parent
|
2080
|
+
# Required. The Flow to create an Version for. Format: `projects//locations//
|
2081
|
+
# agents//flows/`.
|
2082
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version] google_cloud_dialogflow_cx_v3_version_object
|
2083
|
+
# @param [String] fields
|
2084
|
+
# Selector specifying which fields to include in a partial response.
|
2085
|
+
# @param [String] quota_user
|
2086
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2087
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2088
|
+
# @param [Google::Apis::RequestOptions] options
|
2089
|
+
# Request-specific options
|
2090
|
+
#
|
2091
|
+
# @yield [result, err] Result & error if block supplied
|
2092
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
2093
|
+
# @yieldparam err [StandardError] error object if request failed
|
2094
|
+
#
|
2095
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
2096
|
+
#
|
2097
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2098
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2099
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2100
|
+
def create_project_location_agent_flow_version(parent, google_cloud_dialogflow_cx_v3_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2101
|
+
command = make_simple_command(:post, 'v3/{+parent}/versions', options)
|
2102
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
|
2103
|
+
command.request_object = google_cloud_dialogflow_cx_v3_version_object
|
2104
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
2105
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
2106
|
+
command.params['parent'] = parent unless parent.nil?
|
2107
|
+
command.query['fields'] = fields unless fields.nil?
|
2108
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2109
|
+
execute_or_queue_command(command, &block)
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# Deletes the specified Version.
|
2113
|
+
# @param [String] name
|
2114
|
+
# Required. The name of the Version to delete. Format: `projects//locations//
|
2115
|
+
# agents//flows//versions/`.
|
2116
|
+
# @param [String] fields
|
2117
|
+
# Selector specifying which fields to include in a partial response.
|
2118
|
+
# @param [String] quota_user
|
2119
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2120
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2121
|
+
# @param [Google::Apis::RequestOptions] options
|
2122
|
+
# Request-specific options
|
2123
|
+
#
|
2124
|
+
# @yield [result, err] Result & error if block supplied
|
2125
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
2126
|
+
# @yieldparam err [StandardError] error object if request failed
|
2127
|
+
#
|
2128
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
2129
|
+
#
|
2130
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2131
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2132
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2133
|
+
def delete_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil, &block)
|
2134
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
2135
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
2136
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
2137
|
+
command.params['name'] = name unless name.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
|
+
# Retrieves the specified Version.
|
2144
|
+
# @param [String] name
|
2145
|
+
# Required. The name of the Version. Format: `projects//locations//agents//flows/
|
2146
|
+
# /versions/`.
|
2147
|
+
# @param [String] fields
|
2148
|
+
# Selector specifying which fields to include in a partial response.
|
2149
|
+
# @param [String] quota_user
|
2150
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2151
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2152
|
+
# @param [Google::Apis::RequestOptions] options
|
2153
|
+
# Request-specific options
|
2154
|
+
#
|
2155
|
+
# @yield [result, err] Result & error if block supplied
|
2156
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version] parsed result object
|
2157
|
+
# @yieldparam err [StandardError] error object if request failed
|
2158
|
+
#
|
2159
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version]
|
2160
|
+
#
|
2161
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2162
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2163
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2164
|
+
def get_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil, &block)
|
2165
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
2166
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
|
2167
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version
|
2168
|
+
command.params['name'] = name unless name.nil?
|
2169
|
+
command.query['fields'] = fields unless fields.nil?
|
2170
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2171
|
+
execute_or_queue_command(command, &block)
|
2172
|
+
end
|
2173
|
+
|
2174
|
+
# Returns the list of all versions in the specified Flow.
|
2175
|
+
# @param [String] parent
|
2176
|
+
# Required. The Flow to list all versions for. Format: `projects//locations//
|
2177
|
+
# agents//flows/`.
|
2178
|
+
# @param [Fixnum] page_size
|
2179
|
+
# The maximum number of items to return in a single page. By default 20 and at
|
2180
|
+
# most 100.
|
2181
|
+
# @param [String] page_token
|
2182
|
+
# The next_page_token value returned from a previous list request.
|
2183
|
+
# @param [String] fields
|
2184
|
+
# Selector specifying which fields to include in a partial response.
|
2185
|
+
# @param [String] quota_user
|
2186
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2187
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2188
|
+
# @param [Google::Apis::RequestOptions] options
|
2189
|
+
# Request-specific options
|
2190
|
+
#
|
2191
|
+
# @yield [result, err] Result & error if block supplied
|
2192
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListVersionsResponse] parsed result object
|
2193
|
+
# @yieldparam err [StandardError] error object if request failed
|
2194
|
+
#
|
2195
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListVersionsResponse]
|
2196
|
+
#
|
2197
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2198
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2199
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2200
|
+
def list_project_location_agent_flow_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2201
|
+
command = make_simple_command(:get, 'v3/{+parent}/versions', options)
|
2202
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListVersionsResponse::Representation
|
2203
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListVersionsResponse
|
2204
|
+
command.params['parent'] = parent unless parent.nil?
|
2205
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2206
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2207
|
+
command.query['fields'] = fields unless fields.nil?
|
2208
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2209
|
+
execute_or_queue_command(command, &block)
|
2210
|
+
end
|
2211
|
+
|
2212
|
+
# Loads a specified version to draft version.
|
2213
|
+
# @param [String] name
|
2214
|
+
# Required. The Version to be loaded to draft version. Format: `projects//
|
2215
|
+
# locations//agents//flows//versions/`.
|
2216
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LoadVersionRequest] google_cloud_dialogflow_cx_v3_load_version_request_object
|
2217
|
+
# @param [String] fields
|
2218
|
+
# Selector specifying which fields to include in a partial response.
|
2219
|
+
# @param [String] quota_user
|
2220
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2221
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2222
|
+
# @param [Google::Apis::RequestOptions] options
|
2223
|
+
# Request-specific options
|
2224
|
+
#
|
2225
|
+
# @yield [result, err] Result & error if block supplied
|
2226
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
2227
|
+
# @yieldparam err [StandardError] error object if request failed
|
2228
|
+
#
|
2229
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
2230
|
+
#
|
2231
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2232
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2233
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2234
|
+
def load_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3_load_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2235
|
+
command = make_simple_command(:post, 'v3/{+name}:load', options)
|
2236
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LoadVersionRequest::Representation
|
2237
|
+
command.request_object = google_cloud_dialogflow_cx_v3_load_version_request_object
|
2238
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
2239
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
2240
|
+
command.params['name'] = name unless name.nil?
|
2241
|
+
command.query['fields'] = fields unless fields.nil?
|
2242
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2243
|
+
execute_or_queue_command(command, &block)
|
2244
|
+
end
|
2245
|
+
|
2246
|
+
# Updates the specified Version.
|
2247
|
+
# @param [String] name
|
2248
|
+
# Format: projects//locations//agents//flows//versions/. Version ID is a self-
|
2249
|
+
# increasing number generated by Dialogflow upon version creation.
|
2250
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version] google_cloud_dialogflow_cx_v3_version_object
|
2251
|
+
# @param [String] update_mask
|
2252
|
+
# Required. The mask to control which fields get updated. Currently only `
|
2253
|
+
# description` and `display_name` can be updated.
|
2254
|
+
# @param [String] fields
|
2255
|
+
# Selector specifying which fields to include in a partial response.
|
2256
|
+
# @param [String] quota_user
|
2257
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2258
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2259
|
+
# @param [Google::Apis::RequestOptions] options
|
2260
|
+
# Request-specific options
|
2261
|
+
#
|
2262
|
+
# @yield [result, err] Result & error if block supplied
|
2263
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version] parsed result object
|
2264
|
+
# @yieldparam err [StandardError] error object if request failed
|
2265
|
+
#
|
2266
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version]
|
2267
|
+
#
|
2268
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2269
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2270
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2271
|
+
def patch_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2272
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
2273
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
|
2274
|
+
command.request_object = google_cloud_dialogflow_cx_v3_version_object
|
2275
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
|
2276
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version
|
2277
|
+
command.params['name'] = name unless name.nil?
|
2278
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2279
|
+
command.query['fields'] = fields unless fields.nil?
|
2280
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2281
|
+
execute_or_queue_command(command, &block)
|
2282
|
+
end
|
2283
|
+
|
2284
|
+
# Creates an intent in the specified agent.
|
2285
|
+
# @param [String] parent
|
2286
|
+
# Required. The agent to create an intent for. Format: `projects//locations//
|
2287
|
+
# agents/`.
|
2288
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent] google_cloud_dialogflow_cx_v3_intent_object
|
2289
|
+
# @param [String] language_code
|
2290
|
+
# The language of the following fields in `intent`: * `Intent.training_phrases.
|
2291
|
+
# parts.text` If not specified, the agent's default language is used. [Many
|
2292
|
+
# languages](https://cloud.google.com/dialogflow/docs/reference/language) are
|
2293
|
+
# supported. Note: languages must be enabled in the agent before they can be
|
2294
|
+
# used.
|
2295
|
+
# @param [String] fields
|
2296
|
+
# Selector specifying which fields to include in a partial response.
|
2297
|
+
# @param [String] quota_user
|
2298
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2299
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2300
|
+
# @param [Google::Apis::RequestOptions] options
|
2301
|
+
# Request-specific options
|
2302
|
+
#
|
2303
|
+
# @yield [result, err] Result & error if block supplied
|
2304
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent] parsed result object
|
2305
|
+
# @yieldparam err [StandardError] error object if request failed
|
2306
|
+
#
|
2307
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent]
|
2308
|
+
#
|
2309
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2310
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2311
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2312
|
+
def create_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3_intent_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2313
|
+
command = make_simple_command(:post, 'v3/{+parent}/intents', options)
|
2314
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
|
2315
|
+
command.request_object = google_cloud_dialogflow_cx_v3_intent_object
|
2316
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
|
2317
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
|
2318
|
+
command.params['parent'] = parent unless parent.nil?
|
2319
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
2320
|
+
command.query['fields'] = fields unless fields.nil?
|
2321
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2322
|
+
execute_or_queue_command(command, &block)
|
2323
|
+
end
|
2324
|
+
|
2325
|
+
# Deletes the specified intent.
|
2326
|
+
# @param [String] name
|
2327
|
+
# Required. The name of the intent to delete. Format: `projects//locations//
|
2328
|
+
# agents//intents/`.
|
2329
|
+
# @param [String] fields
|
2330
|
+
# Selector specifying which fields to include in a partial response.
|
2331
|
+
# @param [String] quota_user
|
2332
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2333
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2334
|
+
# @param [Google::Apis::RequestOptions] options
|
2335
|
+
# Request-specific options
|
2336
|
+
#
|
2337
|
+
# @yield [result, err] Result & error if block supplied
|
2338
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
2339
|
+
# @yieldparam err [StandardError] error object if request failed
|
2340
|
+
#
|
2341
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
2342
|
+
#
|
2343
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2344
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2345
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2346
|
+
def delete_project_location_agent_intent(name, fields: nil, quota_user: nil, options: nil, &block)
|
2347
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
2348
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
2349
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
2350
|
+
command.params['name'] = name unless name.nil?
|
2351
|
+
command.query['fields'] = fields unless fields.nil?
|
2352
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2353
|
+
execute_or_queue_command(command, &block)
|
2354
|
+
end
|
2355
|
+
|
2356
|
+
# Retrieves the specified intent.
|
2357
|
+
# @param [String] name
|
2358
|
+
# Required. The name of the intent. Format: `projects//locations//agents//
|
2359
|
+
# intents/`.
|
2360
|
+
# @param [String] language_code
|
2361
|
+
# The language to retrieve the intent for. The following fields are language
|
2362
|
+
# dependent: * `Intent.training_phrases.parts.text` If not specified, the agent'
|
2363
|
+
# s default language is used. [Many languages](https://cloud.google.com/
|
2364
|
+
# dialogflow/docs/reference/language) are supported. Note: languages must be
|
2365
|
+
# enabled in the agent before they can be used.
|
2366
|
+
# @param [String] fields
|
2367
|
+
# Selector specifying which fields to include in a partial response.
|
2368
|
+
# @param [String] quota_user
|
2369
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2370
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2371
|
+
# @param [Google::Apis::RequestOptions] options
|
2372
|
+
# Request-specific options
|
2373
|
+
#
|
2374
|
+
# @yield [result, err] Result & error if block supplied
|
2375
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent] parsed result object
|
2376
|
+
# @yieldparam err [StandardError] error object if request failed
|
2377
|
+
#
|
2378
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent]
|
2379
|
+
#
|
2380
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2381
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2382
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2383
|
+
def get_project_location_agent_intent(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2384
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
2385
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
|
2386
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
|
2387
|
+
command.params['name'] = name unless name.nil?
|
2388
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
2389
|
+
command.query['fields'] = fields unless fields.nil?
|
2390
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2391
|
+
execute_or_queue_command(command, &block)
|
2392
|
+
end
|
2393
|
+
|
2394
|
+
# Returns the list of all intents in the specified agent.
|
2395
|
+
# @param [String] parent
|
2396
|
+
# Required. The agent to list all intents for. Format: `projects//locations//
|
2397
|
+
# agents/`.
|
2398
|
+
# @param [String] intent_view
|
2399
|
+
# The resource view to apply to the returned intent.
|
2400
|
+
# @param [String] language_code
|
2401
|
+
# The language to list intents for. The following fields are language dependent:
|
2402
|
+
# * `Intent.training_phrases.parts.text` If not specified, the agent's default
|
2403
|
+
# language is used. [Many languages](https://cloud.google.com/dialogflow/docs/
|
2404
|
+
# reference/language) are supported. Note: languages must be enabled in the
|
2405
|
+
# agent before they can be used.
|
2406
|
+
# @param [Fixnum] page_size
|
2407
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
2408
|
+
# most 1000.
|
2409
|
+
# @param [String] page_token
|
2410
|
+
# The next_page_token value returned from a previous list request.
|
2411
|
+
# @param [String] fields
|
2412
|
+
# Selector specifying which fields to include in a partial response.
|
2413
|
+
# @param [String] quota_user
|
2414
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2415
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2416
|
+
# @param [Google::Apis::RequestOptions] options
|
2417
|
+
# Request-specific options
|
2418
|
+
#
|
2419
|
+
# @yield [result, err] Result & error if block supplied
|
2420
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListIntentsResponse] parsed result object
|
2421
|
+
# @yieldparam err [StandardError] error object if request failed
|
2422
|
+
#
|
2423
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListIntentsResponse]
|
2424
|
+
#
|
2425
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2426
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2427
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2428
|
+
def list_project_location_agent_intents(parent, intent_view: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2429
|
+
command = make_simple_command(:get, 'v3/{+parent}/intents', options)
|
2430
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListIntentsResponse::Representation
|
2431
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListIntentsResponse
|
2432
|
+
command.params['parent'] = parent unless parent.nil?
|
2433
|
+
command.query['intentView'] = intent_view unless intent_view.nil?
|
2434
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
2435
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2436
|
+
command.query['pageToken'] = page_token unless page_token.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
|
+
# Updates the specified intent.
|
2443
|
+
# @param [String] name
|
2444
|
+
# The unique identifier of the intent. Required for the Intents.UpdateIntent
|
2445
|
+
# method. Intents.CreateIntent populates the name automatically. Format: `
|
2446
|
+
# projects//locations//agents//intents/`.
|
2447
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent] google_cloud_dialogflow_cx_v3_intent_object
|
2448
|
+
# @param [String] language_code
|
2449
|
+
# The language of the following fields in `intent`: * `Intent.training_phrases.
|
2450
|
+
# parts.text` If not specified, the agent's default language is used. [Many
|
2451
|
+
# languages](https://cloud.google.com/dialogflow/docs/reference/language) are
|
2452
|
+
# supported. Note: languages must be enabled in the agent before they can be
|
2453
|
+
# used.
|
2454
|
+
# @param [String] update_mask
|
2455
|
+
# The mask to control which fields get updated. If the mask is not present, all
|
2456
|
+
# fields will be updated.
|
2457
|
+
# @param [String] fields
|
2458
|
+
# Selector specifying which fields to include in a partial response.
|
2459
|
+
# @param [String] quota_user
|
2460
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2461
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2462
|
+
# @param [Google::Apis::RequestOptions] options
|
2463
|
+
# Request-specific options
|
2464
|
+
#
|
2465
|
+
# @yield [result, err] Result & error if block supplied
|
2466
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent] parsed result object
|
2467
|
+
# @yieldparam err [StandardError] error object if request failed
|
2468
|
+
#
|
2469
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent]
|
2470
|
+
#
|
2471
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2472
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2473
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2474
|
+
def patch_project_location_agent_intent(name, google_cloud_dialogflow_cx_v3_intent_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2475
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
2476
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
|
2477
|
+
command.request_object = google_cloud_dialogflow_cx_v3_intent_object
|
2478
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
|
2479
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
|
2480
|
+
command.params['name'] = name unless name.nil?
|
2481
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
2482
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2483
|
+
command.query['fields'] = fields unless fields.nil?
|
2484
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2485
|
+
execute_or_queue_command(command, &block)
|
2486
|
+
end
|
2487
|
+
|
2488
|
+
# Processes a natural language query and returns structured, actionable data as
|
2489
|
+
# a result. This method is not idempotent, because it may cause session entity
|
2490
|
+
# types to be updated, which in turn might affect results of future queries.
|
2491
|
+
# Note: Always use agent versions for production traffic. See [Versions and
|
2492
|
+
# environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
|
2493
|
+
# @param [String] session
|
2494
|
+
# Required. The name of the session this query is sent to. Format: `projects//
|
2495
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
2496
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
2497
|
+
# environment. It's up to the API caller to choose an appropriate `Session ID`.
|
2498
|
+
# It can be a random number or some type of session identifiers (preferably
|
2499
|
+
# hashed). The length of the `Session ID` must not exceed 36 characters. For
|
2500
|
+
# more information, see the [sessions guide](https://cloud.google.com/dialogflow/
|
2501
|
+
# cx/docs/concept/session). Note: Always use agent versions for production
|
2502
|
+
# traffic. See [Versions and environments](https://cloud.google.com/dialogflow/
|
2503
|
+
# cx/docs/concept/version).
|
2504
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest] google_cloud_dialogflow_cx_v3_detect_intent_request_object
|
2505
|
+
# @param [String] fields
|
2506
|
+
# Selector specifying which fields to include in a partial response.
|
2507
|
+
# @param [String] quota_user
|
2508
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2509
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2510
|
+
# @param [Google::Apis::RequestOptions] options
|
2511
|
+
# Request-specific options
|
2512
|
+
#
|
2513
|
+
# @yield [result, err] Result & error if block supplied
|
2514
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse] parsed result object
|
2515
|
+
# @yieldparam err [StandardError] error object if request failed
|
2516
|
+
#
|
2517
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse]
|
2518
|
+
#
|
2519
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2520
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2521
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2522
|
+
def detect_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2523
|
+
command = make_simple_command(:post, 'v3/{+session}:detectIntent', options)
|
2524
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest::Representation
|
2525
|
+
command.request_object = google_cloud_dialogflow_cx_v3_detect_intent_request_object
|
2526
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse::Representation
|
2527
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse
|
2528
|
+
command.params['session'] = session unless session.nil?
|
2529
|
+
command.query['fields'] = fields unless fields.nil?
|
2530
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2531
|
+
execute_or_queue_command(command, &block)
|
2532
|
+
end
|
2533
|
+
|
2534
|
+
# Fulfills a matched intent returned by MatchIntent. Must be called after
|
2535
|
+
# MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is
|
2536
|
+
# undefined.
|
2537
|
+
# @param [String] session
|
2538
|
+
# Required. The name of the session this query is sent to. Format: `projects//
|
2539
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
2540
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
2541
|
+
# environment. It's up to the API caller to choose an appropriate `Session ID`.
|
2542
|
+
# It can be a random number or some type of session identifiers (preferably
|
2543
|
+
# hashed). The length of the `Session ID` must not exceed 36 characters. For
|
2544
|
+
# more information, see the [sessions guide](https://cloud.google.com/dialogflow/
|
2545
|
+
# cx/docs/concept/session).
|
2546
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest] google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
|
2547
|
+
# @param [String] fields
|
2548
|
+
# Selector specifying which fields to include in a partial response.
|
2549
|
+
# @param [String] quota_user
|
2550
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2551
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2552
|
+
# @param [Google::Apis::RequestOptions] options
|
2553
|
+
# Request-specific options
|
2554
|
+
#
|
2555
|
+
# @yield [result, err] Result & error if block supplied
|
2556
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse] parsed result object
|
2557
|
+
# @yieldparam err [StandardError] error object if request failed
|
2558
|
+
#
|
2559
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse]
|
2560
|
+
#
|
2561
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2562
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2563
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2564
|
+
def fulfill_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2565
|
+
command = make_simple_command(:post, 'v3/{+session}:fulfillIntent', options)
|
2566
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest::Representation
|
2567
|
+
command.request_object = google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
|
2568
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse::Representation
|
2569
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse
|
2570
|
+
command.params['session'] = session unless session.nil?
|
2571
|
+
command.query['fields'] = fields unless fields.nil?
|
2572
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2573
|
+
execute_or_queue_command(command, &block)
|
2574
|
+
end
|
2575
|
+
|
2576
|
+
# Returns preliminary intent match results, doesn't change the session status.
|
2577
|
+
# @param [String] session
|
2578
|
+
# Required. The name of the session this query is sent to. Format: `projects//
|
2579
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
2580
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
2581
|
+
# environment. It's up to the API caller to choose an appropriate `Session ID`.
|
2582
|
+
# It can be a random number or some type of session identifiers (preferably
|
2583
|
+
# hashed). The length of the `Session ID` must not exceed 36 characters. For
|
2584
|
+
# more information, see the [sessions guide](https://cloud.google.com/dialogflow/
|
2585
|
+
# cx/docs/concept/session).
|
2586
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest] google_cloud_dialogflow_cx_v3_match_intent_request_object
|
2587
|
+
# @param [String] fields
|
2588
|
+
# Selector specifying which fields to include in a partial response.
|
2589
|
+
# @param [String] quota_user
|
2590
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2591
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2592
|
+
# @param [Google::Apis::RequestOptions] options
|
2593
|
+
# Request-specific options
|
2594
|
+
#
|
2595
|
+
# @yield [result, err] Result & error if block supplied
|
2596
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse] parsed result object
|
2597
|
+
# @yieldparam err [StandardError] error object if request failed
|
2598
|
+
#
|
2599
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse]
|
2600
|
+
#
|
2601
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2602
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2603
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2604
|
+
def match_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2605
|
+
command = make_simple_command(:post, 'v3/{+session}:matchIntent', options)
|
2606
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest::Representation
|
2607
|
+
command.request_object = google_cloud_dialogflow_cx_v3_match_intent_request_object
|
2608
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse::Representation
|
2609
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse
|
2610
|
+
command.params['session'] = session unless session.nil?
|
2611
|
+
command.query['fields'] = fields unless fields.nil?
|
2612
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2613
|
+
execute_or_queue_command(command, &block)
|
2614
|
+
end
|
2615
|
+
|
2616
|
+
# Creates a session entity type. If the specified session entity type already
|
2617
|
+
# exists, overrides the session entity type.
|
2618
|
+
# @param [String] parent
|
2619
|
+
# Required. The session to create a session entity type for. Format: `projects//
|
2620
|
+
# locations//agents//sessions/` or `projects//locations//agents//environments//
|
2621
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
2622
|
+
# environment.
|
2623
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
|
2624
|
+
# @param [String] fields
|
2625
|
+
# Selector specifying which fields to include in a partial response.
|
2626
|
+
# @param [String] quota_user
|
2627
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2628
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2629
|
+
# @param [Google::Apis::RequestOptions] options
|
2630
|
+
# Request-specific options
|
2631
|
+
#
|
2632
|
+
# @yield [result, err] Result & error if block supplied
|
2633
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] parsed result object
|
2634
|
+
# @yieldparam err [StandardError] error object if request failed
|
2635
|
+
#
|
2636
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType]
|
2637
|
+
#
|
2638
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2639
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2640
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2641
|
+
def create_project_location_agent_session_entity_type(parent, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2642
|
+
command = make_simple_command(:post, 'v3/{+parent}/entityTypes', options)
|
2643
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
2644
|
+
command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
|
2645
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
2646
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
|
2647
|
+
command.params['parent'] = parent unless parent.nil?
|
2648
|
+
command.query['fields'] = fields unless fields.nil?
|
2649
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2650
|
+
execute_or_queue_command(command, &block)
|
2651
|
+
end
|
2652
|
+
|
2653
|
+
# Deletes the specified session entity type.
|
2654
|
+
# @param [String] name
|
2655
|
+
# Required. The name of the session entity type to delete. Format: `projects//
|
2656
|
+
# locations//agents//sessions//entityTypes/` or `projects//locations//agents//
|
2657
|
+
# environments//sessions//entityTypes/`. If `Environment ID` is not specified,
|
2658
|
+
# we assume default 'draft' environment.
|
2659
|
+
# @param [String] fields
|
2660
|
+
# Selector specifying which fields to include in a partial response.
|
2661
|
+
# @param [String] quota_user
|
2662
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2663
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2664
|
+
# @param [Google::Apis::RequestOptions] options
|
2665
|
+
# Request-specific options
|
2666
|
+
#
|
2667
|
+
# @yield [result, err] Result & error if block supplied
|
2668
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
2669
|
+
# @yieldparam err [StandardError] error object if request failed
|
2670
|
+
#
|
2671
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
2672
|
+
#
|
2673
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2674
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2675
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2676
|
+
def delete_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
|
2677
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
2678
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
2679
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
2680
|
+
command.params['name'] = name unless name.nil?
|
2681
|
+
command.query['fields'] = fields unless fields.nil?
|
2682
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2683
|
+
execute_or_queue_command(command, &block)
|
2684
|
+
end
|
2685
|
+
|
2686
|
+
# Retrieves the specified session entity type.
|
2687
|
+
# @param [String] name
|
2688
|
+
# Required. The name of the session entity type. Format: `projects//locations//
|
2689
|
+
# agents//sessions//entityTypes/` or `projects//locations//agents//environments//
|
2690
|
+
# sessions//entityTypes/`. If `Environment ID` is not specified, we assume
|
2691
|
+
# default 'draft' environment.
|
2692
|
+
# @param [String] fields
|
2693
|
+
# Selector specifying which fields to include in a partial response.
|
2694
|
+
# @param [String] quota_user
|
2695
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2696
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2697
|
+
# @param [Google::Apis::RequestOptions] options
|
2698
|
+
# Request-specific options
|
2699
|
+
#
|
2700
|
+
# @yield [result, err] Result & error if block supplied
|
2701
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] parsed result object
|
2702
|
+
# @yieldparam err [StandardError] error object if request failed
|
2703
|
+
#
|
2704
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType]
|
2705
|
+
#
|
2706
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2707
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2708
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2709
|
+
def get_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
|
2710
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
2711
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
2712
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
|
2713
|
+
command.params['name'] = name unless name.nil?
|
2714
|
+
command.query['fields'] = fields unless fields.nil?
|
2715
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2716
|
+
execute_or_queue_command(command, &block)
|
2717
|
+
end
|
2718
|
+
|
2719
|
+
# Returns the list of all session entity types in the specified session.
|
2720
|
+
# @param [String] parent
|
2721
|
+
# Required. The session to list all session entity types from. Format: `projects/
|
2722
|
+
# /locations//agents//sessions/` or `projects//locations//agents//environments//
|
2723
|
+
# sessions/`. If `Environment ID` is not specified, we assume default 'draft'
|
2724
|
+
# environment.
|
2725
|
+
# @param [Fixnum] page_size
|
2726
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
2727
|
+
# most 1000.
|
2728
|
+
# @param [String] page_token
|
2729
|
+
# The next_page_token value returned from a previous list request.
|
2730
|
+
# @param [String] fields
|
2731
|
+
# Selector specifying which fields to include in a partial response.
|
2732
|
+
# @param [String] quota_user
|
2733
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2734
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2735
|
+
# @param [Google::Apis::RequestOptions] options
|
2736
|
+
# Request-specific options
|
2737
|
+
#
|
2738
|
+
# @yield [result, err] Result & error if block supplied
|
2739
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse] parsed result object
|
2740
|
+
# @yieldparam err [StandardError] error object if request failed
|
2741
|
+
#
|
2742
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse]
|
2743
|
+
#
|
2744
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2745
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2746
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2747
|
+
def list_project_location_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2748
|
+
command = make_simple_command(:get, 'v3/{+parent}/entityTypes', options)
|
2749
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse::Representation
|
2750
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse
|
2751
|
+
command.params['parent'] = parent unless parent.nil?
|
2752
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2753
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2754
|
+
command.query['fields'] = fields unless fields.nil?
|
2755
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2756
|
+
execute_or_queue_command(command, &block)
|
2757
|
+
end
|
2758
|
+
|
2759
|
+
# Updates the specified session entity type.
|
2760
|
+
# @param [String] name
|
2761
|
+
# Required. The unique identifier of the session entity type. Format: `projects//
|
2762
|
+
# locations//agents//sessions//entityTypes/` or `projects//locations//agents//
|
2763
|
+
# environments//sessions//entityTypes/`. If `Environment ID` is not specified,
|
2764
|
+
# we assume default 'draft' environment.
|
2765
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] google_cloud_dialogflow_cx_v3_session_entity_type_object
|
2766
|
+
# @param [String] update_mask
|
2767
|
+
# The mask to control which fields get updated.
|
2768
|
+
# @param [String] fields
|
2769
|
+
# Selector specifying which fields to include in a partial response.
|
2770
|
+
# @param [String] quota_user
|
2771
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2772
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2773
|
+
# @param [Google::Apis::RequestOptions] options
|
2774
|
+
# Request-specific options
|
2775
|
+
#
|
2776
|
+
# @yield [result, err] Result & error if block supplied
|
2777
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType] parsed result object
|
2778
|
+
# @yieldparam err [StandardError] error object if request failed
|
2779
|
+
#
|
2780
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType]
|
2781
|
+
#
|
2782
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2783
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2784
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2785
|
+
def patch_project_location_agent_session_entity_type(name, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2786
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
2787
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
2788
|
+
command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
|
2789
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
|
2790
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
|
2791
|
+
command.params['name'] = name unless name.nil?
|
2792
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2793
|
+
command.query['fields'] = fields unless fields.nil?
|
2794
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2795
|
+
execute_or_queue_command(command, &block)
|
2796
|
+
end
|
2797
|
+
|
2798
|
+
# Batch deletes test cases.
|
2799
|
+
# @param [String] parent
|
2800
|
+
# Required. The agent to delete test cases from. Format: `projects//locations//
|
2801
|
+
# agents/`.
|
2802
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest] google_cloud_dialogflow_cx_v3_batch_delete_test_cases_request_object
|
2803
|
+
# @param [String] fields
|
2804
|
+
# Selector specifying which fields to include in a partial response.
|
2805
|
+
# @param [String] quota_user
|
2806
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2807
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2808
|
+
# @param [Google::Apis::RequestOptions] options
|
2809
|
+
# Request-specific options
|
2810
|
+
#
|
2811
|
+
# @yield [result, err] Result & error if block supplied
|
2812
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
2813
|
+
# @yieldparam err [StandardError] error object if request failed
|
2814
|
+
#
|
2815
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
2816
|
+
#
|
2817
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2818
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2819
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2820
|
+
def batch_project_location_agent_test_case_delete(parent, google_cloud_dialogflow_cx_v3_batch_delete_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2821
|
+
command = make_simple_command(:post, 'v3/{+parent}/testCases:batchDelete', options)
|
2822
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest::Representation
|
2823
|
+
command.request_object = google_cloud_dialogflow_cx_v3_batch_delete_test_cases_request_object
|
2824
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
2825
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
2826
|
+
command.params['parent'] = parent unless parent.nil?
|
2827
|
+
command.query['fields'] = fields unless fields.nil?
|
2828
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2829
|
+
execute_or_queue_command(command, &block)
|
2830
|
+
end
|
2831
|
+
|
2832
|
+
# Kicks off a batch run of test cases.
|
2833
|
+
# @param [String] parent
|
2834
|
+
# Required. Agent name. Format: `projects//locations//agents/ `.
|
2835
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchRunTestCasesRequest] google_cloud_dialogflow_cx_v3_batch_run_test_cases_request_object
|
2836
|
+
# @param [String] fields
|
2837
|
+
# Selector specifying which fields to include in a partial response.
|
2838
|
+
# @param [String] quota_user
|
2839
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2840
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2841
|
+
# @param [Google::Apis::RequestOptions] options
|
2842
|
+
# Request-specific options
|
2843
|
+
#
|
2844
|
+
# @yield [result, err] Result & error if block supplied
|
2845
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
2846
|
+
# @yieldparam err [StandardError] error object if request failed
|
2847
|
+
#
|
2848
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
2849
|
+
#
|
2850
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2851
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2852
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2853
|
+
def batch_project_location_agent_test_case_run(parent, google_cloud_dialogflow_cx_v3_batch_run_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2854
|
+
command = make_simple_command(:post, 'v3/{+parent}/testCases:batchRun', options)
|
2855
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchRunTestCasesRequest::Representation
|
2856
|
+
command.request_object = google_cloud_dialogflow_cx_v3_batch_run_test_cases_request_object
|
2857
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
2858
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
2859
|
+
command.params['parent'] = parent unless parent.nil?
|
2860
|
+
command.query['fields'] = fields unless fields.nil?
|
2861
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2862
|
+
execute_or_queue_command(command, &block)
|
2863
|
+
end
|
2864
|
+
|
2865
|
+
# Calculates the test coverage for an agent.
|
2866
|
+
# @param [String] agent
|
2867
|
+
# Required. The agent to calculate coverage for. Format: `projects//locations//
|
2868
|
+
# agents/`.
|
2869
|
+
# @param [String] type
|
2870
|
+
# Required. The type of coverage requested.
|
2871
|
+
# @param [String] fields
|
2872
|
+
# Selector specifying which fields to include in a partial response.
|
2873
|
+
# @param [String] quota_user
|
2874
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2875
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2876
|
+
# @param [Google::Apis::RequestOptions] options
|
2877
|
+
# Request-specific options
|
2878
|
+
#
|
2879
|
+
# @yield [result, err] Result & error if block supplied
|
2880
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CalculateCoverageResponse] parsed result object
|
2881
|
+
# @yieldparam err [StandardError] error object if request failed
|
2882
|
+
#
|
2883
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CalculateCoverageResponse]
|
2884
|
+
#
|
2885
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2886
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2887
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2888
|
+
def calculate_project_location_agent_test_case_coverage(agent, type: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2889
|
+
command = make_simple_command(:get, 'v3/{+agent}/testCases:calculateCoverage', options)
|
2890
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CalculateCoverageResponse::Representation
|
2891
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CalculateCoverageResponse
|
2892
|
+
command.params['agent'] = agent unless agent.nil?
|
2893
|
+
command.query['type'] = type unless type.nil?
|
2894
|
+
command.query['fields'] = fields unless fields.nil?
|
2895
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2896
|
+
execute_or_queue_command(command, &block)
|
2897
|
+
end
|
2898
|
+
|
2899
|
+
# Creates a test case for the given agent.
|
2900
|
+
# @param [String] parent
|
2901
|
+
# Required. The agent to create the test case for. Format: `projects//locations//
|
2902
|
+
# agents/`.
|
2903
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase] google_cloud_dialogflow_cx_v3_test_case_object
|
2904
|
+
# @param [String] fields
|
2905
|
+
# Selector specifying which fields to include in a partial response.
|
2906
|
+
# @param [String] quota_user
|
2907
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2908
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2909
|
+
# @param [Google::Apis::RequestOptions] options
|
2910
|
+
# Request-specific options
|
2911
|
+
#
|
2912
|
+
# @yield [result, err] Result & error if block supplied
|
2913
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase] parsed result object
|
2914
|
+
# @yieldparam err [StandardError] error object if request failed
|
2915
|
+
#
|
2916
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase]
|
2917
|
+
#
|
2918
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2919
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2920
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2921
|
+
def create_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3_test_case_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2922
|
+
command = make_simple_command(:post, 'v3/{+parent}/testCases', options)
|
2923
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
|
2924
|
+
command.request_object = google_cloud_dialogflow_cx_v3_test_case_object
|
2925
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
|
2926
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase
|
2927
|
+
command.params['parent'] = parent unless parent.nil?
|
2928
|
+
command.query['fields'] = fields unless fields.nil?
|
2929
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2930
|
+
execute_or_queue_command(command, &block)
|
2931
|
+
end
|
2932
|
+
|
2933
|
+
# Exports the test cases under the agent to a Cloud Storage bucket or a local
|
2934
|
+
# file. Filter can be applied to export a subset of test cases.
|
2935
|
+
# @param [String] parent
|
2936
|
+
# Required. The agent where to export test cases from. Format: `projects//
|
2937
|
+
# locations//agents/`.
|
2938
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportTestCasesRequest] google_cloud_dialogflow_cx_v3_export_test_cases_request_object
|
2939
|
+
# @param [String] fields
|
2940
|
+
# Selector specifying which fields to include in a partial response.
|
2941
|
+
# @param [String] quota_user
|
2942
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2943
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2944
|
+
# @param [Google::Apis::RequestOptions] options
|
2945
|
+
# Request-specific options
|
2946
|
+
#
|
2947
|
+
# @yield [result, err] Result & error if block supplied
|
2948
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
2949
|
+
# @yieldparam err [StandardError] error object if request failed
|
2950
|
+
#
|
2951
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
2952
|
+
#
|
2953
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2954
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2955
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2956
|
+
def export_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3_export_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2957
|
+
command = make_simple_command(:post, 'v3/{+parent}/testCases:export', options)
|
2958
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportTestCasesRequest::Representation
|
2959
|
+
command.request_object = google_cloud_dialogflow_cx_v3_export_test_cases_request_object
|
2960
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
2961
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
2962
|
+
command.params['parent'] = parent unless parent.nil?
|
2963
|
+
command.query['fields'] = fields unless fields.nil?
|
2964
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2965
|
+
execute_or_queue_command(command, &block)
|
2966
|
+
end
|
2967
|
+
|
2968
|
+
# Gets a test case.
|
2969
|
+
# @param [String] name
|
2970
|
+
# Required. The name of the testcase. Format: `projects//locations//agents//
|
2971
|
+
# testCases/`.
|
2972
|
+
# @param [String] fields
|
2973
|
+
# Selector specifying which fields to include in a partial response.
|
2974
|
+
# @param [String] quota_user
|
2975
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2976
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2977
|
+
# @param [Google::Apis::RequestOptions] options
|
2978
|
+
# Request-specific options
|
2979
|
+
#
|
2980
|
+
# @yield [result, err] Result & error if block supplied
|
2981
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase] parsed result object
|
2982
|
+
# @yieldparam err [StandardError] error object if request failed
|
2983
|
+
#
|
2984
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase]
|
2985
|
+
#
|
2986
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2987
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2988
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2989
|
+
def get_project_location_agent_test_case(name, fields: nil, quota_user: nil, options: nil, &block)
|
2990
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
2991
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
|
2992
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase
|
2993
|
+
command.params['name'] = name unless name.nil?
|
2994
|
+
command.query['fields'] = fields unless fields.nil?
|
2995
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2996
|
+
execute_or_queue_command(command, &block)
|
2997
|
+
end
|
2998
|
+
|
2999
|
+
# Imports the test cases from a Cloud Storage bucket or a local file. It always
|
3000
|
+
# creates new test cases and won't overwite any existing ones. The provided ID
|
3001
|
+
# in the imported test case is neglected.
|
3002
|
+
# @param [String] parent
|
3003
|
+
# Required. The agent to import test cases to. Format: `projects//locations//
|
3004
|
+
# agents/`.
|
3005
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportTestCasesRequest] google_cloud_dialogflow_cx_v3_import_test_cases_request_object
|
3006
|
+
# @param [String] fields
|
3007
|
+
# Selector specifying which fields to include in a partial response.
|
3008
|
+
# @param [String] quota_user
|
3009
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3010
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3011
|
+
# @param [Google::Apis::RequestOptions] options
|
3012
|
+
# Request-specific options
|
3013
|
+
#
|
3014
|
+
# @yield [result, err] Result & error if block supplied
|
3015
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
3016
|
+
# @yieldparam err [StandardError] error object if request failed
|
3017
|
+
#
|
3018
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
3019
|
+
#
|
3020
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3021
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3022
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3023
|
+
def import_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3_import_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3024
|
+
command = make_simple_command(:post, 'v3/{+parent}/testCases:import', options)
|
3025
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportTestCasesRequest::Representation
|
3026
|
+
command.request_object = google_cloud_dialogflow_cx_v3_import_test_cases_request_object
|
3027
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
3028
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
3029
|
+
command.params['parent'] = parent unless parent.nil?
|
3030
|
+
command.query['fields'] = fields unless fields.nil?
|
3031
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3032
|
+
execute_or_queue_command(command, &block)
|
3033
|
+
end
|
3034
|
+
|
3035
|
+
# Fetches a list of test cases for a given agent.
|
3036
|
+
# @param [String] parent
|
3037
|
+
# Required. The agent to list all pages for. Format: `projects//locations//
|
3038
|
+
# agents/`.
|
3039
|
+
# @param [Fixnum] page_size
|
3040
|
+
# The maximum number of items to return in a single page. By default 20. Note
|
3041
|
+
# that when TestCaseView = FULL, the maximum page size allowed is 20. When
|
3042
|
+
# TestCaseView = BASIC, the maximum page size allowed is 500.
|
3043
|
+
# @param [String] page_token
|
3044
|
+
# The next_page_token value returned from a previous list request.
|
3045
|
+
# @param [String] view
|
3046
|
+
# Specifies whether response should include all fields or just the metadata.
|
3047
|
+
# @param [String] fields
|
3048
|
+
# Selector specifying which fields to include in a partial response.
|
3049
|
+
# @param [String] quota_user
|
3050
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3051
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3052
|
+
# @param [Google::Apis::RequestOptions] options
|
3053
|
+
# Request-specific options
|
3054
|
+
#
|
3055
|
+
# @yield [result, err] Result & error if block supplied
|
3056
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCasesResponse] parsed result object
|
3057
|
+
# @yieldparam err [StandardError] error object if request failed
|
3058
|
+
#
|
3059
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCasesResponse]
|
3060
|
+
#
|
3061
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3062
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3063
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3064
|
+
def list_project_location_agent_test_cases(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3065
|
+
command = make_simple_command(:get, 'v3/{+parent}/testCases', options)
|
3066
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCasesResponse::Representation
|
3067
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCasesResponse
|
3068
|
+
command.params['parent'] = parent unless parent.nil?
|
3069
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3070
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3071
|
+
command.query['view'] = view unless view.nil?
|
3072
|
+
command.query['fields'] = fields unless fields.nil?
|
3073
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3074
|
+
execute_or_queue_command(command, &block)
|
3075
|
+
end
|
3076
|
+
|
3077
|
+
# Updates the specified test case.
|
3078
|
+
# @param [String] name
|
3079
|
+
# The unique identifier of the test case. TestCases.CreateTestCase will populate
|
3080
|
+
# the name automatically. Otherwise use format: `projects//locations//agents/ /
|
3081
|
+
# testCases/`.
|
3082
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase] google_cloud_dialogflow_cx_v3_test_case_object
|
3083
|
+
# @param [String] update_mask
|
3084
|
+
# Required. The mask to specify which fields should be updated. Only a test case'
|
3085
|
+
# s metadata and replayed_conversation_turns may be updated. The original
|
3086
|
+
# test_case_conversation_turns may not be updated.
|
3087
|
+
# @param [String] fields
|
3088
|
+
# Selector specifying which fields to include in a partial response.
|
3089
|
+
# @param [String] quota_user
|
3090
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3091
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3092
|
+
# @param [Google::Apis::RequestOptions] options
|
3093
|
+
# Request-specific options
|
3094
|
+
#
|
3095
|
+
# @yield [result, err] Result & error if block supplied
|
3096
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase] parsed result object
|
3097
|
+
# @yieldparam err [StandardError] error object if request failed
|
3098
|
+
#
|
3099
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase]
|
3100
|
+
#
|
3101
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3102
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3103
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3104
|
+
def patch_project_location_agent_test_case(name, google_cloud_dialogflow_cx_v3_test_case_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3105
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
3106
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
|
3107
|
+
command.request_object = google_cloud_dialogflow_cx_v3_test_case_object
|
3108
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
|
3109
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase
|
3110
|
+
command.params['name'] = name unless name.nil?
|
3111
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3112
|
+
command.query['fields'] = fields unless fields.nil?
|
3113
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3114
|
+
execute_or_queue_command(command, &block)
|
3115
|
+
end
|
3116
|
+
|
3117
|
+
# Kicks off a test case run.
|
3118
|
+
# @param [String] projects_id
|
3119
|
+
# @param [String] locations_id
|
3120
|
+
# @param [String] agents_id
|
3121
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunTestCaseRequest] google_cloud_dialogflow_cx_v3_run_test_case_request_object
|
3122
|
+
# @param [String] fields
|
3123
|
+
# Selector specifying which fields to include in a partial response.
|
3124
|
+
# @param [String] quota_user
|
3125
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3126
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3127
|
+
# @param [Google::Apis::RequestOptions] options
|
3128
|
+
# Request-specific options
|
3129
|
+
#
|
3130
|
+
# @yield [result, err] Result & error if block supplied
|
3131
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
3132
|
+
# @yieldparam err [StandardError] error object if request failed
|
3133
|
+
#
|
3134
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
3135
|
+
#
|
3136
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3137
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3138
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3139
|
+
def run_project_location_agent_test_case(projects_id, locations_id, agents_id, google_cloud_dialogflow_cx_v3_run_test_case_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3140
|
+
command = make_simple_command(:post, 'v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:run', options)
|
3141
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunTestCaseRequest::Representation
|
3142
|
+
command.request_object = google_cloud_dialogflow_cx_v3_run_test_case_request_object
|
3143
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
3144
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
3145
|
+
command.params['projectsId'] = projects_id unless projects_id.nil?
|
3146
|
+
command.params['locationsId'] = locations_id unless locations_id.nil?
|
3147
|
+
command.params['agentsId'] = agents_id unless agents_id.nil?
|
3148
|
+
command.query['fields'] = fields unless fields.nil?
|
3149
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3150
|
+
execute_or_queue_command(command, &block)
|
3151
|
+
end
|
3152
|
+
|
3153
|
+
# Fetches a list of results for a given test case.
|
3154
|
+
# @param [String] parent
|
3155
|
+
# Required. The test case to list results for. Format: `projects//locations//
|
3156
|
+
# agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list
|
3157
|
+
# results across multiple test cases.
|
3158
|
+
# @param [String] filter
|
3159
|
+
# The filter expression used to filter test case results. See [API Filtering](
|
3160
|
+
# https://aip.dev/160). The expression is case insensitive. Only 'AND' is
|
3161
|
+
# supported for logical operators. The supported syntax is listed below in
|
3162
|
+
# detail: [AND ] ... [AND latest] The supported fields and operators are: field
|
3163
|
+
# operator `environment` `=`, `IN` (Use value `draft` for draft environment) `
|
3164
|
+
# test_time` `>`, `<` `latest` only returns the latest test result in all
|
3165
|
+
# results for each test case. Examples: * "environment=draft AND latest" matches
|
3166
|
+
# the latest test result for each test case in the draft environment. * "
|
3167
|
+
# environment IN (e1,e2)" matches any test case results with an environment
|
3168
|
+
# resource name of either "e1" or "e2". * "test_time > 1602540713" matches any
|
3169
|
+
# test case results with test time later than a unix timestamp in seconds
|
3170
|
+
# 1602540713.
|
3171
|
+
# @param [Fixnum] page_size
|
3172
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
3173
|
+
# most 1000.
|
3174
|
+
# @param [String] page_token
|
3175
|
+
# The next_page_token value returned from a previous list request.
|
3176
|
+
# @param [String] fields
|
3177
|
+
# Selector specifying which fields to include in a partial response.
|
3178
|
+
# @param [String] quota_user
|
3179
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3180
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3181
|
+
# @param [Google::Apis::RequestOptions] options
|
3182
|
+
# Request-specific options
|
3183
|
+
#
|
3184
|
+
# @yield [result, err] Result & error if block supplied
|
3185
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCaseResultsResponse] parsed result object
|
3186
|
+
# @yieldparam err [StandardError] error object if request failed
|
3187
|
+
#
|
3188
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCaseResultsResponse]
|
3189
|
+
#
|
3190
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3191
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3192
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3193
|
+
def list_project_location_agent_test_case_results(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3194
|
+
command = make_simple_command(:get, 'v3/{+parent}/results', options)
|
3195
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCaseResultsResponse::Representation
|
3196
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCaseResultsResponse
|
3197
|
+
command.params['parent'] = parent unless parent.nil?
|
3198
|
+
command.query['filter'] = filter unless filter.nil?
|
3199
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3200
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3201
|
+
command.query['fields'] = fields unless fields.nil?
|
3202
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3203
|
+
execute_or_queue_command(command, &block)
|
3204
|
+
end
|
3205
|
+
|
3206
|
+
# Creates a webhook in the specified agent.
|
3207
|
+
# @param [String] parent
|
3208
|
+
# Required. The agent to create a webhook for. Format: `projects//locations//
|
3209
|
+
# agents/`.
|
3210
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook] google_cloud_dialogflow_cx_v3_webhook_object
|
3211
|
+
# @param [String] fields
|
3212
|
+
# Selector specifying which fields to include in a partial response.
|
3213
|
+
# @param [String] quota_user
|
3214
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3215
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3216
|
+
# @param [Google::Apis::RequestOptions] options
|
3217
|
+
# Request-specific options
|
3218
|
+
#
|
3219
|
+
# @yield [result, err] Result & error if block supplied
|
3220
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook] parsed result object
|
3221
|
+
# @yieldparam err [StandardError] error object if request failed
|
3222
|
+
#
|
3223
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook]
|
3224
|
+
#
|
3225
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3226
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3227
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3228
|
+
def create_project_location_agent_webhook(parent, google_cloud_dialogflow_cx_v3_webhook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3229
|
+
command = make_simple_command(:post, 'v3/{+parent}/webhooks', options)
|
3230
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
|
3231
|
+
command.request_object = google_cloud_dialogflow_cx_v3_webhook_object
|
3232
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
|
3233
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
|
3234
|
+
command.params['parent'] = parent unless parent.nil?
|
3235
|
+
command.query['fields'] = fields unless fields.nil?
|
3236
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3237
|
+
execute_or_queue_command(command, &block)
|
3238
|
+
end
|
3239
|
+
|
3240
|
+
# Deletes the specified webhook.
|
3241
|
+
# @param [String] name
|
3242
|
+
# Required. The name of the webhook to delete. Format: `projects//locations//
|
3243
|
+
# agents//webhooks/`.
|
3244
|
+
# @param [Boolean] force
|
3245
|
+
# This field has no effect for webhook not being used. For webhooks that are
|
3246
|
+
# used by pages/flows/transition route groups: * If `force` is set to false, an
|
3247
|
+
# error will be returned with message indicating the referenced resources. * If `
|
3248
|
+
# force` is set to true, Dialogflow will remove the webhook, as well as any
|
3249
|
+
# references to the webhook (i.e. Webhook and tagin fulfillments that point to
|
3250
|
+
# this webhook will be removed).
|
3251
|
+
# @param [String] fields
|
3252
|
+
# Selector specifying which fields to include in a partial response.
|
3253
|
+
# @param [String] quota_user
|
3254
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3255
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3256
|
+
# @param [Google::Apis::RequestOptions] options
|
3257
|
+
# Request-specific options
|
3258
|
+
#
|
3259
|
+
# @yield [result, err] Result & error if block supplied
|
3260
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
3261
|
+
# @yieldparam err [StandardError] error object if request failed
|
3262
|
+
#
|
3263
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
3264
|
+
#
|
3265
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3266
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3267
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3268
|
+
def delete_project_location_agent_webhook(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3269
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
3270
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
3271
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
3272
|
+
command.params['name'] = name unless name.nil?
|
3273
|
+
command.query['force'] = force unless force.nil?
|
3274
|
+
command.query['fields'] = fields unless fields.nil?
|
3275
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3276
|
+
execute_or_queue_command(command, &block)
|
3277
|
+
end
|
3278
|
+
|
3279
|
+
# Retrieves the specified webhook.
|
3280
|
+
# @param [String] name
|
3281
|
+
# Required. The name of the webhook. Format: `projects//locations//agents//
|
3282
|
+
# webhooks/`.
|
3283
|
+
# @param [String] fields
|
3284
|
+
# Selector specifying which fields to include in a partial response.
|
3285
|
+
# @param [String] quota_user
|
3286
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3287
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3288
|
+
# @param [Google::Apis::RequestOptions] options
|
3289
|
+
# Request-specific options
|
3290
|
+
#
|
3291
|
+
# @yield [result, err] Result & error if block supplied
|
3292
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook] parsed result object
|
3293
|
+
# @yieldparam err [StandardError] error object if request failed
|
3294
|
+
#
|
3295
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook]
|
3296
|
+
#
|
3297
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3298
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3299
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3300
|
+
def get_project_location_agent_webhook(name, fields: nil, quota_user: nil, options: nil, &block)
|
3301
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
3302
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
|
3303
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
|
3304
|
+
command.params['name'] = name unless name.nil?
|
3305
|
+
command.query['fields'] = fields unless fields.nil?
|
3306
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3307
|
+
execute_or_queue_command(command, &block)
|
3308
|
+
end
|
3309
|
+
|
3310
|
+
# Returns the list of all webhooks in the specified agent.
|
3311
|
+
# @param [String] parent
|
3312
|
+
# Required. The agent to list all webhooks for. Format: `projects//locations//
|
3313
|
+
# agents/`.
|
3314
|
+
# @param [Fixnum] page_size
|
3315
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
3316
|
+
# most 1000.
|
3317
|
+
# @param [String] page_token
|
3318
|
+
# The next_page_token value returned from a previous list request.
|
3319
|
+
# @param [String] fields
|
3320
|
+
# Selector specifying which fields to include in a partial response.
|
3321
|
+
# @param [String] quota_user
|
3322
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3323
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3324
|
+
# @param [Google::Apis::RequestOptions] options
|
3325
|
+
# Request-specific options
|
3326
|
+
#
|
3327
|
+
# @yield [result, err] Result & error if block supplied
|
3328
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListWebhooksResponse] parsed result object
|
3329
|
+
# @yieldparam err [StandardError] error object if request failed
|
3330
|
+
#
|
3331
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListWebhooksResponse]
|
3332
|
+
#
|
3333
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3334
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3335
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3336
|
+
def list_project_location_agent_webhooks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3337
|
+
command = make_simple_command(:get, 'v3/{+parent}/webhooks', options)
|
3338
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListWebhooksResponse::Representation
|
3339
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListWebhooksResponse
|
3340
|
+
command.params['parent'] = parent unless parent.nil?
|
3341
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3342
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3343
|
+
command.query['fields'] = fields unless fields.nil?
|
3344
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3345
|
+
execute_or_queue_command(command, &block)
|
3346
|
+
end
|
3347
|
+
|
3348
|
+
# Updates the specified webhook.
|
3349
|
+
# @param [String] name
|
3350
|
+
# The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook
|
3351
|
+
# method. Webhooks.CreateWebhook populates the name automatically. Format: `
|
3352
|
+
# projects//locations//agents//webhooks/`.
|
3353
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook] google_cloud_dialogflow_cx_v3_webhook_object
|
3354
|
+
# @param [String] update_mask
|
3355
|
+
# The mask to control which fields get updated. If the mask is not present, all
|
3356
|
+
# fields will be updated.
|
3357
|
+
# @param [String] fields
|
3358
|
+
# Selector specifying which fields to include in a partial response.
|
3359
|
+
# @param [String] quota_user
|
3360
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3361
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3362
|
+
# @param [Google::Apis::RequestOptions] options
|
3363
|
+
# Request-specific options
|
3364
|
+
#
|
3365
|
+
# @yield [result, err] Result & error if block supplied
|
3366
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook] parsed result object
|
3367
|
+
# @yieldparam err [StandardError] error object if request failed
|
3368
|
+
#
|
3369
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook]
|
3370
|
+
#
|
3371
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3372
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3373
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3374
|
+
def patch_project_location_agent_webhook(name, google_cloud_dialogflow_cx_v3_webhook_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3375
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
3376
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
|
3377
|
+
command.request_object = google_cloud_dialogflow_cx_v3_webhook_object
|
3378
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
|
3379
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
|
3380
|
+
command.params['name'] = name unless name.nil?
|
3381
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3382
|
+
command.query['fields'] = fields unless fields.nil?
|
3383
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3384
|
+
execute_or_queue_command(command, &block)
|
3385
|
+
end
|
3386
|
+
|
3387
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
3388
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
3389
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
3390
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
3391
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
3392
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
3393
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
3394
|
+
# corresponding to `Code.CANCELLED`.
|
3395
|
+
# @param [String] name
|
3396
|
+
# The name of the operation resource to be cancelled.
|
3397
|
+
# @param [String] fields
|
3398
|
+
# Selector specifying which fields to include in a partial response.
|
3399
|
+
# @param [String] quota_user
|
3400
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3401
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3402
|
+
# @param [Google::Apis::RequestOptions] options
|
3403
|
+
# Request-specific options
|
3404
|
+
#
|
3405
|
+
# @yield [result, err] Result & error if block supplied
|
3406
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
3407
|
+
# @yieldparam err [StandardError] error object if request failed
|
3408
|
+
#
|
3409
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
3410
|
+
#
|
3411
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3412
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3413
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3414
|
+
def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3415
|
+
command = make_simple_command(:post, 'v3/{+name}:cancel', options)
|
3416
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
3417
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
3418
|
+
command.params['name'] = name unless name.nil?
|
3419
|
+
command.query['fields'] = fields unless fields.nil?
|
3420
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3421
|
+
execute_or_queue_command(command, &block)
|
3422
|
+
end
|
3423
|
+
|
3424
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
3425
|
+
# to poll the operation result at intervals as recommended by the API service.
|
3426
|
+
# @param [String] name
|
3427
|
+
# The name of the operation resource.
|
3428
|
+
# @param [String] fields
|
3429
|
+
# Selector specifying which fields to include in a partial response.
|
3430
|
+
# @param [String] quota_user
|
3431
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3432
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3433
|
+
# @param [Google::Apis::RequestOptions] options
|
3434
|
+
# Request-specific options
|
3435
|
+
#
|
3436
|
+
# @yield [result, err] Result & error if block supplied
|
3437
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
3438
|
+
# @yieldparam err [StandardError] error object if request failed
|
3439
|
+
#
|
3440
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
3441
|
+
#
|
3442
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3443
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3444
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3445
|
+
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3446
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
3447
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
3448
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
3449
|
+
command.params['name'] = name unless name.nil?
|
3450
|
+
command.query['fields'] = fields unless fields.nil?
|
3451
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3452
|
+
execute_or_queue_command(command, &block)
|
3453
|
+
end
|
3454
|
+
|
3455
|
+
# Lists operations that match the specified filter in the request. If the server
|
3456
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
3457
|
+
# binding allows API services to override the binding to use different resource
|
3458
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
3459
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
3460
|
+
# service configuration. For backwards compatibility, the default name includes
|
3461
|
+
# the operations collection id, however overriding users must ensure the name
|
3462
|
+
# binding is the parent resource, without the operations collection id.
|
3463
|
+
# @param [String] name
|
3464
|
+
# The name of the operation's parent resource.
|
3465
|
+
# @param [String] filter
|
3466
|
+
# The standard list filter.
|
3467
|
+
# @param [Fixnum] page_size
|
3468
|
+
# The standard list page size.
|
3469
|
+
# @param [String] page_token
|
3470
|
+
# The standard list page token.
|
3471
|
+
# @param [String] fields
|
3472
|
+
# Selector specifying which fields to include in a partial response.
|
3473
|
+
# @param [String] quota_user
|
3474
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3475
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3476
|
+
# @param [Google::Apis::RequestOptions] options
|
3477
|
+
# Request-specific options
|
3478
|
+
#
|
3479
|
+
# @yield [result, err] Result & error if block supplied
|
3480
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse] parsed result object
|
3481
|
+
# @yieldparam err [StandardError] error object if request failed
|
3482
|
+
#
|
3483
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse]
|
3484
|
+
#
|
3485
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3486
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3487
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3488
|
+
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3489
|
+
command = make_simple_command(:get, 'v3/{+name}/operations', options)
|
3490
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse::Representation
|
3491
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse
|
3492
|
+
command.params['name'] = name unless name.nil?
|
3493
|
+
command.query['filter'] = filter unless filter.nil?
|
3494
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3495
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3496
|
+
command.query['fields'] = fields unless fields.nil?
|
3497
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3498
|
+
execute_or_queue_command(command, &block)
|
3499
|
+
end
|
3500
|
+
|
3501
|
+
# Create security settings in the specified location.
|
3502
|
+
# @param [String] parent
|
3503
|
+
# Required. The location to create an SecuritySettings for. Format: `projects//
|
3504
|
+
# locations/`.
|
3505
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] google_cloud_dialogflow_cx_v3_security_settings_object
|
3506
|
+
# @param [String] fields
|
3507
|
+
# Selector specifying which fields to include in a partial response.
|
3508
|
+
# @param [String] quota_user
|
3509
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3510
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3511
|
+
# @param [Google::Apis::RequestOptions] options
|
3512
|
+
# Request-specific options
|
3513
|
+
#
|
3514
|
+
# @yield [result, err] Result & error if block supplied
|
3515
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] parsed result object
|
3516
|
+
# @yieldparam err [StandardError] error object if request failed
|
3517
|
+
#
|
3518
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings]
|
3519
|
+
#
|
3520
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3521
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3522
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3523
|
+
def create_project_location_security_setting(parent, google_cloud_dialogflow_cx_v3_security_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3524
|
+
command = make_simple_command(:post, 'v3/{+parent}/securitySettings', options)
|
3525
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
|
3526
|
+
command.request_object = google_cloud_dialogflow_cx_v3_security_settings_object
|
3527
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
|
3528
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings
|
3529
|
+
command.params['parent'] = parent unless parent.nil?
|
3530
|
+
command.query['fields'] = fields unless fields.nil?
|
3531
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3532
|
+
execute_or_queue_command(command, &block)
|
3533
|
+
end
|
3534
|
+
|
3535
|
+
# Deletes the specified SecuritySettings.
|
3536
|
+
# @param [String] name
|
3537
|
+
# Required. The name of the SecuritySettings to delete. Format: `projects//
|
3538
|
+
# locations//securitySettings/`.
|
3539
|
+
# @param [String] fields
|
3540
|
+
# Selector specifying which fields to include in a partial response.
|
3541
|
+
# @param [String] quota_user
|
3542
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3543
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3544
|
+
# @param [Google::Apis::RequestOptions] options
|
3545
|
+
# Request-specific options
|
3546
|
+
#
|
3547
|
+
# @yield [result, err] Result & error if block supplied
|
3548
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
3549
|
+
# @yieldparam err [StandardError] error object if request failed
|
3550
|
+
#
|
3551
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
3552
|
+
#
|
3553
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3554
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3555
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3556
|
+
def delete_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil, &block)
|
3557
|
+
command = make_simple_command(:delete, 'v3/{+name}', options)
|
3558
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
3559
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
3560
|
+
command.params['name'] = name unless name.nil?
|
3561
|
+
command.query['fields'] = fields unless fields.nil?
|
3562
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3563
|
+
execute_or_queue_command(command, &block)
|
3564
|
+
end
|
3565
|
+
|
3566
|
+
# Retrieves the specified SecuritySettings. The returned settings may be stale
|
3567
|
+
# by up to 1 minute.
|
3568
|
+
# @param [String] name
|
3569
|
+
# Required. Resource name of the settings. Format: `projects//locations//
|
3570
|
+
# securitySettings/`.
|
3571
|
+
# @param [String] fields
|
3572
|
+
# Selector specifying which fields to include in a partial response.
|
3573
|
+
# @param [String] quota_user
|
3574
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3575
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3576
|
+
# @param [Google::Apis::RequestOptions] options
|
3577
|
+
# Request-specific options
|
3578
|
+
#
|
3579
|
+
# @yield [result, err] Result & error if block supplied
|
3580
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] parsed result object
|
3581
|
+
# @yieldparam err [StandardError] error object if request failed
|
3582
|
+
#
|
3583
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings]
|
3584
|
+
#
|
3585
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3586
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3587
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3588
|
+
def get_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil, &block)
|
3589
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
3590
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
|
3591
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings
|
3592
|
+
command.params['name'] = name unless name.nil?
|
3593
|
+
command.query['fields'] = fields unless fields.nil?
|
3594
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3595
|
+
execute_or_queue_command(command, &block)
|
3596
|
+
end
|
3597
|
+
|
3598
|
+
# Returns the list of all security settings in the specified location.
|
3599
|
+
# @param [String] parent
|
3600
|
+
# Required. The location to list all security settings for. Format: `projects//
|
3601
|
+
# locations/`.
|
3602
|
+
# @param [Fixnum] page_size
|
3603
|
+
# The maximum number of items to return in a single page. By default 20 and at
|
3604
|
+
# most 100.
|
3605
|
+
# @param [String] page_token
|
3606
|
+
# The next_page_token value returned from a previous list request.
|
3607
|
+
# @param [String] fields
|
3608
|
+
# Selector specifying which fields to include in a partial response.
|
3609
|
+
# @param [String] quota_user
|
3610
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3611
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3612
|
+
# @param [Google::Apis::RequestOptions] options
|
3613
|
+
# Request-specific options
|
3614
|
+
#
|
3615
|
+
# @yield [result, err] Result & error if block supplied
|
3616
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSecuritySettingsResponse] parsed result object
|
3617
|
+
# @yieldparam err [StandardError] error object if request failed
|
3618
|
+
#
|
3619
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSecuritySettingsResponse]
|
3620
|
+
#
|
3621
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3622
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3623
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3624
|
+
def list_project_location_security_settings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3625
|
+
command = make_simple_command(:get, 'v3/{+parent}/securitySettings', options)
|
3626
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSecuritySettingsResponse::Representation
|
3627
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSecuritySettingsResponse
|
3628
|
+
command.params['parent'] = parent unless parent.nil?
|
3629
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3630
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3631
|
+
command.query['fields'] = fields unless fields.nil?
|
3632
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3633
|
+
execute_or_queue_command(command, &block)
|
3634
|
+
end
|
3635
|
+
|
3636
|
+
# Updates the specified SecuritySettings.
|
3637
|
+
# @param [String] name
|
3638
|
+
# Required. Resource name of the settings. Format: `projects//locations//
|
3639
|
+
# securitySettings/`.
|
3640
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] google_cloud_dialogflow_cx_v3_security_settings_object
|
3641
|
+
# @param [String] update_mask
|
3642
|
+
# Required. The mask to control which fields get updated. If the mask is not
|
3643
|
+
# present, all fields will be updated.
|
3644
|
+
# @param [String] fields
|
3645
|
+
# Selector specifying which fields to include in a partial response.
|
3646
|
+
# @param [String] quota_user
|
3647
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3648
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3649
|
+
# @param [Google::Apis::RequestOptions] options
|
3650
|
+
# Request-specific options
|
3651
|
+
#
|
3652
|
+
# @yield [result, err] Result & error if block supplied
|
3653
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] parsed result object
|
3654
|
+
# @yieldparam err [StandardError] error object if request failed
|
3655
|
+
#
|
3656
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings]
|
3657
|
+
#
|
3658
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3659
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3660
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3661
|
+
def patch_project_location_security_setting(name, google_cloud_dialogflow_cx_v3_security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3662
|
+
command = make_simple_command(:patch, 'v3/{+name}', options)
|
3663
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
|
3664
|
+
command.request_object = google_cloud_dialogflow_cx_v3_security_settings_object
|
3665
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
|
3666
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings
|
3667
|
+
command.params['name'] = name unless name.nil?
|
3668
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3669
|
+
command.query['fields'] = fields unless fields.nil?
|
3670
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3671
|
+
execute_or_queue_command(command, &block)
|
3672
|
+
end
|
3673
|
+
|
3674
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
3675
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
3676
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
3677
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
3678
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
3679
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
3680
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
3681
|
+
# corresponding to `Code.CANCELLED`.
|
3682
|
+
# @param [String] name
|
3683
|
+
# The name of the operation resource to be cancelled.
|
3684
|
+
# @param [String] fields
|
3685
|
+
# Selector specifying which fields to include in a partial response.
|
3686
|
+
# @param [String] quota_user
|
3687
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3688
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3689
|
+
# @param [Google::Apis::RequestOptions] options
|
3690
|
+
# Request-specific options
|
3691
|
+
#
|
3692
|
+
# @yield [result, err] Result & error if block supplied
|
3693
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleProtobufEmpty] parsed result object
|
3694
|
+
# @yieldparam err [StandardError] error object if request failed
|
3695
|
+
#
|
3696
|
+
# @return [Google::Apis::DialogflowV3::GoogleProtobufEmpty]
|
3697
|
+
#
|
3698
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3699
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3700
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3701
|
+
def cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3702
|
+
command = make_simple_command(:post, 'v3/{+name}:cancel', options)
|
3703
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
|
3704
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleProtobufEmpty
|
3705
|
+
command.params['name'] = name unless name.nil?
|
3706
|
+
command.query['fields'] = fields unless fields.nil?
|
3707
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3708
|
+
execute_or_queue_command(command, &block)
|
3709
|
+
end
|
3710
|
+
|
3711
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
3712
|
+
# to poll the operation result at intervals as recommended by the API service.
|
3713
|
+
# @param [String] name
|
3714
|
+
# The name of the operation resource.
|
3715
|
+
# @param [String] fields
|
3716
|
+
# Selector specifying which fields to include in a partial response.
|
3717
|
+
# @param [String] quota_user
|
3718
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3719
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3720
|
+
# @param [Google::Apis::RequestOptions] options
|
3721
|
+
# Request-specific options
|
3722
|
+
#
|
3723
|
+
# @yield [result, err] Result & error if block supplied
|
3724
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
3725
|
+
# @yieldparam err [StandardError] error object if request failed
|
3726
|
+
#
|
3727
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
3728
|
+
#
|
3729
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3730
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3731
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3732
|
+
def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3733
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
3734
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
3735
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
3736
|
+
command.params['name'] = name unless name.nil?
|
3737
|
+
command.query['fields'] = fields unless fields.nil?
|
3738
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3739
|
+
execute_or_queue_command(command, &block)
|
3740
|
+
end
|
3741
|
+
|
3742
|
+
# Lists operations that match the specified filter in the request. If the server
|
3743
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
3744
|
+
# binding allows API services to override the binding to use different resource
|
3745
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
3746
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
3747
|
+
# service configuration. For backwards compatibility, the default name includes
|
3748
|
+
# the operations collection id, however overriding users must ensure the name
|
3749
|
+
# binding is the parent resource, without the operations collection id.
|
3750
|
+
# @param [String] name
|
3751
|
+
# The name of the operation's parent resource.
|
3752
|
+
# @param [String] filter
|
3753
|
+
# The standard list filter.
|
3754
|
+
# @param [Fixnum] page_size
|
3755
|
+
# The standard list page size.
|
3756
|
+
# @param [String] page_token
|
3757
|
+
# The standard list page token.
|
3758
|
+
# @param [String] fields
|
3759
|
+
# Selector specifying which fields to include in a partial response.
|
3760
|
+
# @param [String] quota_user
|
3761
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3762
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3763
|
+
# @param [Google::Apis::RequestOptions] options
|
3764
|
+
# Request-specific options
|
3765
|
+
#
|
3766
|
+
# @yield [result, err] Result & error if block supplied
|
3767
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse] parsed result object
|
3768
|
+
# @yieldparam err [StandardError] error object if request failed
|
3769
|
+
#
|
3770
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse]
|
3771
|
+
#
|
3772
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3773
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3774
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3775
|
+
def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3776
|
+
command = make_simple_command(:get, 'v3/{+name}/operations', options)
|
3777
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse::Representation
|
3778
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse
|
3779
|
+
command.params['name'] = name unless name.nil?
|
3780
|
+
command.query['filter'] = filter unless filter.nil?
|
3781
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3782
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3783
|
+
command.query['fields'] = fields unless fields.nil?
|
3784
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3785
|
+
execute_or_queue_command(command, &block)
|
3786
|
+
end
|
3787
|
+
|
3788
|
+
protected
|
3789
|
+
|
3790
|
+
def apply_command_defaults(command)
|
3791
|
+
command.query['key'] = key unless key.nil?
|
3792
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3793
|
+
end
|
3794
|
+
end
|
3795
|
+
end
|
3796
|
+
end
|
3797
|
+
end
|