ibm_watson 1.6.0 → 2.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +23 -1
- data/lib/ibm_watson/assistant_v1.rb +212 -50
- data/lib/ibm_watson/assistant_v2.rb +66 -12
- data/lib/ibm_watson/compare_comply_v1.rb +33 -20
- data/lib/ibm_watson/discovery_v1.rb +131 -12
- data/lib/ibm_watson/discovery_v2.rb +138 -12
- data/lib/ibm_watson/language_translator_v3.rb +59 -26
- data/lib/ibm_watson/natural_language_classifier_v1.rb +3 -1
- data/lib/ibm_watson/natural_language_understanding_v1.rb +15 -13
- data/lib/ibm_watson/personality_insights_v3.rb +14 -12
- data/lib/ibm_watson/speech_to_text_v1.rb +24 -18
- data/lib/ibm_watson/text_to_speech_v1.rb +96 -119
- data/lib/ibm_watson/tone_analyzer_v3.rb +11 -12
- data/lib/ibm_watson/version.rb +1 -1
- data/lib/ibm_watson/visual_recognition_v3.rb +23 -12
- data/lib/ibm_watson/visual_recognition_v4.rb +59 -20
- data/test/integration/test_assistant_v1.rb +9 -0
- data/test/integration/test_assistant_v2.rb +9 -0
- data/test/integration/test_text_to_speech_v1.rb +3 -3
- data/test/unit/test_assistant_v1.rb +51 -0
- data/test/unit/test_assistant_v2.rb +51 -0
- data/test/unit/test_discovery_v2.rb +1 -1
- data/test/unit/test_text_to_speech_v1.rb +7 -7
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bc3db642616c3756e70289cc12aa10b1daa99c33a8e8e6adbae812c8c62cc17c
|
4
|
+
data.tar.gz: b494d458fb1b8d0fb113689f7f074dd31b1e2c45dd25c946b984fc6925e4ddc8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d51d87ebf4b289227eafce305ddcd4420eeebcb36f69eb134af2bf4bc7176e5b57400efb61f9c45482a741086b26ca838494f25272ee149a8b84aeb1eb2ed01c
|
7
|
+
data.tar.gz: 3a21b68b6f2d6bd4931125ad1154a1dbf59ed46441486c5791d59630423a951c976bb342e79754558087ba75ce9111f9ffbf6093d8696d565482786a9a359e63
|
data/README.md
CHANGED
@@ -34,6 +34,12 @@ Ruby gem to quickly get started with the various [IBM Watson][wdc] services.
|
|
34
34
|
|
35
35
|
</details>
|
36
36
|
|
37
|
+
## ANNOUNCEMENTS!
|
38
|
+
### Personality Insights Deprecation
|
39
|
+
IBM® will begin sunsetting IBM Watson™ Personality Insights on 1 December 2020. For a period of one year from this date, you will still be able to use Watson Personality Insights. However, as of 1 December 2021, the offering will no longer be available.
|
40
|
+
|
41
|
+
As an alternative, we encourage you to consider migrating to IBM Watson™ [Natural Language Understanding](https://cloud.ibm.com/docs/natural-language-understanding), a service on IBM Cloud® that uses deep learning to extract data and insights from text such as keywords, categories, sentiment, emotion, and syntax to provide insights for your business or industry. For more information, see About Natural Language Understanding.
|
42
|
+
|
37
43
|
## Before you begin
|
38
44
|
|
39
45
|
* You need an [IBM Cloud][ibm-cloud-onboarding] account.
|
@@ -269,7 +275,7 @@ Result: "<response returned by service>"
|
|
269
275
|
|
270
276
|
### Transaction IDs
|
271
277
|
|
272
|
-
Every SDK call
|
278
|
+
Every SDK call returns a response with a transaction ID in the `X-Global-Transaction-Id` header. Together the service instance region, this ID helps support teams troubleshoot issues from relevant logs.
|
273
279
|
|
274
280
|
```ruby
|
275
281
|
require "ibm_watson"
|
@@ -289,6 +295,22 @@ rescue IBMCloudSdkCore::ApiException => e
|
|
289
295
|
end
|
290
296
|
```
|
291
297
|
|
298
|
+
However, the transaction ID isn't available when the API doesn't return a response for some reason. In that case, you can set your own transaction ID in the request. For example, replace `<my-unique-transaction-id>` in the following example with a unique transaction ID.
|
299
|
+
|
300
|
+
```ruby
|
301
|
+
require "ibm_watson"
|
302
|
+
include IBMWatson
|
303
|
+
|
304
|
+
assistant = AssistantV1.new(
|
305
|
+
authenticator: "<authenticator>"
|
306
|
+
version: "2017-04-21"
|
307
|
+
)
|
308
|
+
|
309
|
+
response = assistant.headers(
|
310
|
+
"X-Global-Transaction-Id" => "<my-unique-transaction-id>"
|
311
|
+
).list_workspaces
|
312
|
+
```
|
313
|
+
|
292
314
|
## Configuring the HTTP client
|
293
315
|
|
294
316
|
To set client configs like timeout or proxy use the `configure_http_client` function and pass in the configurations.
|
@@ -13,7 +13,9 @@
|
|
13
13
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
14
|
# See the License for the specific language governing permissions and
|
15
15
|
# limitations under the License.
|
16
|
-
|
16
|
+
#
|
17
|
+
# IBM OpenAPI SDK Code Generator Version: 3.17.0-8d569e8f-20201030-142059
|
18
|
+
#
|
17
19
|
# The IBM Watson™ Assistant service combines machine learning, natural language
|
18
20
|
# understanding, and an integrated dialog editor to create conversation flows between your
|
19
21
|
# apps and your users.
|
@@ -35,21 +37,14 @@ module IBMWatson
|
|
35
37
|
include Concurrent::Async
|
36
38
|
DEFAULT_SERVICE_NAME = "assistant"
|
37
39
|
DEFAULT_SERVICE_URL = "https://api.us-south.assistant.watson.cloud.ibm.com"
|
40
|
+
attr_accessor :version
|
38
41
|
##
|
39
42
|
# @!method initialize(args)
|
40
43
|
# Construct a new client for the Assistant service.
|
41
44
|
#
|
42
45
|
# @param args [Hash] The args to initialize with
|
43
|
-
# @option args version [String]
|
44
|
-
#
|
45
|
-
# incompatible way, a new minor version of the API is released.
|
46
|
-
# The service uses the API version for the date you specify, or
|
47
|
-
# the most recent version before that date. Note that you should
|
48
|
-
# not programmatically specify the current date at runtime, in
|
49
|
-
# case the API has been updated since your application's release.
|
50
|
-
# Instead, specify a version date that is compatible with your
|
51
|
-
# application, and don't change it until your application is
|
52
|
-
# ready for a later version.
|
46
|
+
# @option args version [String] Release date of the API version you want to use. Specify dates in YYYY-MM-DD
|
47
|
+
# format. The current version is `2020-04-01`.
|
53
48
|
# @option args service_url [String] The base service URL to use when contacting the service.
|
54
49
|
# The base service_url may differ between IBM Cloud regions.
|
55
50
|
# @option args authenticator [Object] The Authenticator instance to be configured for this service.
|
@@ -58,10 +53,10 @@ module IBMWatson
|
|
58
53
|
def initialize(args = {})
|
59
54
|
@__async_initialized__ = false
|
60
55
|
defaults = {}
|
61
|
-
defaults[:version] = nil
|
62
56
|
defaults[:service_url] = DEFAULT_SERVICE_URL
|
63
57
|
defaults[:service_name] = DEFAULT_SERVICE_NAME
|
64
58
|
defaults[:authenticator] = nil
|
59
|
+
defaults[:version] = nil
|
65
60
|
user_service_url = args[:service_url] unless args[:service_url].nil?
|
66
61
|
args = defaults.merge(args)
|
67
62
|
@version = args[:version]
|
@@ -105,6 +100,8 @@ module IBMWatson
|
|
105
100
|
def message(workspace_id:, input: nil, intents: nil, entities: nil, alternate_intents: nil, context: nil, output: nil, nodes_visited_details: nil)
|
106
101
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
107
102
|
|
103
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
104
|
+
|
108
105
|
headers = {
|
109
106
|
}
|
110
107
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "message")
|
@@ -141,17 +138,22 @@ module IBMWatson
|
|
141
138
|
#########################
|
142
139
|
|
143
140
|
##
|
144
|
-
# @!method list_workspaces(page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
141
|
+
# @!method list_workspaces(page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
145
142
|
# List workspaces.
|
146
143
|
# List the workspaces associated with a Watson Assistant service instance.
|
147
144
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
145
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
146
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
147
|
+
# `pagination` object in the response includes the `total` property.
|
148
148
|
# @param sort [String] The attribute by which returned workspaces will be sorted. To reverse the sort
|
149
149
|
# order, prefix the value with a minus sign (`-`).
|
150
150
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
151
151
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
152
152
|
# the response.
|
153
153
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
154
|
-
def list_workspaces(page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
154
|
+
def list_workspaces(page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
155
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
156
|
+
|
155
157
|
headers = {
|
156
158
|
}
|
157
159
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_workspaces")
|
@@ -160,6 +162,7 @@ module IBMWatson
|
|
160
162
|
params = {
|
161
163
|
"version" => @version,
|
162
164
|
"page_limit" => page_limit,
|
165
|
+
"include_count" => include_count,
|
163
166
|
"sort" => sort,
|
164
167
|
"cursor" => cursor,
|
165
168
|
"include_audit" => include_audit
|
@@ -178,7 +181,7 @@ module IBMWatson
|
|
178
181
|
end
|
179
182
|
|
180
183
|
##
|
181
|
-
# @!method create_workspace(name: nil, description: nil, language: nil,
|
184
|
+
# @!method create_workspace(name: nil, description: nil, language: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, webhooks: nil, intents: nil, entities: nil, include_audit: nil)
|
182
185
|
# Create workspace.
|
183
186
|
# Create a workspace based on component objects. You must provide workspace
|
184
187
|
# components defining the content of the new workspace.
|
@@ -187,21 +190,23 @@ module IBMWatson
|
|
187
190
|
# @param description [String] The description of the workspace. This string cannot contain carriage return,
|
188
191
|
# newline, or tab characters.
|
189
192
|
# @param language [String] The language of the workspace.
|
193
|
+
# @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
|
194
|
+
# @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
|
195
|
+
# input.
|
190
196
|
# @param metadata [Hash] Any metadata related to the workspace.
|
191
197
|
# @param learning_opt_out [Boolean] Whether training data from the workspace (including artifacts such as intents and
|
192
198
|
# entities) can be used by IBM for general service improvements. `true` indicates
|
193
199
|
# that workspace training data is not to be used.
|
194
200
|
# @param system_settings [WorkspaceSystemSettings] Global settings for the workspace.
|
201
|
+
# @param webhooks [Array[Webhook]]
|
195
202
|
# @param intents [Array[CreateIntent]] An array of objects defining the intents for the workspace.
|
196
203
|
# @param entities [Array[CreateEntity]] An array of objects describing the entities for the workspace.
|
197
|
-
# @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
|
198
|
-
# @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
|
199
|
-
# input.
|
200
|
-
# @param webhooks [Array[Webhook]]
|
201
204
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
202
205
|
# the response.
|
203
206
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
204
|
-
def create_workspace(name: nil, description: nil, language: nil,
|
207
|
+
def create_workspace(name: nil, description: nil, language: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, webhooks: nil, intents: nil, entities: nil, include_audit: nil)
|
208
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
209
|
+
|
205
210
|
headers = {
|
206
211
|
}
|
207
212
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "create_workspace")
|
@@ -216,14 +221,14 @@ module IBMWatson
|
|
216
221
|
"name" => name,
|
217
222
|
"description" => description,
|
218
223
|
"language" => language,
|
224
|
+
"dialog_nodes" => dialog_nodes,
|
225
|
+
"counterexamples" => counterexamples,
|
219
226
|
"metadata" => metadata,
|
220
227
|
"learning_opt_out" => learning_opt_out,
|
221
228
|
"system_settings" => system_settings,
|
229
|
+
"webhooks" => webhooks,
|
222
230
|
"intents" => intents,
|
223
|
-
"entities" => entities
|
224
|
-
"dialog_nodes" => dialog_nodes,
|
225
|
-
"counterexamples" => counterexamples,
|
226
|
-
"webhooks" => webhooks
|
231
|
+
"entities" => entities
|
227
232
|
}
|
228
233
|
|
229
234
|
method_url = "/v1/workspaces"
|
@@ -256,6 +261,8 @@ module IBMWatson
|
|
256
261
|
def get_workspace(workspace_id:, export: nil, include_audit: nil, sort: nil)
|
257
262
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
258
263
|
|
264
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
265
|
+
|
259
266
|
headers = {
|
260
267
|
}
|
261
268
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_workspace")
|
@@ -281,7 +288,7 @@ module IBMWatson
|
|
281
288
|
end
|
282
289
|
|
283
290
|
##
|
284
|
-
# @!method update_workspace(workspace_id:, name: nil, description: nil, language: nil,
|
291
|
+
# @!method update_workspace(workspace_id:, name: nil, description: nil, language: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, webhooks: nil, intents: nil, entities: nil, append: nil, include_audit: nil)
|
285
292
|
# Update workspace.
|
286
293
|
# Update an existing workspace with new or modified data. You must provide component
|
287
294
|
# objects defining the content of the updated workspace.
|
@@ -291,17 +298,17 @@ module IBMWatson
|
|
291
298
|
# @param description [String] The description of the workspace. This string cannot contain carriage return,
|
292
299
|
# newline, or tab characters.
|
293
300
|
# @param language [String] The language of the workspace.
|
301
|
+
# @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
|
302
|
+
# @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
|
303
|
+
# input.
|
294
304
|
# @param metadata [Hash] Any metadata related to the workspace.
|
295
305
|
# @param learning_opt_out [Boolean] Whether training data from the workspace (including artifacts such as intents and
|
296
306
|
# entities) can be used by IBM for general service improvements. `true` indicates
|
297
307
|
# that workspace training data is not to be used.
|
298
308
|
# @param system_settings [WorkspaceSystemSettings] Global settings for the workspace.
|
309
|
+
# @param webhooks [Array[Webhook]]
|
299
310
|
# @param intents [Array[CreateIntent]] An array of objects defining the intents for the workspace.
|
300
311
|
# @param entities [Array[CreateEntity]] An array of objects describing the entities for the workspace.
|
301
|
-
# @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
|
302
|
-
# @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
|
303
|
-
# input.
|
304
|
-
# @param webhooks [Array[Webhook]]
|
305
312
|
# @param append [Boolean] Whether the new data is to be appended to the existing data in the object. If
|
306
313
|
# **append**=`false`, elements included in the new data completely replace the
|
307
314
|
# corresponding existing elements, including all subelements. For example, if the
|
@@ -315,9 +322,11 @@ module IBMWatson
|
|
315
322
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
316
323
|
# the response.
|
317
324
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
318
|
-
def update_workspace(workspace_id:, name: nil, description: nil, language: nil,
|
325
|
+
def update_workspace(workspace_id:, name: nil, description: nil, language: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, webhooks: nil, intents: nil, entities: nil, append: nil, include_audit: nil)
|
319
326
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
320
327
|
|
328
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
329
|
+
|
321
330
|
headers = {
|
322
331
|
}
|
323
332
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_workspace")
|
@@ -333,14 +342,14 @@ module IBMWatson
|
|
333
342
|
"name" => name,
|
334
343
|
"description" => description,
|
335
344
|
"language" => language,
|
345
|
+
"dialog_nodes" => dialog_nodes,
|
346
|
+
"counterexamples" => counterexamples,
|
336
347
|
"metadata" => metadata,
|
337
348
|
"learning_opt_out" => learning_opt_out,
|
338
349
|
"system_settings" => system_settings,
|
350
|
+
"webhooks" => webhooks,
|
339
351
|
"intents" => intents,
|
340
|
-
"entities" => entities
|
341
|
-
"dialog_nodes" => dialog_nodes,
|
342
|
-
"counterexamples" => counterexamples,
|
343
|
-
"webhooks" => webhooks
|
352
|
+
"entities" => entities
|
344
353
|
}
|
345
354
|
|
346
355
|
method_url = "/v1/workspaces/%s" % [ERB::Util.url_encode(workspace_id)]
|
@@ -365,6 +374,8 @@ module IBMWatson
|
|
365
374
|
def delete_workspace(workspace_id:)
|
366
375
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
367
376
|
|
377
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
378
|
+
|
368
379
|
headers = {
|
369
380
|
}
|
370
381
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_workspace")
|
@@ -390,7 +401,7 @@ module IBMWatson
|
|
390
401
|
#########################
|
391
402
|
|
392
403
|
##
|
393
|
-
# @!method list_intents(workspace_id:, export: nil, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
404
|
+
# @!method list_intents(workspace_id:, export: nil, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
394
405
|
# List intents.
|
395
406
|
# List the intents for a workspace.
|
396
407
|
# @param workspace_id [String] Unique identifier of the workspace.
|
@@ -398,15 +409,20 @@ module IBMWatson
|
|
398
409
|
# **export**=`false`, the returned data includes only information about the element
|
399
410
|
# itself. If **export**=`true`, all content, including subelements, is included.
|
400
411
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
412
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
413
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
414
|
+
# `pagination` object in the response includes the `total` property.
|
401
415
|
# @param sort [String] The attribute by which returned intents will be sorted. To reverse the sort order,
|
402
416
|
# prefix the value with a minus sign (`-`).
|
403
417
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
404
418
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
405
419
|
# the response.
|
406
420
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
407
|
-
def list_intents(workspace_id:, export: nil, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
421
|
+
def list_intents(workspace_id:, export: nil, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
408
422
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
409
423
|
|
424
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
425
|
+
|
410
426
|
headers = {
|
411
427
|
}
|
412
428
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_intents")
|
@@ -416,6 +432,7 @@ module IBMWatson
|
|
416
432
|
"version" => @version,
|
417
433
|
"export" => export,
|
418
434
|
"page_limit" => page_limit,
|
435
|
+
"include_count" => include_count,
|
419
436
|
"sort" => sort,
|
420
437
|
"cursor" => cursor,
|
421
438
|
"include_audit" => include_audit
|
@@ -454,6 +471,8 @@ module IBMWatson
|
|
454
471
|
def create_intent(workspace_id:, intent:, description: nil, examples: nil, include_audit: nil)
|
455
472
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
456
473
|
|
474
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
475
|
+
|
457
476
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
458
477
|
|
459
478
|
headers = {
|
@@ -502,6 +521,8 @@ module IBMWatson
|
|
502
521
|
|
503
522
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
504
523
|
|
524
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
525
|
+
|
505
526
|
headers = {
|
506
527
|
}
|
507
528
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_intent")
|
@@ -559,6 +580,8 @@ module IBMWatson
|
|
559
580
|
|
560
581
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
561
582
|
|
583
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
584
|
+
|
562
585
|
headers = {
|
563
586
|
}
|
564
587
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_intent")
|
@@ -601,6 +624,8 @@ module IBMWatson
|
|
601
624
|
|
602
625
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
603
626
|
|
627
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
628
|
+
|
604
629
|
headers = {
|
605
630
|
}
|
606
631
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_intent")
|
@@ -626,24 +651,29 @@ module IBMWatson
|
|
626
651
|
#########################
|
627
652
|
|
628
653
|
##
|
629
|
-
# @!method list_examples(workspace_id:, intent:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
654
|
+
# @!method list_examples(workspace_id:, intent:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
630
655
|
# List user input examples.
|
631
656
|
# List the user input examples for an intent, optionally including contextual entity
|
632
657
|
# mentions.
|
633
658
|
# @param workspace_id [String] Unique identifier of the workspace.
|
634
659
|
# @param intent [String] The intent name.
|
635
660
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
661
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
662
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
663
|
+
# `pagination` object in the response includes the `total` property.
|
636
664
|
# @param sort [String] The attribute by which returned examples will be sorted. To reverse the sort
|
637
665
|
# order, prefix the value with a minus sign (`-`).
|
638
666
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
639
667
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
640
668
|
# the response.
|
641
669
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
642
|
-
def list_examples(workspace_id:, intent:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
670
|
+
def list_examples(workspace_id:, intent:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
643
671
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
644
672
|
|
645
673
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
646
674
|
|
675
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
676
|
+
|
647
677
|
headers = {
|
648
678
|
}
|
649
679
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_examples")
|
@@ -652,6 +682,7 @@ module IBMWatson
|
|
652
682
|
params = {
|
653
683
|
"version" => @version,
|
654
684
|
"page_limit" => page_limit,
|
685
|
+
"include_count" => include_count,
|
655
686
|
"sort" => sort,
|
656
687
|
"cursor" => cursor,
|
657
688
|
"include_audit" => include_audit
|
@@ -691,6 +722,8 @@ module IBMWatson
|
|
691
722
|
|
692
723
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
693
724
|
|
725
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
726
|
+
|
694
727
|
raise ArgumentError.new("text must be provided") if text.nil?
|
695
728
|
|
696
729
|
headers = {
|
@@ -738,6 +771,8 @@ module IBMWatson
|
|
738
771
|
|
739
772
|
raise ArgumentError.new("text must be provided") if text.nil?
|
740
773
|
|
774
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
775
|
+
|
741
776
|
headers = {
|
742
777
|
}
|
743
778
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_example")
|
@@ -785,6 +820,8 @@ module IBMWatson
|
|
785
820
|
|
786
821
|
raise ArgumentError.new("text must be provided") if text.nil?
|
787
822
|
|
823
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
824
|
+
|
788
825
|
headers = {
|
789
826
|
}
|
790
827
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_example")
|
@@ -828,6 +865,8 @@ module IBMWatson
|
|
828
865
|
|
829
866
|
raise ArgumentError.new("text must be provided") if text.nil?
|
830
867
|
|
868
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
869
|
+
|
831
870
|
headers = {
|
832
871
|
}
|
833
872
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_example")
|
@@ -853,21 +892,26 @@ module IBMWatson
|
|
853
892
|
#########################
|
854
893
|
|
855
894
|
##
|
856
|
-
# @!method list_counterexamples(workspace_id:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
895
|
+
# @!method list_counterexamples(workspace_id:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
857
896
|
# List counterexamples.
|
858
897
|
# List the counterexamples for a workspace. Counterexamples are examples that have
|
859
898
|
# been marked as irrelevant input.
|
860
899
|
# @param workspace_id [String] Unique identifier of the workspace.
|
861
900
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
901
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
902
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
903
|
+
# `pagination` object in the response includes the `total` property.
|
862
904
|
# @param sort [String] The attribute by which returned counterexamples will be sorted. To reverse the
|
863
905
|
# sort order, prefix the value with a minus sign (`-`).
|
864
906
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
865
907
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
866
908
|
# the response.
|
867
909
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
868
|
-
def list_counterexamples(workspace_id:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
910
|
+
def list_counterexamples(workspace_id:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
869
911
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
870
912
|
|
913
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
914
|
+
|
871
915
|
headers = {
|
872
916
|
}
|
873
917
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_counterexamples")
|
@@ -876,6 +920,7 @@ module IBMWatson
|
|
876
920
|
params = {
|
877
921
|
"version" => @version,
|
878
922
|
"page_limit" => page_limit,
|
923
|
+
"include_count" => include_count,
|
879
924
|
"sort" => sort,
|
880
925
|
"cursor" => cursor,
|
881
926
|
"include_audit" => include_audit
|
@@ -912,6 +957,8 @@ module IBMWatson
|
|
912
957
|
def create_counterexample(workspace_id:, text:, include_audit: nil)
|
913
958
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
914
959
|
|
960
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
961
|
+
|
915
962
|
raise ArgumentError.new("text must be provided") if text.nil?
|
916
963
|
|
917
964
|
headers = {
|
@@ -956,6 +1003,8 @@ module IBMWatson
|
|
956
1003
|
|
957
1004
|
raise ArgumentError.new("text must be provided") if text.nil?
|
958
1005
|
|
1006
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1007
|
+
|
959
1008
|
headers = {
|
960
1009
|
}
|
961
1010
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_counterexample")
|
@@ -997,6 +1046,8 @@ module IBMWatson
|
|
997
1046
|
|
998
1047
|
raise ArgumentError.new("text must be provided") if text.nil?
|
999
1048
|
|
1049
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1050
|
+
|
1000
1051
|
headers = {
|
1001
1052
|
}
|
1002
1053
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_counterexample")
|
@@ -1037,6 +1088,8 @@ module IBMWatson
|
|
1037
1088
|
|
1038
1089
|
raise ArgumentError.new("text must be provided") if text.nil?
|
1039
1090
|
|
1091
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1092
|
+
|
1040
1093
|
headers = {
|
1041
1094
|
}
|
1042
1095
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_counterexample")
|
@@ -1062,7 +1115,7 @@ module IBMWatson
|
|
1062
1115
|
#########################
|
1063
1116
|
|
1064
1117
|
##
|
1065
|
-
# @!method list_entities(workspace_id:, export: nil, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1118
|
+
# @!method list_entities(workspace_id:, export: nil, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1066
1119
|
# List entities.
|
1067
1120
|
# List the entities for a workspace.
|
1068
1121
|
# @param workspace_id [String] Unique identifier of the workspace.
|
@@ -1070,15 +1123,20 @@ module IBMWatson
|
|
1070
1123
|
# **export**=`false`, the returned data includes only information about the element
|
1071
1124
|
# itself. If **export**=`true`, all content, including subelements, is included.
|
1072
1125
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
1126
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
1127
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
1128
|
+
# `pagination` object in the response includes the `total` property.
|
1073
1129
|
# @param sort [String] The attribute by which returned entities will be sorted. To reverse the sort
|
1074
1130
|
# order, prefix the value with a minus sign (`-`).
|
1075
1131
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1076
1132
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1077
1133
|
# the response.
|
1078
1134
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1079
|
-
def list_entities(workspace_id:, export: nil, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1135
|
+
def list_entities(workspace_id:, export: nil, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1080
1136
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1081
1137
|
|
1138
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1139
|
+
|
1082
1140
|
headers = {
|
1083
1141
|
}
|
1084
1142
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_entities")
|
@@ -1088,6 +1146,7 @@ module IBMWatson
|
|
1088
1146
|
"version" => @version,
|
1089
1147
|
"export" => export,
|
1090
1148
|
"page_limit" => page_limit,
|
1149
|
+
"include_count" => include_count,
|
1091
1150
|
"sort" => sort,
|
1092
1151
|
"cursor" => cursor,
|
1093
1152
|
"include_audit" => include_audit
|
@@ -1129,6 +1188,8 @@ module IBMWatson
|
|
1129
1188
|
def create_entity(workspace_id:, entity:, description: nil, metadata: nil, fuzzy_match: nil, values: nil, include_audit: nil)
|
1130
1189
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1131
1190
|
|
1191
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1192
|
+
|
1132
1193
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1133
1194
|
|
1134
1195
|
headers = {
|
@@ -1179,6 +1240,8 @@ module IBMWatson
|
|
1179
1240
|
|
1180
1241
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1181
1242
|
|
1243
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1244
|
+
|
1182
1245
|
headers = {
|
1183
1246
|
}
|
1184
1247
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_entity")
|
@@ -1237,6 +1300,8 @@ module IBMWatson
|
|
1237
1300
|
|
1238
1301
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1239
1302
|
|
1303
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1304
|
+
|
1240
1305
|
headers = {
|
1241
1306
|
}
|
1242
1307
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_entity")
|
@@ -1281,6 +1346,8 @@ module IBMWatson
|
|
1281
1346
|
|
1282
1347
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1283
1348
|
|
1349
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1350
|
+
|
1284
1351
|
headers = {
|
1285
1352
|
}
|
1286
1353
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_entity")
|
@@ -1323,6 +1390,8 @@ module IBMWatson
|
|
1323
1390
|
|
1324
1391
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1325
1392
|
|
1393
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1394
|
+
|
1326
1395
|
headers = {
|
1327
1396
|
}
|
1328
1397
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_mentions")
|
@@ -1350,7 +1419,7 @@ module IBMWatson
|
|
1350
1419
|
#########################
|
1351
1420
|
|
1352
1421
|
##
|
1353
|
-
# @!method list_values(workspace_id:, entity:, export: nil, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1422
|
+
# @!method list_values(workspace_id:, entity:, export: nil, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1354
1423
|
# List entity values.
|
1355
1424
|
# List the values for an entity.
|
1356
1425
|
# @param workspace_id [String] Unique identifier of the workspace.
|
@@ -1359,17 +1428,22 @@ module IBMWatson
|
|
1359
1428
|
# **export**=`false`, the returned data includes only information about the element
|
1360
1429
|
# itself. If **export**=`true`, all content, including subelements, is included.
|
1361
1430
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
1431
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
1432
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
1433
|
+
# `pagination` object in the response includes the `total` property.
|
1362
1434
|
# @param sort [String] The attribute by which returned entity values will be sorted. To reverse the sort
|
1363
1435
|
# order, prefix the value with a minus sign (`-`).
|
1364
1436
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1365
1437
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1366
1438
|
# the response.
|
1367
1439
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1368
|
-
def list_values(workspace_id:, entity:, export: nil, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1440
|
+
def list_values(workspace_id:, entity:, export: nil, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1369
1441
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1370
1442
|
|
1371
1443
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1372
1444
|
|
1445
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1446
|
+
|
1373
1447
|
headers = {
|
1374
1448
|
}
|
1375
1449
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_values")
|
@@ -1379,6 +1453,7 @@ module IBMWatson
|
|
1379
1453
|
"version" => @version,
|
1380
1454
|
"export" => export,
|
1381
1455
|
"page_limit" => page_limit,
|
1456
|
+
"include_count" => include_count,
|
1382
1457
|
"sort" => sort,
|
1383
1458
|
"cursor" => cursor,
|
1384
1459
|
"include_audit" => include_audit
|
@@ -1428,6 +1503,8 @@ module IBMWatson
|
|
1428
1503
|
|
1429
1504
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1430
1505
|
|
1506
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1507
|
+
|
1431
1508
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1432
1509
|
|
1433
1510
|
headers = {
|
@@ -1481,6 +1558,8 @@ module IBMWatson
|
|
1481
1558
|
|
1482
1559
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1483
1560
|
|
1561
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1562
|
+
|
1484
1563
|
headers = {
|
1485
1564
|
}
|
1486
1565
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_value")
|
@@ -1550,6 +1629,8 @@ module IBMWatson
|
|
1550
1629
|
|
1551
1630
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1552
1631
|
|
1632
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1633
|
+
|
1553
1634
|
headers = {
|
1554
1635
|
}
|
1555
1636
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_value")
|
@@ -1597,6 +1678,8 @@ module IBMWatson
|
|
1597
1678
|
|
1598
1679
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1599
1680
|
|
1681
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1682
|
+
|
1600
1683
|
headers = {
|
1601
1684
|
}
|
1602
1685
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_value")
|
@@ -1622,26 +1705,31 @@ module IBMWatson
|
|
1622
1705
|
#########################
|
1623
1706
|
|
1624
1707
|
##
|
1625
|
-
# @!method list_synonyms(workspace_id:, entity:, value:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1708
|
+
# @!method list_synonyms(workspace_id:, entity:, value:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1626
1709
|
# List entity value synonyms.
|
1627
1710
|
# List the synonyms for an entity value.
|
1628
1711
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1629
1712
|
# @param entity [String] The name of the entity.
|
1630
1713
|
# @param value [String] The text of the entity value.
|
1631
1714
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
1715
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
1716
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
1717
|
+
# `pagination` object in the response includes the `total` property.
|
1632
1718
|
# @param sort [String] The attribute by which returned entity value synonyms will be sorted. To reverse
|
1633
1719
|
# the sort order, prefix the value with a minus sign (`-`).
|
1634
1720
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1635
1721
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1636
1722
|
# the response.
|
1637
1723
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1638
|
-
def list_synonyms(workspace_id:, entity:, value:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1724
|
+
def list_synonyms(workspace_id:, entity:, value:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1639
1725
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1640
1726
|
|
1641
1727
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1642
1728
|
|
1643
1729
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1644
1730
|
|
1731
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1732
|
+
|
1645
1733
|
headers = {
|
1646
1734
|
}
|
1647
1735
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_synonyms")
|
@@ -1650,6 +1738,7 @@ module IBMWatson
|
|
1650
1738
|
params = {
|
1651
1739
|
"version" => @version,
|
1652
1740
|
"page_limit" => page_limit,
|
1741
|
+
"include_count" => include_count,
|
1653
1742
|
"sort" => sort,
|
1654
1743
|
"cursor" => cursor,
|
1655
1744
|
"include_audit" => include_audit
|
@@ -1691,6 +1780,8 @@ module IBMWatson
|
|
1691
1780
|
|
1692
1781
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1693
1782
|
|
1783
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1784
|
+
|
1694
1785
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1695
1786
|
|
1696
1787
|
headers = {
|
@@ -1740,6 +1831,8 @@ module IBMWatson
|
|
1740
1831
|
|
1741
1832
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1742
1833
|
|
1834
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1835
|
+
|
1743
1836
|
headers = {
|
1744
1837
|
}
|
1745
1838
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_synonym")
|
@@ -1789,6 +1882,8 @@ module IBMWatson
|
|
1789
1882
|
|
1790
1883
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1791
1884
|
|
1885
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1886
|
+
|
1792
1887
|
headers = {
|
1793
1888
|
}
|
1794
1889
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_synonym")
|
@@ -1834,6 +1929,8 @@ module IBMWatson
|
|
1834
1929
|
|
1835
1930
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1836
1931
|
|
1932
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1933
|
+
|
1837
1934
|
headers = {
|
1838
1935
|
}
|
1839
1936
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_synonym")
|
@@ -1859,20 +1956,25 @@ module IBMWatson
|
|
1859
1956
|
#########################
|
1860
1957
|
|
1861
1958
|
##
|
1862
|
-
# @!method list_dialog_nodes(workspace_id:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1959
|
+
# @!method list_dialog_nodes(workspace_id:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1863
1960
|
# List dialog nodes.
|
1864
1961
|
# List the dialog nodes for a workspace.
|
1865
1962
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1866
1963
|
# @param page_limit [Fixnum] The number of records to return in each page of results.
|
1964
|
+
# @param include_count [Boolean] Whether to include information about the number of records that satisfy the
|
1965
|
+
# request, regardless of the page limit. If this parameter is `true`, the
|
1966
|
+
# `pagination` object in the response includes the `total` property.
|
1867
1967
|
# @param sort [String] The attribute by which returned dialog nodes will be sorted. To reverse the sort
|
1868
1968
|
# order, prefix the value with a minus sign (`-`).
|
1869
1969
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1870
1970
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1871
1971
|
# the response.
|
1872
1972
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1873
|
-
def list_dialog_nodes(workspace_id:, page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
|
1973
|
+
def list_dialog_nodes(workspace_id:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
|
1874
1974
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1875
1975
|
|
1976
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1977
|
+
|
1876
1978
|
headers = {
|
1877
1979
|
}
|
1878
1980
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_dialog_nodes")
|
@@ -1881,6 +1983,7 @@ module IBMWatson
|
|
1881
1983
|
params = {
|
1882
1984
|
"version" => @version,
|
1883
1985
|
"page_limit" => page_limit,
|
1986
|
+
"include_count" => include_count,
|
1884
1987
|
"sort" => sort,
|
1885
1988
|
"cursor" => cursor,
|
1886
1989
|
"include_audit" => include_audit
|
@@ -1920,7 +2023,7 @@ module IBMWatson
|
|
1920
2023
|
# @param output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
|
1921
2024
|
# node output, see the
|
1922
2025
|
# [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
|
1923
|
-
# @param context [
|
2026
|
+
# @param context [DialogNodeContext] The context for the dialog node.
|
1924
2027
|
# @param metadata [Hash] The metadata for the dialog node.
|
1925
2028
|
# @param next_step [DialogNodeNextStep] The next step to execute following this dialog node.
|
1926
2029
|
# @param title [String] The alias used to identify the dialog node. This string must conform to the
|
@@ -1944,6 +2047,8 @@ module IBMWatson
|
|
1944
2047
|
def create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, title: nil, type: nil, event_name: nil, variable: nil, actions: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil, user_label: nil, disambiguation_opt_out: nil, include_audit: nil)
|
1945
2048
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1946
2049
|
|
2050
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2051
|
+
|
1947
2052
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
1948
2053
|
|
1949
2054
|
headers = {
|
@@ -2005,6 +2110,8 @@ module IBMWatson
|
|
2005
2110
|
|
2006
2111
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
2007
2112
|
|
2113
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2114
|
+
|
2008
2115
|
headers = {
|
2009
2116
|
}
|
2010
2117
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_dialog_node")
|
@@ -2050,7 +2157,7 @@ module IBMWatson
|
|
2050
2157
|
# @param new_output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
|
2051
2158
|
# node output, see the
|
2052
2159
|
# [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
|
2053
|
-
# @param new_context [
|
2160
|
+
# @param new_context [DialogNodeContext] The context for the dialog node.
|
2054
2161
|
# @param new_metadata [Hash] The metadata for the dialog node.
|
2055
2162
|
# @param new_next_step [DialogNodeNextStep] The next step to execute following this dialog node.
|
2056
2163
|
# @param new_title [String] The alias used to identify the dialog node. This string must conform to the
|
@@ -2076,6 +2183,8 @@ module IBMWatson
|
|
2076
2183
|
|
2077
2184
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
2078
2185
|
|
2186
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2187
|
+
|
2079
2188
|
headers = {
|
2080
2189
|
}
|
2081
2190
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_dialog_node")
|
@@ -2133,6 +2242,8 @@ module IBMWatson
|
|
2133
2242
|
|
2134
2243
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
2135
2244
|
|
2245
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2246
|
+
|
2136
2247
|
headers = {
|
2137
2248
|
}
|
2138
2249
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_dialog_node")
|
@@ -2173,6 +2284,8 @@ module IBMWatson
|
|
2173
2284
|
def list_logs(workspace_id:, sort: nil, filter: nil, page_limit: nil, cursor: nil)
|
2174
2285
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
2175
2286
|
|
2287
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2288
|
+
|
2176
2289
|
headers = {
|
2177
2290
|
}
|
2178
2291
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_logs")
|
@@ -2213,6 +2326,8 @@ module IBMWatson
|
|
2213
2326
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
2214
2327
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
2215
2328
|
def list_all_logs(filter:, sort: nil, page_limit: nil, cursor: nil)
|
2329
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2330
|
+
|
2216
2331
|
raise ArgumentError.new("filter must be provided") if filter.nil?
|
2217
2332
|
|
2218
2333
|
headers = {
|
@@ -2256,6 +2371,8 @@ module IBMWatson
|
|
2256
2371
|
# @param customer_id [String] The customer ID for which all data is to be deleted.
|
2257
2372
|
# @return [nil]
|
2258
2373
|
def delete_user_data(customer_id:)
|
2374
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2375
|
+
|
2259
2376
|
raise ArgumentError.new("customer_id must be provided") if customer_id.nil?
|
2260
2377
|
|
2261
2378
|
headers = {
|
@@ -2279,5 +2396,50 @@ module IBMWatson
|
|
2279
2396
|
)
|
2280
2397
|
nil
|
2281
2398
|
end
|
2399
|
+
#########################
|
2400
|
+
# bulkClassify
|
2401
|
+
#########################
|
2402
|
+
|
2403
|
+
##
|
2404
|
+
# @!method bulk_classify(workspace_id:, input: nil)
|
2405
|
+
# Identify intents and entities in multiple user utterances.
|
2406
|
+
# Send multiple user inputs to a workspace in a single request and receive
|
2407
|
+
# information about the intents and entities recognized in each input. This method
|
2408
|
+
# is useful for testing and comparing the performance of different workspaces.
|
2409
|
+
#
|
2410
|
+
# This method is available only with Premium plans.
|
2411
|
+
# @param workspace_id [String] Unique identifier of the workspace.
|
2412
|
+
# @param input [Array[BulkClassifyUtterance]] An array of input utterances to classify.
|
2413
|
+
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
2414
|
+
def bulk_classify(workspace_id:, input: nil)
|
2415
|
+
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
2416
|
+
|
2417
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2418
|
+
|
2419
|
+
headers = {
|
2420
|
+
}
|
2421
|
+
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "bulk_classify")
|
2422
|
+
headers.merge!(sdk_headers)
|
2423
|
+
|
2424
|
+
params = {
|
2425
|
+
"version" => @version
|
2426
|
+
}
|
2427
|
+
|
2428
|
+
data = {
|
2429
|
+
"input" => input
|
2430
|
+
}
|
2431
|
+
|
2432
|
+
method_url = "/v1/workspaces/%s/bulk_classify" % [ERB::Util.url_encode(workspace_id)]
|
2433
|
+
|
2434
|
+
response = request(
|
2435
|
+
method: "POST",
|
2436
|
+
url: method_url,
|
2437
|
+
headers: headers,
|
2438
|
+
params: params,
|
2439
|
+
json: data,
|
2440
|
+
accept_json: true
|
2441
|
+
)
|
2442
|
+
response
|
2443
|
+
end
|
2282
2444
|
end
|
2283
2445
|
end
|