ibm_watson 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4855d1f0d0409f6fcf35241392746eeebf914f291324de8800aa887f9e8ee96c
-  data.tar.gz: 70ca55c6305cd18b96830799be213fdd2aa33d35252cf7016cb4582e6eafe29c
+  metadata.gz: b32319d7160def3e54e70e394e6625a1c7151ab1461a0ad10d71ec003c668f2e
+  data.tar.gz: ebf50af3225db592bde39d95a52e948b6afcf7aeb4592e264fb7c042d372da08
 SHA512:
-  metadata.gz: 4465338e55529801fb063053aac73c41270d83e258a6bd9f0005f4bdaa511786cfdea38e1b5419d4f276382980f7f1aeb4be376f6ca099266e5d1cf46086f10f
-  data.tar.gz: 38beeb9ca5a85c78d0419cbae8868d0cfb2f4200ea3e7ee34f897e86b314049977e790d0302d5ebba268bb869ba2f83bdd586f97ad0cf76f1fbaf93308cd491a
+  metadata.gz: 2b919569fd64e94902d4443f4f6b223b7cb0275471b45bc3b3910a8049b34d5f6285bb4ab590cef8644223abb87121f747a23d497a98035850a9110665cf705b
+  data.tar.gz: 3139ad59f347c4e3d51dec08603b80fccc71200748aeed8c2f9cd7b1fa2087371982f70c6fcc1d0cd50ffc6f21b2803c2454d5b0e3fd6631ce4edb1282780e40

data/README.md

@@ -14,48 +14,29 @@
 
 Ruby gem to quickly get started with the various [IBM Watson][wdc] services.
 
