ibm_watson 1.3.1 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +36 -5
- data/lib/ibm_watson/assistant_v1.rb +225 -199
- data/lib/ibm_watson/assistant_v2.rb +228 -21
- data/lib/ibm_watson/compare_comply_v1.rb +43 -24
- data/lib/ibm_watson/discovery_v1.rb +144 -19
- data/lib/ibm_watson/discovery_v2.rb +742 -23
- data/lib/ibm_watson/language_translator_v3.rb +216 -64
- data/lib/ibm_watson/natural_language_classifier_v1.rb +11 -3
- data/lib/ibm_watson/natural_language_understanding_v1.rb +32 -26
- data/lib/ibm_watson/personality_insights_v3.rb +34 -19
- data/lib/ibm_watson/speech_to_text_v1.rb +239 -106
- data/lib/ibm_watson/text_to_speech_v1.rb +139 -146
- data/lib/ibm_watson/tone_analyzer_v3.rb +19 -14
- data/lib/ibm_watson/version.rb +1 -1
- data/lib/ibm_watson/visual_recognition_v3.rb +40 -17
- data/lib/ibm_watson/visual_recognition_v4.rb +110 -18
- data/test/integration/test_assistant_v1.rb +9 -0
- data/test/integration/test_assistant_v2.rb +34 -0
- data/test/integration/test_compare_comply_v1.rb +1 -12
- data/test/integration/test_discovery_v2.rb +132 -6
- data/test/integration/test_language_translator_v3.rb +5 -0
- data/test/integration/test_text_to_speech_v1.rb +3 -3
- data/test/integration/test_visual_recognition_v4.rb +9 -0
- data/test/unit/test_assistant_v1.rb +149 -98
- data/test/unit/test_assistant_v2.rb +153 -8
- data/test/unit/test_compare_comply_v1.rb +20 -20
- data/test/unit/test_discovery_v1.rb +125 -125
- data/test/unit/test_discovery_v2.rb +262 -29
- data/test/unit/test_language_translator_v3.rb +85 -24
- data/test/unit/test_natural_language_classifier_v1.rb +17 -17
- data/test/unit/test_natural_language_understanding_v1.rb +10 -10
- data/test/unit/test_personality_insights_v3.rb +14 -14
- data/test/unit/test_speech_to_text_v1.rb +97 -97
- data/test/unit/test_text_to_speech_v1.rb +48 -48
- data/test/unit/test_tone_analyzer_v3.rb +12 -12
- data/test/unit/test_visual_recognition_v3.rb +16 -16
- data/test/unit/test_visual_recognition_v4.rb +56 -38
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c7e49f743ec6be9987f928f1ef0cfb20940e25d725cbcb615fe91ac7ccf358a9
|
4
|
+
data.tar.gz: eaca308aac3243d51701f84360eded5d2bb80e9afeac79ef38f1c17803732823
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 064c105ef4d1e9f40f2c5b295afcd0309d77c8ecd408e0937d56136af53cf4ac5df5c09d550a9859820f30df7bf71a8e16ffceba0c637e0c3b7effc7728516c6
|
7
|
+
data.tar.gz: 8d6632a93f2864c9ffe12a7e3ab3e0fa07e38004ac81baa376d7f2926cac032fdcfbaa08600713b31211f632d343031ee1c7809d5ef979502b70476f405fbead
|
data/README.md
CHANGED
@@ -34,6 +34,15 @@ 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 Watson™ Personality Insights is discontinued. For a period of one year from 1 December 2020, 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
|
+
|
43
|
+
### Visual Recognition deprecation
|
44
|
+
IBM Watson™ Visual Recognition is discontinued. Existing instances are supported until 1 December 2021, but as of 7 January 2021, you can't create instances. Any instance that is provisioned on 1 December 2021 will be deleted.
|
45
|
+
|
37
46
|
## Before you begin
|
38
47
|
|
39
48
|
* You need an [IBM Cloud][ibm-cloud-onboarding] account.
|
@@ -129,7 +138,7 @@ IBM Cloud is migrating to token-based Identity and Access Management (IAM) authe
|
|
129
138
|
You supply either an IAM service **API key** or an **access token**:
|
130
139
|
|
131
140
|
* Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
|
132
|
-
* Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/
|
141
|
+
* Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/watson?topic=watson-iam).
|
133
142
|
|
134
143
|
#### Supplying the IAM API key
|
135
144
|
|
@@ -269,7 +278,7 @@ Result: "<response returned by service>"
|
|
269
278
|
|
270
279
|
### Transaction IDs
|
271
280
|
|
272
|
-
Every SDK call
|
281
|
+
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
282
|
|
274
283
|
```ruby
|
275
284
|
require "ibm_watson"
|
@@ -289,6 +298,22 @@ rescue IBMCloudSdkCore::ApiException => e
|
|
289
298
|
end
|
290
299
|
```
|
291
300
|
|
301
|
+
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.
|
302
|
+
|
303
|
+
```ruby
|
304
|
+
require "ibm_watson"
|
305
|
+
include IBMWatson
|
306
|
+
|
307
|
+
assistant = AssistantV1.new(
|
308
|
+
authenticator: "<authenticator>"
|
309
|
+
version: "2017-04-21"
|
310
|
+
)
|
311
|
+
|
312
|
+
response = assistant.headers(
|
313
|
+
"X-Global-Transaction-Id" => "<my-unique-transaction-id>"
|
314
|
+
).list_workspaces
|
315
|
+
```
|
316
|
+
|
292
317
|
## Configuring the HTTP client
|
293
318
|
|
294
319
|
To set client configs like timeout or proxy use the `configure_http_client` function and pass in the configurations.
|
@@ -390,12 +415,18 @@ assistant = IBMWatson::AssistantV1.new(
|
|
390
415
|
|
391
416
|
```
|
392
417
|
|
418
|
+
## Questions
|
419
|
+
|
420
|
+
If you have issues with the APIs or have a question about the Watson services, see [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-watson+ruby).
|
421
|
+
|
393
422
|
## Ruby version
|
394
423
|
|
395
424
|
Tested on:
|
396
425
|
|
397
|
-
* MRI Ruby (RVM): 2.
|
398
|
-
* RubyInstaller (Windows x64): 2.
|
426
|
+
* MRI Ruby (RVM): 2.5.1, 2.6.1
|
427
|
+
* RubyInstaller (Windows x64): 2.5.1, 2.6.1
|
428
|
+
|
429
|
+
2.3.7 and 2.4.4 should still work but support will be deprecated in next major release.
|
399
430
|
|
400
431
|
## Contributing
|
401
432
|
|
@@ -419,6 +450,6 @@ We'd love to highlight cool open-source projects that use this SDK! If you'd lik
|
|
419
450
|
[examples]: https://github.com/watson-developer-cloud/ruby-sdk/tree/master/examples
|
420
451
|
[CONTRIBUTING]: https://github.com/watson-developer-cloud/ruby-sdk/blob/master/CONTRIBUTING.md
|
421
452
|
[license]: http://www.apache.org/licenses/LICENSE-2.0
|
422
|
-
[vcap_services]: https://cloud.ibm.com/docs/
|
453
|
+
[vcap_services]: https://cloud.ibm.com/docs/watson?topic=watson-vcapServices
|
423
454
|
[ibm-cloud-onboarding]: http://cloud.ibm.com/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Ruby
|
424
455
|
[ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html
|
@@ -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.19.0-be3b4618-20201113-200858
|
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.
|
@@ -33,37 +35,36 @@ module IBMWatson
|
|
33
35
|
# The Assistant V1 service.
|
34
36
|
class AssistantV1 < IBMCloudSdkCore::BaseService
|
35
37
|
include Concurrent::Async
|
38
|
+
DEFAULT_SERVICE_NAME = "assistant"
|
39
|
+
DEFAULT_SERVICE_URL = "https://api.us-south.assistant.watson.cloud.ibm.com"
|
40
|
+
attr_accessor :version
|
36
41
|
##
|
37
42
|
# @!method initialize(args)
|
38
43
|
# Construct a new client for the Assistant service.
|
39
44
|
#
|
40
45
|
# @param args [Hash] The args to initialize with
|
41
|
-
# @option args version [String]
|
42
|
-
#
|
43
|
-
# incompatible way, a new minor version of the API is released.
|
44
|
-
# The service uses the API version for the date you specify, or
|
45
|
-
# the most recent version before that date. Note that you should
|
46
|
-
# not programmatically specify the current date at runtime, in
|
47
|
-
# case the API has been updated since your application's release.
|
48
|
-
# Instead, specify a version date that is compatible with your
|
49
|
-
# application, and don't change it until your application is
|
50
|
-
# 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`.
|
51
48
|
# @option args service_url [String] The base service URL to use when contacting the service.
|
52
49
|
# The base service_url may differ between IBM Cloud regions.
|
53
50
|
# @option args authenticator [Object] The Authenticator instance to be configured for this service.
|
51
|
+
# @option args service_name [String] The name of the service to configure. Will be used as the key to load
|
52
|
+
# any external configuration, if applicable.
|
54
53
|
def initialize(args = {})
|
55
54
|
@__async_initialized__ = false
|
56
55
|
defaults = {}
|
57
|
-
defaults[:
|
58
|
-
defaults[:
|
56
|
+
defaults[:service_url] = DEFAULT_SERVICE_URL
|
57
|
+
defaults[:service_name] = DEFAULT_SERVICE_NAME
|
59
58
|
defaults[:authenticator] = nil
|
59
|
+
defaults[:version] = nil
|
60
|
+
user_service_url = args[:service_url] unless args[:service_url].nil?
|
60
61
|
args = defaults.merge(args)
|
61
62
|
@version = args[:version]
|
62
63
|
raise ArgumentError.new("version must be provided") if @version.nil?
|
63
64
|
|
64
|
-
args[:service_name] = "assistant"
|
65
65
|
args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
|
66
66
|
super
|
67
|
+
@service_url = user_service_url unless user_service_url.nil?
|
67
68
|
end
|
68
69
|
|
69
70
|
#########################
|
@@ -79,8 +80,6 @@ module IBMWatson
|
|
79
80
|
# API offers significant advantages, including ease of deployment, automatic state
|
80
81
|
# management, versioning, and search capabilities. For more information, see the
|
81
82
|
# [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-api-overview).
|
82
|
-
#
|
83
|
-
# There is no rate limit for this operation.
|
84
83
|
# @param workspace_id [String] Unique identifier of the workspace.
|
85
84
|
# @param input [MessageInput] An input object that includes the input text.
|
86
85
|
# @param intents [Array[RuntimeIntent]] Intents to use when evaluating the user input. Include intents from the previous
|
@@ -101,6 +100,8 @@ module IBMWatson
|
|
101
100
|
def message(workspace_id:, input: nil, intents: nil, entities: nil, alternate_intents: nil, context: nil, output: nil, nodes_visited_details: nil)
|
102
101
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
103
102
|
|
103
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
104
|
+
|
104
105
|
headers = {
|
105
106
|
}
|
106
107
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "message")
|
@@ -137,20 +138,22 @@ module IBMWatson
|
|
137
138
|
#########################
|
138
139
|
|
139
140
|
##
|
140
|
-
# @!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)
|
141
142
|
# List workspaces.
|
142
143
|
# List the workspaces associated with a Watson Assistant service instance.
|
143
|
-
#
|
144
|
-
# This operation is limited to 500 requests per 30 minutes. For more information,
|
145
|
-
# see **Rate limiting**.
|
146
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.
|
147
148
|
# @param sort [String] The attribute by which returned workspaces will be sorted. To reverse the sort
|
148
149
|
# order, prefix the value with a minus sign (`-`).
|
149
150
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
150
151
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
151
152
|
# the response.
|
152
153
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
153
|
-
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
|
+
|
154
157
|
headers = {
|
155
158
|
}
|
156
159
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_workspaces")
|
@@ -159,6 +162,7 @@ module IBMWatson
|
|
159
162
|
params = {
|
160
163
|
"version" => @version,
|
161
164
|
"page_limit" => page_limit,
|
165
|
+
"include_count" => include_count,
|
162
166
|
"sort" => sort,
|
163
167
|
"cursor" => cursor,
|
164
168
|
"include_audit" => include_audit
|
@@ -177,33 +181,32 @@ module IBMWatson
|
|
177
181
|
end
|
178
182
|
|
179
183
|
##
|
180
|
-
# @!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)
|
181
185
|
# Create workspace.
|
182
186
|
# Create a workspace based on component objects. You must provide workspace
|
183
187
|
# components defining the content of the new workspace.
|
184
|
-
#
|
185
|
-
# This operation is limited to 30 requests per 30 minutes. For more information, see
|
186
|
-
# **Rate limiting**.
|
187
188
|
# @param name [String] The name of the workspace. This string cannot contain carriage return, newline, or
|
188
189
|
# tab characters.
|
189
190
|
# @param description [String] The description of the workspace. This string cannot contain carriage return,
|
190
191
|
# newline, or tab characters.
|
191
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.
|
192
196
|
# @param metadata [Hash] Any metadata related to the workspace.
|
193
197
|
# @param learning_opt_out [Boolean] Whether training data from the workspace (including artifacts such as intents and
|
194
198
|
# entities) can be used by IBM for general service improvements. `true` indicates
|
195
199
|
# that workspace training data is not to be used.
|
196
200
|
# @param system_settings [WorkspaceSystemSettings] Global settings for the workspace.
|
201
|
+
# @param webhooks [Array[Webhook]]
|
197
202
|
# @param intents [Array[CreateIntent]] An array of objects defining the intents for the workspace.
|
198
203
|
# @param entities [Array[CreateEntity]] An array of objects describing the entities for the workspace.
|
199
|
-
# @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
|
200
|
-
# @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
|
201
|
-
# input.
|
202
|
-
# @param webhooks [Array[Webhook]]
|
203
204
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
204
205
|
# the response.
|
205
206
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
206
|
-
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
|
+
|
207
210
|
headers = {
|
208
211
|
}
|
209
212
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "create_workspace")
|
@@ -218,14 +221,14 @@ module IBMWatson
|
|
218
221
|
"name" => name,
|
219
222
|
"description" => description,
|
220
223
|
"language" => language,
|
224
|
+
"dialog_nodes" => dialog_nodes,
|
225
|
+
"counterexamples" => counterexamples,
|
221
226
|
"metadata" => metadata,
|
222
227
|
"learning_opt_out" => learning_opt_out,
|
223
228
|
"system_settings" => system_settings,
|
229
|
+
"webhooks" => webhooks,
|
224
230
|
"intents" => intents,
|
225
|
-
"entities" => entities
|
226
|
-
"dialog_nodes" => dialog_nodes,
|
227
|
-
"counterexamples" => counterexamples,
|
228
|
-
"webhooks" => webhooks
|
231
|
+
"entities" => entities
|
229
232
|
}
|
230
233
|
|
231
234
|
method_url = "/v1/workspaces"
|
@@ -245,10 +248,6 @@ module IBMWatson
|
|
245
248
|
# @!method get_workspace(workspace_id:, export: nil, include_audit: nil, sort: nil)
|
246
249
|
# Get information about a workspace.
|
247
250
|
# Get information about a workspace, optionally including all workspace content.
|
248
|
-
#
|
249
|
-
# With **export**=`false`, this operation is limited to 6000 requests per 5 minutes.
|
250
|
-
# With **export**=`true`, the limit is 20 requests per 30 minutes. For more
|
251
|
-
# information, see **Rate limiting**.
|
252
251
|
# @param workspace_id [String] Unique identifier of the workspace.
|
253
252
|
# @param export [Boolean] Whether to include all element content in the returned data. If
|
254
253
|
# **export**=`false`, the returned data includes only information about the element
|
@@ -262,6 +261,8 @@ module IBMWatson
|
|
262
261
|
def get_workspace(workspace_id:, export: nil, include_audit: nil, sort: nil)
|
263
262
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
264
263
|
|
264
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
265
|
+
|
265
266
|
headers = {
|
266
267
|
}
|
267
268
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_workspace")
|
@@ -287,30 +288,27 @@ module IBMWatson
|
|
287
288
|
end
|
288
289
|
|
289
290
|
##
|
290
|
-
# @!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)
|
291
292
|
# Update workspace.
|
292
293
|
# Update an existing workspace with new or modified data. You must provide component
|
293
294
|
# objects defining the content of the updated workspace.
|
294
|
-
#
|
295
|
-
# This operation is limited to 30 request per 30 minutes. For more information, see
|
296
|
-
# **Rate limiting**.
|
297
295
|
# @param workspace_id [String] Unique identifier of the workspace.
|
298
296
|
# @param name [String] The name of the workspace. This string cannot contain carriage return, newline, or
|
299
297
|
# tab characters.
|
300
298
|
# @param description [String] The description of the workspace. This string cannot contain carriage return,
|
301
299
|
# newline, or tab characters.
|
302
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.
|
303
304
|
# @param metadata [Hash] Any metadata related to the workspace.
|
304
305
|
# @param learning_opt_out [Boolean] Whether training data from the workspace (including artifacts such as intents and
|
305
306
|
# entities) can be used by IBM for general service improvements. `true` indicates
|
306
307
|
# that workspace training data is not to be used.
|
307
308
|
# @param system_settings [WorkspaceSystemSettings] Global settings for the workspace.
|
309
|
+
# @param webhooks [Array[Webhook]]
|
308
310
|
# @param intents [Array[CreateIntent]] An array of objects defining the intents for the workspace.
|
309
311
|
# @param entities [Array[CreateEntity]] An array of objects describing the entities for the workspace.
|
310
|
-
# @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
|
311
|
-
# @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
|
312
|
-
# input.
|
313
|
-
# @param webhooks [Array[Webhook]]
|
314
312
|
# @param append [Boolean] Whether the new data is to be appended to the existing data in the object. If
|
315
313
|
# **append**=`false`, elements included in the new data completely replace the
|
316
314
|
# corresponding existing elements, including all subelements. For example, if the
|
@@ -324,9 +322,11 @@ module IBMWatson
|
|
324
322
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
325
323
|
# the response.
|
326
324
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
327
|
-
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)
|
328
326
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
329
327
|
|
328
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
329
|
+
|
330
330
|
headers = {
|
331
331
|
}
|
332
332
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_workspace")
|
@@ -342,14 +342,14 @@ module IBMWatson
|
|
342
342
|
"name" => name,
|
343
343
|
"description" => description,
|
344
344
|
"language" => language,
|
345
|
+
"dialog_nodes" => dialog_nodes,
|
346
|
+
"counterexamples" => counterexamples,
|
345
347
|
"metadata" => metadata,
|
346
348
|
"learning_opt_out" => learning_opt_out,
|
347
349
|
"system_settings" => system_settings,
|
350
|
+
"webhooks" => webhooks,
|
348
351
|
"intents" => intents,
|
349
|
-
"entities" => entities
|
350
|
-
"dialog_nodes" => dialog_nodes,
|
351
|
-
"counterexamples" => counterexamples,
|
352
|
-
"webhooks" => webhooks
|
352
|
+
"entities" => entities
|
353
353
|
}
|
354
354
|
|
355
355
|
method_url = "/v1/workspaces/%s" % [ERB::Util.url_encode(workspace_id)]
|
@@ -369,14 +369,13 @@ module IBMWatson
|
|
369
369
|
# @!method delete_workspace(workspace_id:)
|
370
370
|
# Delete workspace.
|
371
371
|
# Delete a workspace from the service instance.
|
372
|
-
#
|
373
|
-
# This operation is limited to 30 requests per 30 minutes. For more information, see
|
374
|
-
# **Rate limiting**.
|
375
372
|
# @param workspace_id [String] Unique identifier of the workspace.
|
376
373
|
# @return [nil]
|
377
374
|
def delete_workspace(workspace_id:)
|
378
375
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
379
376
|
|
377
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
378
|
+
|
380
379
|
headers = {
|
381
380
|
}
|
382
381
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_workspace")
|
@@ -402,27 +401,28 @@ module IBMWatson
|
|
402
401
|
#########################
|
403
402
|
|
404
403
|
##
|
405
|
-
# @!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)
|
406
405
|
# List intents.
|
407
406
|
# List the intents for a workspace.
|
408
|
-
#
|
409
|
-
# With **export**=`false`, this operation is limited to 2000 requests per 30
|
410
|
-
# minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For
|
411
|
-
# more information, see **Rate limiting**.
|
412
407
|
# @param workspace_id [String] Unique identifier of the workspace.
|
413
408
|
# @param export [Boolean] Whether to include all element content in the returned data. If
|
414
409
|
# **export**=`false`, the returned data includes only information about the element
|
415
410
|
# itself. If **export**=`true`, all content, including subelements, is included.
|
416
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.
|
417
415
|
# @param sort [String] The attribute by which returned intents will be sorted. To reverse the sort order,
|
418
416
|
# prefix the value with a minus sign (`-`).
|
419
417
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
420
418
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
421
419
|
# the response.
|
422
420
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
423
|
-
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)
|
424
422
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
425
423
|
|
424
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
425
|
+
|
426
426
|
headers = {
|
427
427
|
}
|
428
428
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_intents")
|
@@ -432,6 +432,7 @@ module IBMWatson
|
|
432
432
|
"version" => @version,
|
433
433
|
"export" => export,
|
434
434
|
"page_limit" => page_limit,
|
435
|
+
"include_count" => include_count,
|
435
436
|
"sort" => sort,
|
436
437
|
"cursor" => cursor,
|
437
438
|
"include_audit" => include_audit
|
@@ -456,9 +457,6 @@ module IBMWatson
|
|
456
457
|
#
|
457
458
|
# If you want to create multiple intents with a single API call, consider using the
|
458
459
|
# **[Update workspace](#update-workspace)** method instead.
|
459
|
-
#
|
460
|
-
# This operation is limited to 2000 requests per 30 minutes. For more information,
|
461
|
-
# see **Rate limiting**.
|
462
460
|
# @param workspace_id [String] Unique identifier of the workspace.
|
463
461
|
# @param intent [String] The name of the intent. This string must conform to the following restrictions:
|
464
462
|
# - It can contain only Unicode alphanumeric, underscore, hyphen, and dot
|
@@ -473,6 +471,8 @@ module IBMWatson
|
|
473
471
|
def create_intent(workspace_id:, intent:, description: nil, examples: nil, include_audit: nil)
|
474
472
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
475
473
|
|
474
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
475
|
+
|
476
476
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
477
477
|
|
478
478
|
headers = {
|
@@ -508,10 +508,6 @@ module IBMWatson
|
|
508
508
|
# @!method get_intent(workspace_id:, intent:, export: nil, include_audit: nil)
|
509
509
|
# Get intent.
|
510
510
|
# Get information about an intent, optionally including all intent content.
|
511
|
-
#
|
512
|
-
# With **export**=`false`, this operation is limited to 6000 requests per 5 minutes.
|
513
|
-
# With **export**=`true`, the limit is 400 requests per 30 minutes. For more
|
514
|
-
# information, see **Rate limiting**.
|
515
511
|
# @param workspace_id [String] Unique identifier of the workspace.
|
516
512
|
# @param intent [String] The intent name.
|
517
513
|
# @param export [Boolean] Whether to include all element content in the returned data. If
|
@@ -525,6 +521,8 @@ module IBMWatson
|
|
525
521
|
|
526
522
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
527
523
|
|
524
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
525
|
+
|
528
526
|
headers = {
|
529
527
|
}
|
530
528
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_intent")
|
@@ -556,9 +554,6 @@ module IBMWatson
|
|
556
554
|
#
|
557
555
|
# If you want to update multiple intents with a single API call, consider using the
|
558
556
|
# **[Update workspace](#update-workspace)** method instead.
|
559
|
-
#
|
560
|
-
# This operation is limited to 2000 requests per 30 minutes. For more information,
|
561
|
-
# see **Rate limiting**.
|
562
557
|
# @param workspace_id [String] Unique identifier of the workspace.
|
563
558
|
# @param intent [String] The intent name.
|
564
559
|
# @param new_intent [String] The name of the intent. This string must conform to the following restrictions:
|
@@ -585,6 +580,8 @@ module IBMWatson
|
|
585
580
|
|
586
581
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
587
582
|
|
583
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
584
|
+
|
588
585
|
headers = {
|
589
586
|
}
|
590
587
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_intent")
|
@@ -619,9 +616,6 @@ module IBMWatson
|
|
619
616
|
# @!method delete_intent(workspace_id:, intent:)
|
620
617
|
# Delete intent.
|
621
618
|
# Delete an intent from a workspace.
|
622
|
-
#
|
623
|
-
# This operation is limited to 2000 requests per 30 minutes. For more information,
|
624
|
-
# see **Rate limiting**.
|
625
619
|
# @param workspace_id [String] Unique identifier of the workspace.
|
626
620
|
# @param intent [String] The intent name.
|
627
621
|
# @return [nil]
|
@@ -630,6 +624,8 @@ module IBMWatson
|
|
630
624
|
|
631
625
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
632
626
|
|
627
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
628
|
+
|
633
629
|
headers = {
|
634
630
|
}
|
635
631
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_intent")
|
@@ -655,27 +651,29 @@ module IBMWatson
|
|
655
651
|
#########################
|
656
652
|
|
657
653
|
##
|
658
|
-
# @!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)
|
659
655
|
# List user input examples.
|
660
656
|
# List the user input examples for an intent, optionally including contextual entity
|
661
657
|
# mentions.
|
662
|
-
#
|
663
|
-
# This operation is limited to 2500 requests per 30 minutes. For more information,
|
664
|
-
# see **Rate limiting**.
|
665
658
|
# @param workspace_id [String] Unique identifier of the workspace.
|
666
659
|
# @param intent [String] The intent name.
|
667
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.
|
668
664
|
# @param sort [String] The attribute by which returned examples will be sorted. To reverse the sort
|
669
665
|
# order, prefix the value with a minus sign (`-`).
|
670
666
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
671
667
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
672
668
|
# the response.
|
673
669
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
674
|
-
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)
|
675
671
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
676
672
|
|
677
673
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
678
674
|
|
675
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
676
|
+
|
679
677
|
headers = {
|
680
678
|
}
|
681
679
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_examples")
|
@@ -684,6 +682,7 @@ module IBMWatson
|
|
684
682
|
params = {
|
685
683
|
"version" => @version,
|
686
684
|
"page_limit" => page_limit,
|
685
|
+
"include_count" => include_count,
|
687
686
|
"sort" => sort,
|
688
687
|
"cursor" => cursor,
|
689
688
|
"include_audit" => include_audit
|
@@ -706,11 +705,8 @@ module IBMWatson
|
|
706
705
|
# Create user input example.
|
707
706
|
# Add a new user input example to an intent.
|
708
707
|
#
|
709
|
-
# If you want to add multiple
|
708
|
+
# If you want to add multiple examples with a single API call, consider using the
|
710
709
|
# **[Update intent](#update-intent)** method instead.
|
711
|
-
#
|
712
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
713
|
-
# see **Rate limiting**.
|
714
710
|
# @param workspace_id [String] Unique identifier of the workspace.
|
715
711
|
# @param intent [String] The intent name.
|
716
712
|
# @param text [String] The text of a user input example. This string must conform to the following
|
@@ -726,6 +722,8 @@ module IBMWatson
|
|
726
722
|
|
727
723
|
raise ArgumentError.new("intent must be provided") if intent.nil?
|
728
724
|
|
725
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
726
|
+
|
729
727
|
raise ArgumentError.new("text must be provided") if text.nil?
|
730
728
|
|
731
729
|
headers = {
|
@@ -760,9 +758,6 @@ module IBMWatson
|
|
760
758
|
# @!method get_example(workspace_id:, intent:, text:, include_audit: nil)
|
761
759
|
# Get user input example.
|
762
760
|
# Get information about a user input example.
|
763
|
-
#
|
764
|
-
# This operation is limited to 6000 requests per 5 minutes. For more information,
|
765
|
-
# see **Rate limiting**.
|
766
761
|
# @param workspace_id [String] Unique identifier of the workspace.
|
767
762
|
# @param intent [String] The intent name.
|
768
763
|
# @param text [String] The text of the user input example.
|
@@ -776,6 +771,8 @@ module IBMWatson
|
|
776
771
|
|
777
772
|
raise ArgumentError.new("text must be provided") if text.nil?
|
778
773
|
|
774
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
775
|
+
|
779
776
|
headers = {
|
780
777
|
}
|
781
778
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_example")
|
@@ -805,9 +802,6 @@ module IBMWatson
|
|
805
802
|
#
|
806
803
|
# If you want to update multiple examples with a single API call, consider using the
|
807
804
|
# **[Update intent](#update-intent)** method instead.
|
808
|
-
#
|
809
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
810
|
-
# see **Rate limiting**.
|
811
805
|
# @param workspace_id [String] Unique identifier of the workspace.
|
812
806
|
# @param intent [String] The intent name.
|
813
807
|
# @param text [String] The text of the user input example.
|
@@ -826,6 +820,8 @@ module IBMWatson
|
|
826
820
|
|
827
821
|
raise ArgumentError.new("text must be provided") if text.nil?
|
828
822
|
|
823
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
824
|
+
|
829
825
|
headers = {
|
830
826
|
}
|
831
827
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_example")
|
@@ -858,9 +854,6 @@ module IBMWatson
|
|
858
854
|
# @!method delete_example(workspace_id:, intent:, text:)
|
859
855
|
# Delete user input example.
|
860
856
|
# Delete a user input example from an intent.
|
861
|
-
#
|
862
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
863
|
-
# see **Rate limiting**.
|
864
857
|
# @param workspace_id [String] Unique identifier of the workspace.
|
865
858
|
# @param intent [String] The intent name.
|
866
859
|
# @param text [String] The text of the user input example.
|
@@ -872,6 +865,8 @@ module IBMWatson
|
|
872
865
|
|
873
866
|
raise ArgumentError.new("text must be provided") if text.nil?
|
874
867
|
|
868
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
869
|
+
|
875
870
|
headers = {
|
876
871
|
}
|
877
872
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_example")
|
@@ -897,24 +892,26 @@ module IBMWatson
|
|
897
892
|
#########################
|
898
893
|
|
899
894
|
##
|
900
|
-
# @!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)
|
901
896
|
# List counterexamples.
|
902
897
|
# List the counterexamples for a workspace. Counterexamples are examples that have
|
903
898
|
# been marked as irrelevant input.
|
904
|
-
#
|
905
|
-
# This operation is limited to 2500 requests per 30 minutes. For more information,
|
906
|
-
# see **Rate limiting**.
|
907
899
|
# @param workspace_id [String] Unique identifier of the workspace.
|
908
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.
|
909
904
|
# @param sort [String] The attribute by which returned counterexamples will be sorted. To reverse the
|
910
905
|
# sort order, prefix the value with a minus sign (`-`).
|
911
906
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
912
907
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
913
908
|
# the response.
|
914
909
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
915
|
-
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)
|
916
911
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
917
912
|
|
913
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
914
|
+
|
918
915
|
headers = {
|
919
916
|
}
|
920
917
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_counterexamples")
|
@@ -923,6 +920,7 @@ module IBMWatson
|
|
923
920
|
params = {
|
924
921
|
"version" => @version,
|
925
922
|
"page_limit" => page_limit,
|
923
|
+
"include_count" => include_count,
|
926
924
|
"sort" => sort,
|
927
925
|
"cursor" => cursor,
|
928
926
|
"include_audit" => include_audit
|
@@ -948,9 +946,6 @@ module IBMWatson
|
|
948
946
|
#
|
949
947
|
# If you want to add multiple counterexamples with a single API call, consider using
|
950
948
|
# the **[Update workspace](#update-workspace)** method instead.
|
951
|
-
#
|
952
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
953
|
-
# see **Rate limiting**.
|
954
949
|
# @param workspace_id [String] Unique identifier of the workspace.
|
955
950
|
# @param text [String] The text of a user input marked as irrelevant input. This string must conform to
|
956
951
|
# the following restrictions:
|
@@ -962,6 +957,8 @@ module IBMWatson
|
|
962
957
|
def create_counterexample(workspace_id:, text:, include_audit: nil)
|
963
958
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
964
959
|
|
960
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
961
|
+
|
965
962
|
raise ArgumentError.new("text must be provided") if text.nil?
|
966
963
|
|
967
964
|
headers = {
|
@@ -996,9 +993,6 @@ module IBMWatson
|
|
996
993
|
# Get counterexample.
|
997
994
|
# Get information about a counterexample. Counterexamples are examples that have
|
998
995
|
# been marked as irrelevant input.
|
999
|
-
#
|
1000
|
-
# This operation is limited to 6000 requests per 5 minutes. For more information,
|
1001
|
-
# see **Rate limiting**.
|
1002
996
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1003
997
|
# @param text [String] The text of a user input counterexample (for example, `What are you wearing?`).
|
1004
998
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
@@ -1009,6 +1003,8 @@ module IBMWatson
|
|
1009
1003
|
|
1010
1004
|
raise ArgumentError.new("text must be provided") if text.nil?
|
1011
1005
|
|
1006
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1007
|
+
|
1012
1008
|
headers = {
|
1013
1009
|
}
|
1014
1010
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_counterexample")
|
@@ -1036,12 +1032,6 @@ module IBMWatson
|
|
1036
1032
|
# Update counterexample.
|
1037
1033
|
# Update the text of a counterexample. Counterexamples are examples that have been
|
1038
1034
|
# marked as irrelevant input.
|
1039
|
-
#
|
1040
|
-
# If you want to update multiple counterexamples with a single API call, consider
|
1041
|
-
# using the **[Update workspace](#update-workspace)** method instead.
|
1042
|
-
#
|
1043
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1044
|
-
# see **Rate limiting**.
|
1045
1035
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1046
1036
|
# @param text [String] The text of a user input counterexample (for example, `What are you wearing?`).
|
1047
1037
|
# @param new_text [String] The text of a user input marked as irrelevant input. This string must conform to
|
@@ -1056,6 +1046,8 @@ module IBMWatson
|
|
1056
1046
|
|
1057
1047
|
raise ArgumentError.new("text must be provided") if text.nil?
|
1058
1048
|
|
1049
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1050
|
+
|
1059
1051
|
headers = {
|
1060
1052
|
}
|
1061
1053
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_counterexample")
|
@@ -1088,9 +1080,6 @@ module IBMWatson
|
|
1088
1080
|
# Delete counterexample.
|
1089
1081
|
# Delete a counterexample from a workspace. Counterexamples are examples that have
|
1090
1082
|
# been marked as irrelevant input.
|
1091
|
-
#
|
1092
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1093
|
-
# see **Rate limiting**.
|
1094
1083
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1095
1084
|
# @param text [String] The text of a user input counterexample (for example, `What are you wearing?`).
|
1096
1085
|
# @return [nil]
|
@@ -1099,6 +1088,8 @@ module IBMWatson
|
|
1099
1088
|
|
1100
1089
|
raise ArgumentError.new("text must be provided") if text.nil?
|
1101
1090
|
|
1091
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1092
|
+
|
1102
1093
|
headers = {
|
1103
1094
|
}
|
1104
1095
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_counterexample")
|
@@ -1124,27 +1115,28 @@ module IBMWatson
|
|
1124
1115
|
#########################
|
1125
1116
|
|
1126
1117
|
##
|
1127
|
-
# @!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)
|
1128
1119
|
# List entities.
|
1129
1120
|
# List the entities for a workspace.
|
1130
|
-
#
|
1131
|
-
# With **export**=`false`, this operation is limited to 1000 requests per 30
|
1132
|
-
# minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For
|
1133
|
-
# more information, see **Rate limiting**.
|
1134
1121
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1135
1122
|
# @param export [Boolean] Whether to include all element content in the returned data. If
|
1136
1123
|
# **export**=`false`, the returned data includes only information about the element
|
1137
1124
|
# itself. If **export**=`true`, all content, including subelements, is included.
|
1138
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.
|
1139
1129
|
# @param sort [String] The attribute by which returned entities will be sorted. To reverse the sort
|
1140
1130
|
# order, prefix the value with a minus sign (`-`).
|
1141
1131
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1142
1132
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1143
1133
|
# the response.
|
1144
1134
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1145
|
-
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)
|
1146
1136
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1147
1137
|
|
1138
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1139
|
+
|
1148
1140
|
headers = {
|
1149
1141
|
}
|
1150
1142
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_entities")
|
@@ -1154,6 +1146,7 @@ module IBMWatson
|
|
1154
1146
|
"version" => @version,
|
1155
1147
|
"export" => export,
|
1156
1148
|
"page_limit" => page_limit,
|
1149
|
+
"include_count" => include_count,
|
1157
1150
|
"sort" => sort,
|
1158
1151
|
"cursor" => cursor,
|
1159
1152
|
"include_audit" => include_audit
|
@@ -1178,9 +1171,6 @@ module IBMWatson
|
|
1178
1171
|
#
|
1179
1172
|
# If you want to create multiple entities with a single API call, consider using the
|
1180
1173
|
# **[Update workspace](#update-workspace)** method instead.
|
1181
|
-
#
|
1182
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1183
|
-
# see **Rate limiting**.
|
1184
1174
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1185
1175
|
# @param entity [String] The name of the entity. This string must conform to the following restrictions:
|
1186
1176
|
# - It can contain only Unicode alphanumeric, underscore, and hyphen characters.
|
@@ -1198,6 +1188,8 @@ module IBMWatson
|
|
1198
1188
|
def create_entity(workspace_id:, entity:, description: nil, metadata: nil, fuzzy_match: nil, values: nil, include_audit: nil)
|
1199
1189
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1200
1190
|
|
1191
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1192
|
+
|
1201
1193
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1202
1194
|
|
1203
1195
|
headers = {
|
@@ -1235,10 +1227,6 @@ module IBMWatson
|
|
1235
1227
|
# @!method get_entity(workspace_id:, entity:, export: nil, include_audit: nil)
|
1236
1228
|
# Get entity.
|
1237
1229
|
# Get information about an entity, optionally including all entity content.
|
1238
|
-
#
|
1239
|
-
# With **export**=`false`, this operation is limited to 6000 requests per 5 minutes.
|
1240
|
-
# With **export**=`true`, the limit is 200 requests per 30 minutes. For more
|
1241
|
-
# information, see **Rate limiting**.
|
1242
1230
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1243
1231
|
# @param entity [String] The name of the entity.
|
1244
1232
|
# @param export [Boolean] Whether to include all element content in the returned data. If
|
@@ -1252,6 +1240,8 @@ module IBMWatson
|
|
1252
1240
|
|
1253
1241
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1254
1242
|
|
1243
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1244
|
+
|
1255
1245
|
headers = {
|
1256
1246
|
}
|
1257
1247
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_entity")
|
@@ -1283,9 +1273,6 @@ module IBMWatson
|
|
1283
1273
|
#
|
1284
1274
|
# If you want to update multiple entities with a single API call, consider using the
|
1285
1275
|
# **[Update workspace](#update-workspace)** method instead.
|
1286
|
-
#
|
1287
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1288
|
-
# see **Rate limiting**.
|
1289
1276
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1290
1277
|
# @param entity [String] The name of the entity.
|
1291
1278
|
# @param new_entity [String] The name of the entity. This string must conform to the following restrictions:
|
@@ -1313,6 +1300,8 @@ module IBMWatson
|
|
1313
1300
|
|
1314
1301
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1315
1302
|
|
1303
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1304
|
+
|
1316
1305
|
headers = {
|
1317
1306
|
}
|
1318
1307
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_entity")
|
@@ -1349,9 +1338,6 @@ module IBMWatson
|
|
1349
1338
|
# @!method delete_entity(workspace_id:, entity:)
|
1350
1339
|
# Delete entity.
|
1351
1340
|
# Delete an entity from a workspace, or disable a system entity.
|
1352
|
-
#
|
1353
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1354
|
-
# see **Rate limiting**.
|
1355
1341
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1356
1342
|
# @param entity [String] The name of the entity.
|
1357
1343
|
# @return [nil]
|
@@ -1360,6 +1346,8 @@ module IBMWatson
|
|
1360
1346
|
|
1361
1347
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1362
1348
|
|
1349
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1350
|
+
|
1363
1351
|
headers = {
|
1364
1352
|
}
|
1365
1353
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_entity")
|
@@ -1389,9 +1377,6 @@ module IBMWatson
|
|
1389
1377
|
# List entity mentions.
|
1390
1378
|
# List mentions for a contextual entity. An entity mention is an occurrence of a
|
1391
1379
|
# contextual entity in the context of an intent user input example.
|
1392
|
-
#
|
1393
|
-
# This operation is limited to 200 requests per 30 minutes. For more information,
|
1394
|
-
# see **Rate limiting**.
|
1395
1380
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1396
1381
|
# @param entity [String] The name of the entity.
|
1397
1382
|
# @param export [Boolean] Whether to include all element content in the returned data. If
|
@@ -1405,6 +1390,8 @@ module IBMWatson
|
|
1405
1390
|
|
1406
1391
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1407
1392
|
|
1393
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1394
|
+
|
1408
1395
|
headers = {
|
1409
1396
|
}
|
1410
1397
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_mentions")
|
@@ -1432,29 +1419,31 @@ module IBMWatson
|
|
1432
1419
|
#########################
|
1433
1420
|
|
1434
1421
|
##
|
1435
|
-
# @!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)
|
1436
1423
|
# List entity values.
|
1437
1424
|
# List the values for an entity.
|
1438
|
-
#
|
1439
|
-
# This operation is limited to 2500 requests per 30 minutes. For more information,
|
1440
|
-
# see **Rate limiting**.
|
1441
1425
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1442
1426
|
# @param entity [String] The name of the entity.
|
1443
1427
|
# @param export [Boolean] Whether to include all element content in the returned data. If
|
1444
1428
|
# **export**=`false`, the returned data includes only information about the element
|
1445
1429
|
# itself. If **export**=`true`, all content, including subelements, is included.
|
1446
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.
|
1447
1434
|
# @param sort [String] The attribute by which returned entity values will be sorted. To reverse the sort
|
1448
1435
|
# order, prefix the value with a minus sign (`-`).
|
1449
1436
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1450
1437
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1451
1438
|
# the response.
|
1452
1439
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1453
|
-
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)
|
1454
1441
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1455
1442
|
|
1456
1443
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1457
1444
|
|
1445
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1446
|
+
|
1458
1447
|
headers = {
|
1459
1448
|
}
|
1460
1449
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_values")
|
@@ -1464,6 +1453,7 @@ module IBMWatson
|
|
1464
1453
|
"version" => @version,
|
1465
1454
|
"export" => export,
|
1466
1455
|
"page_limit" => page_limit,
|
1456
|
+
"include_count" => include_count,
|
1467
1457
|
"sort" => sort,
|
1468
1458
|
"cursor" => cursor,
|
1469
1459
|
"include_audit" => include_audit
|
@@ -1488,9 +1478,6 @@ module IBMWatson
|
|
1488
1478
|
#
|
1489
1479
|
# If you want to create multiple entity values with a single API call, consider
|
1490
1480
|
# using the **[Update entity](#update-entity)** method instead.
|
1491
|
-
#
|
1492
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1493
|
-
# see **Rate limiting**.
|
1494
1481
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1495
1482
|
# @param entity [String] The name of the entity.
|
1496
1483
|
# @param value [String] The text of the entity value. This string must conform to the following
|
@@ -1516,6 +1503,8 @@ module IBMWatson
|
|
1516
1503
|
|
1517
1504
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1518
1505
|
|
1506
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1507
|
+
|
1519
1508
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1520
1509
|
|
1521
1510
|
headers = {
|
@@ -1553,9 +1542,6 @@ module IBMWatson
|
|
1553
1542
|
# @!method get_value(workspace_id:, entity:, value:, export: nil, include_audit: nil)
|
1554
1543
|
# Get entity value.
|
1555
1544
|
# Get information about an entity value.
|
1556
|
-
#
|
1557
|
-
# This operation is limited to 6000 requests per 5 minutes. For more information,
|
1558
|
-
# see **Rate limiting**.
|
1559
1545
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1560
1546
|
# @param entity [String] The name of the entity.
|
1561
1547
|
# @param value [String] The text of the entity value.
|
@@ -1572,6 +1558,8 @@ module IBMWatson
|
|
1572
1558
|
|
1573
1559
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1574
1560
|
|
1561
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1562
|
+
|
1575
1563
|
headers = {
|
1576
1564
|
}
|
1577
1565
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_value")
|
@@ -1603,9 +1591,6 @@ module IBMWatson
|
|
1603
1591
|
#
|
1604
1592
|
# If you want to update multiple entity values with a single API call, consider
|
1605
1593
|
# using the **[Update entity](#update-entity)** method instead.
|
1606
|
-
#
|
1607
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1608
|
-
# see **Rate limiting**.
|
1609
1594
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1610
1595
|
# @param entity [String] The name of the entity.
|
1611
1596
|
# @param value [String] The text of the entity value.
|
@@ -1644,6 +1629,8 @@ module IBMWatson
|
|
1644
1629
|
|
1645
1630
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1646
1631
|
|
1632
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1633
|
+
|
1647
1634
|
headers = {
|
1648
1635
|
}
|
1649
1636
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_value")
|
@@ -1680,9 +1667,6 @@ module IBMWatson
|
|
1680
1667
|
# @!method delete_value(workspace_id:, entity:, value:)
|
1681
1668
|
# Delete entity value.
|
1682
1669
|
# Delete a value from an entity.
|
1683
|
-
#
|
1684
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1685
|
-
# see **Rate limiting**.
|
1686
1670
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1687
1671
|
# @param entity [String] The name of the entity.
|
1688
1672
|
# @param value [String] The text of the entity value.
|
@@ -1694,6 +1678,8 @@ module IBMWatson
|
|
1694
1678
|
|
1695
1679
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1696
1680
|
|
1681
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1682
|
+
|
1697
1683
|
headers = {
|
1698
1684
|
}
|
1699
1685
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_value")
|
@@ -1719,29 +1705,31 @@ module IBMWatson
|
|
1719
1705
|
#########################
|
1720
1706
|
|
1721
1707
|
##
|
1722
|
-
# @!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)
|
1723
1709
|
# List entity value synonyms.
|
1724
1710
|
# List the synonyms for an entity value.
|
1725
|
-
#
|
1726
|
-
# This operation is limited to 2500 requests per 30 minutes. For more information,
|
1727
|
-
# see **Rate limiting**.
|
1728
1711
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1729
1712
|
# @param entity [String] The name of the entity.
|
1730
1713
|
# @param value [String] The text of the entity value.
|
1731
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.
|
1732
1718
|
# @param sort [String] The attribute by which returned entity value synonyms will be sorted. To reverse
|
1733
1719
|
# the sort order, prefix the value with a minus sign (`-`).
|
1734
1720
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1735
1721
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1736
1722
|
# the response.
|
1737
1723
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1738
|
-
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)
|
1739
1725
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1740
1726
|
|
1741
1727
|
raise ArgumentError.new("entity must be provided") if entity.nil?
|
1742
1728
|
|
1743
1729
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1744
1730
|
|
1731
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1732
|
+
|
1745
1733
|
headers = {
|
1746
1734
|
}
|
1747
1735
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_synonyms")
|
@@ -1750,6 +1738,7 @@ module IBMWatson
|
|
1750
1738
|
params = {
|
1751
1739
|
"version" => @version,
|
1752
1740
|
"page_limit" => page_limit,
|
1741
|
+
"include_count" => include_count,
|
1753
1742
|
"sort" => sort,
|
1754
1743
|
"cursor" => cursor,
|
1755
1744
|
"include_audit" => include_audit
|
@@ -1775,9 +1764,6 @@ module IBMWatson
|
|
1775
1764
|
# If you want to create multiple synonyms with a single API call, consider using the
|
1776
1765
|
# **[Update entity](#update-entity)** or **[Update entity
|
1777
1766
|
# value](#update-entity-value)** method instead.
|
1778
|
-
#
|
1779
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1780
|
-
# see **Rate limiting**.
|
1781
1767
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1782
1768
|
# @param entity [String] The name of the entity.
|
1783
1769
|
# @param value [String] The text of the entity value.
|
@@ -1794,6 +1780,8 @@ module IBMWatson
|
|
1794
1780
|
|
1795
1781
|
raise ArgumentError.new("value must be provided") if value.nil?
|
1796
1782
|
|
1783
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1784
|
+
|
1797
1785
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1798
1786
|
|
1799
1787
|
headers = {
|
@@ -1827,9 +1815,6 @@ module IBMWatson
|
|
1827
1815
|
# @!method get_synonym(workspace_id:, entity:, value:, synonym:, include_audit: nil)
|
1828
1816
|
# Get entity value synonym.
|
1829
1817
|
# Get information about a synonym of an entity value.
|
1830
|
-
#
|
1831
|
-
# This operation is limited to 6000 requests per 5 minutes. For more information,
|
1832
|
-
# see **Rate limiting**.
|
1833
1818
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1834
1819
|
# @param entity [String] The name of the entity.
|
1835
1820
|
# @param value [String] The text of the entity value.
|
@@ -1846,6 +1831,8 @@ module IBMWatson
|
|
1846
1831
|
|
1847
1832
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1848
1833
|
|
1834
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1835
|
+
|
1849
1836
|
headers = {
|
1850
1837
|
}
|
1851
1838
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_synonym")
|
@@ -1876,9 +1863,6 @@ module IBMWatson
|
|
1876
1863
|
# If you want to update multiple synonyms with a single API call, consider using the
|
1877
1864
|
# **[Update entity](#update-entity)** or **[Update entity
|
1878
1865
|
# value](#update-entity-value)** method instead.
|
1879
|
-
#
|
1880
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1881
|
-
# see **Rate limiting**.
|
1882
1866
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1883
1867
|
# @param entity [String] The name of the entity.
|
1884
1868
|
# @param value [String] The text of the entity value.
|
@@ -1898,6 +1882,8 @@ module IBMWatson
|
|
1898
1882
|
|
1899
1883
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1900
1884
|
|
1885
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1886
|
+
|
1901
1887
|
headers = {
|
1902
1888
|
}
|
1903
1889
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_synonym")
|
@@ -1929,9 +1915,6 @@ module IBMWatson
|
|
1929
1915
|
# @!method delete_synonym(workspace_id:, entity:, value:, synonym:)
|
1930
1916
|
# Delete entity value synonym.
|
1931
1917
|
# Delete a synonym from an entity value.
|
1932
|
-
#
|
1933
|
-
# This operation is limited to 1000 requests per 30 minutes. For more information,
|
1934
|
-
# see **Rate limiting**.
|
1935
1918
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1936
1919
|
# @param entity [String] The name of the entity.
|
1937
1920
|
# @param value [String] The text of the entity value.
|
@@ -1946,6 +1929,8 @@ module IBMWatson
|
|
1946
1929
|
|
1947
1930
|
raise ArgumentError.new("synonym must be provided") if synonym.nil?
|
1948
1931
|
|
1932
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1933
|
+
|
1949
1934
|
headers = {
|
1950
1935
|
}
|
1951
1936
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_synonym")
|
@@ -1971,23 +1956,25 @@ module IBMWatson
|
|
1971
1956
|
#########################
|
1972
1957
|
|
1973
1958
|
##
|
1974
|
-
# @!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)
|
1975
1960
|
# List dialog nodes.
|
1976
1961
|
# List the dialog nodes for a workspace.
|
1977
|
-
#
|
1978
|
-
# This operation is limited to 2500 requests per 30 minutes. For more information,
|
1979
|
-
# see **Rate limiting**.
|
1980
1962
|
# @param workspace_id [String] Unique identifier of the workspace.
|
1981
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.
|
1982
1967
|
# @param sort [String] The attribute by which returned dialog nodes will be sorted. To reverse the sort
|
1983
1968
|
# order, prefix the value with a minus sign (`-`).
|
1984
1969
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
1985
1970
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
1986
1971
|
# the response.
|
1987
1972
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
1988
|
-
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)
|
1989
1974
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
1990
1975
|
|
1976
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
1977
|
+
|
1991
1978
|
headers = {
|
1992
1979
|
}
|
1993
1980
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_dialog_nodes")
|
@@ -1996,6 +1983,7 @@ module IBMWatson
|
|
1996
1983
|
params = {
|
1997
1984
|
"version" => @version,
|
1998
1985
|
"page_limit" => page_limit,
|
1986
|
+
"include_count" => include_count,
|
1999
1987
|
"sort" => sort,
|
2000
1988
|
"cursor" => cursor,
|
2001
1989
|
"include_audit" => include_audit
|
@@ -2020,9 +2008,6 @@ module IBMWatson
|
|
2020
2008
|
#
|
2021
2009
|
# If you want to create multiple dialog nodes with a single API call, consider using
|
2022
2010
|
# the **[Update workspace](#update-workspace)** method instead.
|
2023
|
-
#
|
2024
|
-
# This operation is limited to 500 requests per 30 minutes. For more information,
|
2025
|
-
# see **Rate limiting**.
|
2026
2011
|
# @param workspace_id [String] Unique identifier of the workspace.
|
2027
2012
|
# @param dialog_node [String] The dialog node ID. This string must conform to the following restrictions:
|
2028
2013
|
# - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot
|
@@ -2038,7 +2023,7 @@ module IBMWatson
|
|
2038
2023
|
# @param output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
|
2039
2024
|
# node output, see the
|
2040
2025
|
# [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
|
2041
|
-
# @param context [
|
2026
|
+
# @param context [DialogNodeContext] The context for the dialog node.
|
2042
2027
|
# @param metadata [Hash] The metadata for the dialog node.
|
2043
2028
|
# @param next_step [DialogNodeNextStep] The next step to execute following this dialog node.
|
2044
2029
|
# @param title [String] The alias used to identify the dialog node. This string must conform to the
|
@@ -2054,13 +2039,16 @@ module IBMWatson
|
|
2054
2039
|
# @param digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
|
2055
2040
|
# @param user_label [String] A label that can be displayed externally to describe the purpose of the node to
|
2056
2041
|
# users.
|
2057
|
-
# @param disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions.
|
2042
|
+
# @param disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions. Valid
|
2043
|
+
# only when **type**=`standard` or `frame`.
|
2058
2044
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
2059
2045
|
# the response.
|
2060
2046
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
2061
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)
|
2062
2048
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
2063
2049
|
|
2050
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2051
|
+
|
2064
2052
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
2065
2053
|
|
2066
2054
|
headers = {
|
@@ -2112,9 +2100,6 @@ module IBMWatson
|
|
2112
2100
|
# @!method get_dialog_node(workspace_id:, dialog_node:, include_audit: nil)
|
2113
2101
|
# Get dialog node.
|
2114
2102
|
# Get information about a dialog node.
|
2115
|
-
#
|
2116
|
-
# This operation is limited to 6000 requests per 5 minutes. For more information,
|
2117
|
-
# see **Rate limiting**.
|
2118
2103
|
# @param workspace_id [String] Unique identifier of the workspace.
|
2119
2104
|
# @param dialog_node [String] The dialog node ID (for example, `get_order`).
|
2120
2105
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
@@ -2125,6 +2110,8 @@ module IBMWatson
|
|
2125
2110
|
|
2126
2111
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
2127
2112
|
|
2113
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2114
|
+
|
2128
2115
|
headers = {
|
2129
2116
|
}
|
2130
2117
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "get_dialog_node")
|
@@ -2154,9 +2141,6 @@ module IBMWatson
|
|
2154
2141
|
#
|
2155
2142
|
# If you want to update multiple dialog nodes with a single API call, consider using
|
2156
2143
|
# the **[Update workspace](#update-workspace)** method instead.
|
2157
|
-
#
|
2158
|
-
# This operation is limited to 500 requests per 30 minutes. For more information,
|
2159
|
-
# see **Rate limiting**.
|
2160
2144
|
# @param workspace_id [String] Unique identifier of the workspace.
|
2161
2145
|
# @param dialog_node [String] The dialog node ID (for example, `get_order`).
|
2162
2146
|
# @param new_dialog_node [String] The dialog node ID. This string must conform to the following restrictions:
|
@@ -2173,7 +2157,7 @@ module IBMWatson
|
|
2173
2157
|
# @param new_output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
|
2174
2158
|
# node output, see the
|
2175
2159
|
# [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
|
2176
|
-
# @param new_context [
|
2160
|
+
# @param new_context [DialogNodeContext] The context for the dialog node.
|
2177
2161
|
# @param new_metadata [Hash] The metadata for the dialog node.
|
2178
2162
|
# @param new_next_step [DialogNodeNextStep] The next step to execute following this dialog node.
|
2179
2163
|
# @param new_title [String] The alias used to identify the dialog node. This string must conform to the
|
@@ -2189,7 +2173,8 @@ module IBMWatson
|
|
2189
2173
|
# @param new_digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
|
2190
2174
|
# @param new_user_label [String] A label that can be displayed externally to describe the purpose of the node to
|
2191
2175
|
# users.
|
2192
|
-
# @param new_disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions.
|
2176
|
+
# @param new_disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions. Valid
|
2177
|
+
# only when **type**=`standard` or `frame`.
|
2193
2178
|
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
|
2194
2179
|
# the response.
|
2195
2180
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
@@ -2198,6 +2183,8 @@ module IBMWatson
|
|
2198
2183
|
|
2199
2184
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
2200
2185
|
|
2186
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2187
|
+
|
2201
2188
|
headers = {
|
2202
2189
|
}
|
2203
2190
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "update_dialog_node")
|
@@ -2247,9 +2234,6 @@ module IBMWatson
|
|
2247
2234
|
# @!method delete_dialog_node(workspace_id:, dialog_node:)
|
2248
2235
|
# Delete dialog node.
|
2249
2236
|
# Delete a dialog node from a workspace.
|
2250
|
-
#
|
2251
|
-
# This operation is limited to 500 requests per 30 minutes. For more information,
|
2252
|
-
# see **Rate limiting**.
|
2253
2237
|
# @param workspace_id [String] Unique identifier of the workspace.
|
2254
2238
|
# @param dialog_node [String] The dialog node ID (for example, `get_order`).
|
2255
2239
|
# @return [nil]
|
@@ -2258,6 +2242,8 @@ module IBMWatson
|
|
2258
2242
|
|
2259
2243
|
raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
|
2260
2244
|
|
2245
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2246
|
+
|
2261
2247
|
headers = {
|
2262
2248
|
}
|
2263
2249
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "delete_dialog_node")
|
@@ -2286,10 +2272,6 @@ module IBMWatson
|
|
2286
2272
|
# @!method list_logs(workspace_id:, sort: nil, filter: nil, page_limit: nil, cursor: nil)
|
2287
2273
|
# List log events in a workspace.
|
2288
2274
|
# List the events from the log of a specific workspace.
|
2289
|
-
#
|
2290
|
-
# If **cursor** is not specified, this operation is limited to 40 requests per 30
|
2291
|
-
# minutes. If **cursor** is specified, the limit is 120 requests per minute. For
|
2292
|
-
# more information, see **Rate limiting**.
|
2293
2275
|
# @param workspace_id [String] Unique identifier of the workspace.
|
2294
2276
|
# @param sort [String] How to sort the returned log events. You can sort by **request_timestamp**. To
|
2295
2277
|
# reverse the sort order, prefix the parameter value with a minus sign (`-`).
|
@@ -2302,6 +2284,8 @@ module IBMWatson
|
|
2302
2284
|
def list_logs(workspace_id:, sort: nil, filter: nil, page_limit: nil, cursor: nil)
|
2303
2285
|
raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
|
2304
2286
|
|
2287
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2288
|
+
|
2305
2289
|
headers = {
|
2306
2290
|
}
|
2307
2291
|
sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "list_logs")
|
@@ -2331,10 +2315,6 @@ module IBMWatson
|
|
2331
2315
|
# @!method list_all_logs(filter:, sort: nil, page_limit: nil, cursor: nil)
|
2332
2316
|
# List log events in all workspaces.
|
2333
2317
|
# List the events from the logs of all workspaces in the service instance.
|
2334
|
-
#
|
2335
|
-
# If **cursor** is not specified, this operation is limited to 40 requests per 30
|
2336
|
-
# minutes. If **cursor** is specified, the limit is 120 requests per minute. For
|
2337
|
-
# more information, see **Rate limiting**.
|
2338
2318
|
# @param filter [String] A cacheable parameter that limits the results to those matching the specified
|
2339
2319
|
# filter. You must specify a filter query that includes a value for `language`, as
|
2340
2320
|
# well as a value for `request.context.system.assistant_id`, `workspace_id`, or
|
@@ -2346,6 +2326,8 @@ module IBMWatson
|
|
2346
2326
|
# @param cursor [String] A token identifying the page of results to retrieve.
|
2347
2327
|
# @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
|
2348
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
|
+
|
2349
2331
|
raise ArgumentError.new("filter must be provided") if filter.nil?
|
2350
2332
|
|
2351
2333
|
headers = {
|
@@ -2386,12 +2368,11 @@ module IBMWatson
|
|
2386
2368
|
# with a request that passes data. For more information about personal data and
|
2387
2369
|
# customer IDs, see [Information
|
2388
2370
|
# security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security).
|
2389
|
-
#
|
2390
|
-
# This operation is limited to 4 requests per minute. For more information, see
|
2391
|
-
# **Rate limiting**.
|
2392
2371
|
# @param customer_id [String] The customer ID for which all data is to be deleted.
|
2393
2372
|
# @return [nil]
|
2394
2373
|
def delete_user_data(customer_id:)
|
2374
|
+
raise ArgumentError.new("version must be provided") if version.nil?
|
2375
|
+
|
2395
2376
|
raise ArgumentError.new("customer_id must be provided") if customer_id.nil?
|
2396
2377
|
|
2397
2378
|
headers = {
|
@@ -2415,5 +2396,50 @@ module IBMWatson
|
|
2415
2396
|
)
|
2416
2397
|
nil
|
2417
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
|
2418
2444
|
end
|
2419
2445
|
end
|