-<details>
-  <summary>Table of Contents</summary>
-
-* [Before you begin](#before-you-begin)
-* [Installation](#installation)
-* [Examples](#examples)
-* [Discovery v2 only on CP4D](#discovery-v2-only-on-cp4d)
-* [Running in IBM Cloud](#running-in-ibm-cloud)
-* [Authentication](#authentication)
-  * [Getting credentials](#getting-credentials)
-  * [IAM](#iam)
-  * [Username and password](#username-and-password)
-* [Sending requests asynchronously](#sending-requests-asynchronously)
-* [Sending request headers](#sending-request-headers)
-* [Parsing HTTP response info](#parsing-http-response-info)
-* [Configuring the HTTP client](#configuring-the-http-client)
-* [Using Websockets](#using-websockets)
-* [Ruby version](#ruby-version)
-* [Contributing](#contributing)
-* [License](#license)
-* [Featured Projects](#featured-projects)
-
-</details>
-
 ## Announcements
+### Tone Analyzer Deprecation
+​
+As of this major release, 3.0.0, the Tone Analyzer api has been removed in preparation for deprecation. If you wish to continue using this sdk to make calls to Tone Analyzer until its final deprecation, you will have to use a previous version.
+​
+On 24 February 2022, IBM announced the deprecation of the Tone Analyzer service. The service will no longer be available as of 24 February 2023. As of 24 February 2022, you will not be able to create new instances. Existing instances will be supported until 24 February 2023.
+​
+As an alternative, we encourage you to consider migrating to the Natural Language Understanding service on IBM Cloud. With Natural Language Understanding, tone analysis is done by using a pre-built classifications model, which provides an easy way to detect language tones in written text. For more information, see [Migrating from Watson Tone Analyzer Customer Engagement endpoint to Natural Language Understanding](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-tone_analytics).
+​
+### Natural Language Classifier Deprecation
+​
+As of this major release, 3.0.0, the NLC api has been removed in preparation for deprecation. If you wish to continue using this sdk to make calls to NLC until its final deprecation, you will have to use a previous version.
+​
+On 9 August 2021, IBM announced the deprecation of the Natural Language Classifier service. The service will no longer be available from 8 August 2022. As of 9 September 2021, you will not be able to create new instances. Existing instances will be supported until 8 August 2022. Any instance that still exists on that date will be deleted.
+​
+As an alternative, we encourage you to consider migrating to the Natural Language Understanding service on IBM Cloud that uses deep learning to extract data and insights from text such as keywords, categories, sentiment, emotion, and syntax, along with advanced multi-label text classification capabilities, to provide even richer insights for your business or industry. For more information, see [Migrating to Natural Language Understanding](https://cloud.ibm.com/docs/natural-language-classifier?topic=natural-language-classifier-migrating).
+
 ### Support for 2.7 ruby
 To support 2.7 the http gem dependency is updated to 4.4.0. Since it conflicted with the dependency in the ruby-sdk-core that gem was also updated.  Using 2.0.2 or above ruby sdk will require a core of 1.1.3 or above.
 
 ### Updating endpoint URLs from watsonplatform.net
 Watson API endpoint URLs at watsonplatform.net are changing and will not work after 26 May 2021. Update your calls to use the newer endpoint URLs. For more information, see https://cloud.ibm.com/docs/watson?topic=watson-endpoint-change.
 
-### Personality Insights deprecation
-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.
-
-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.
-
-### Visual Recognition deprecation
-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.
-
-### Compare and Comply deprecation
-IBM Watson™ Compare and Comply is discontinued. Existing instances are supported until 30 November 2021, but as of 1 December 2020, you can't create instances. Any instance that exists on 30 November 2021 will be deleted. Consider migrating to Watson Discovery Premium on IBM Cloud for your Compare and Comply use cases. To start the migration process, visit https://ibm.biz/contact-wdc-premium.
-
 ## Before you begin
 
 * You need an [IBM Cloud][ibm-cloud-onboarding] account.
@@ -84,10 +65,6 @@ require "ibm_watson"
 
 The [examples][examples] folder has basic and advanced examples. The examples within each service assume that you already have [service credentials](#getting-credentials).
 
-## Discovery v2 only on CP4D
-
-Discovery v2 is only available on Cloud Pak for Data.
-
 ## Running in IBM Cloud
 
 If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable.

data/lib/ibm_watson/assistant_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2018, 2020.
+# (C) Copyright IBM Corp. 2018, 2022.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-# IBM OpenAPI SDK Code Generator Version: 3.31.0-902c9336-20210504-161156
+# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 #
 # The IBM Watson™ Assistant service combines machine learning, natural language
 # understanding, and an integrated dialog editor to create conversation flows between your
@@ -43,7 +43,7 @@ module IBMWatson
     #
     # @param args [Hash] The args to initialize with
     # @option args version [String] Release date of the API version you want to use. Specify dates in YYYY-MM-DD
-    #   format. The current version is `2020-04-01`.
+    #   format. The current version is `2021-11-27`.
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
@@ -2391,7 +2391,8 @@ module IBMWatson
     # @param filter [String] A cacheable parameter that limits the results to those matching the specified
     #   filter. You must specify a filter query that includes a value for `language`, as
     #   well as a value for `request.context.system.assistant_id`, `workspace_id`, or
-    #   `request.context.metadata.deployment`. For more information, see the
+    #   `request.context.metadata.deployment`. These required filters must be specified
+    #   using the exact match (`::`) operator. For more information, see the
     #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
     # @param sort [String] How to sort the returned log events. You can sort by **request_timestamp**. To
     #   reverse the sort order, prefix the parameter value with a minus sign (`-`).

data/lib/ibm_watson/assistant_v2.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2018, 2020.
+# (C) Copyright IBM Corp. 2018, 2022.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-# IBM OpenAPI SDK Code Generator Version: 3.31.0-902c9336-20210504-161156
+# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 #
 # The IBM Watson™ Assistant service combines machine learning, natural language
 # understanding, and an integrated dialog editor to create conversation flows between your
@@ -43,7 +43,7 @@ module IBMWatson
     #
     # @param args [Hash] The args to initialize with
     # @option args version [String] Release date of the API version you want to use. Specify dates in YYYY-MM-DD
-    #   format. The current version is `2020-09-24`.
+    #   format. The current version is `2021-11-27`.
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.

data/lib/ibm_watson/discovery_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2018, 2020.
+# (C) Copyright IBM Corp. 2018, 2022.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-# IBM OpenAPI SDK Code Generator Version: 3.31.0-902c9336-20210504-161156
+# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 #
 # IBM Watson™ Discovery is a cognitive search and content analytics engine that
 # you can add to applications to identify patterns, trends and actionable insights to
@@ -185,9 +185,8 @@ module IBMWatson
     # @param environment_id [String] The ID of the environment.
     # @param name [String] Name that identifies the environment.
     # @param description [String] Description of the environment.
-    # @param size [String] Size that the environment should be increased to. Environment size cannot be
-    #   modified when using a Lite plan. Environment size can only increased and not
-    #   decreased.
+    # @param size [String] Size to change the environment to. **Note:** Lite plan users cannot change the
+    #   environment size.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def update_environment(environment_id:, name: nil, description: nil, size: nil)
       raise ArgumentError.new("version must be provided") if version.nil?
@@ -1809,7 +1808,7 @@ module IBMWatson
     # @param environment_id [String] The ID of the environment.
     # @param collection_id [String] The ID of the collection.
     # @param prefix [String] The prefix to use for autocompletion. For example, the prefix `Ho` could
-    #   autocomplete to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are.
+    #   autocomplete to `hot`, `housing`, or `how`.
     # @param field [String] The field in the result documents that autocompletion suggestions are identified
     #   from.
     # @param count [Fixnum] The number of autocompletion suggestions to return.
@@ -2649,10 +2648,7 @@ module IBMWatson
     # @param credential_details [CredentialDetails] Object containing details of the stored credentials.
     #
     #   Obtain credentials for your source from the administrator of the source.
-    # @param status [String] The current status of this set of credentials. `connected` indicates that the
-    #   credentials are available to use with the source configuration of a collection.
-    #   `invalid` refers to the credentials (for example, the password provided has
-    #   expired) and must be corrected before they can be used with a collection.
+    # @param status [StatusDetails] Object that contains details about the status of the authentication process.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def create_credentials(environment_id:, source_type: nil, credential_details: nil, status: nil)
       raise ArgumentError.new("version must be provided") if version.nil?
@@ -2746,10 +2742,7 @@ module IBMWatson
     # @param credential_details [CredentialDetails] Object containing details of the stored credentials.
     #
     #   Obtain credentials for your source from the administrator of the source.
-    # @param status [String] The current status of this set of credentials. `connected` indicates that the
-    #   credentials are available to use with the source configuration of a collection.
-    #   `invalid` refers to the credentials (for example, the password provided has
-    #   expired) and must be corrected before they can be used with a collection.
+    # @param status [StatusDetails] Object that contains details about the status of the authentication process.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def update_credentials(environment_id:, credential_id:, source_type: nil, credential_details: nil, status: nil)
       raise ArgumentError.new("version must be provided") if version.nil?