ibm_watson 1.5.0 → 2.0.2

data/lib/ibm_watson/tone_analyzer_v3.rb

@@ -13,7 +13,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# IBM OpenAPI SDK Code Generator Version: 3.19.0-be3b4618-20201113-200858
+#
 # The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect
 # emotional and language tones in written text. The service can analyze tone at both the
 # document and sentence levels. You can use the service to understand how your written
@@ -39,22 +41,15 @@ module IBMWatson
   class ToneAnalyzerV3 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
     DEFAULT_SERVICE_NAME = "tone_analyzer"
-    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/tone-analyzer/api"
+    DEFAULT_SERVICE_URL = "https://api.us-south.tone-analyzer.watson.cloud.ibm.com"
+    attr_accessor :version
     ##
     # @!method initialize(args)
     # Construct a new client for the Tone Analyzer service.
     #
     # @param args [Hash] The args to initialize with
-    # @option args version [String] The API version date to use with the service, in
-    #   "YYYY-MM-DD" format. Whenever the API is changed in a backwards
-    #   incompatible way, a new minor version of the API is released.
-    #   The service uses the API version for the date you specify, or
-    #   the most recent version before that date. Note that you should
-    #   not programmatically specify the current date at runtime, in
-    #   case the API has been updated since your application's release.
-    #   Instead, specify a version date that is compatible with your
-    #   application, and don't change it until your application is
-    #   ready for a later version.
+    # @option args version [String] Release date of the version of the API you want to use. Specify dates in
+    #   YYYY-MM-DD format. The current version is `2017-09-21`.
     # @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.
@@ -63,10 +58,10 @@ module IBMWatson
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
-      defaults[:version] = nil
       defaults[:service_url] = DEFAULT_SERVICE_URL
       defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      defaults[:version] = nil
       user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
@@ -131,6 +126,8 @@ module IBMWatson
     #   **Accept-Language**.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def tone(tone_input:, content_type: nil, sentences: nil, tones: nil, content_language: nil, accept_language: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("tone_input must be provided") if tone_input.nil?
 
       headers = {
@@ -199,6 +196,8 @@ module IBMWatson
     #   **Accept-Language**.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def tone_chat(utterances:, content_language: nil, accept_language: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("utterances must be provided") if utterances.nil?
 
       headers = {

data/lib/ibm_watson/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IBMWatson
-  VERSION = "1.5.0"
+  VERSION = "2.0.2"
 end

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -13,10 +13,17 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
-# The IBM Watson™ Visual Recognition service uses deep learning algorithms to
-# identify scenes and objects in images that you upload to the service. You can create and
-# train a custom classifier to identify subjects that suit your needs.
+#
+# IBM OpenAPI SDK Code Generator Version: 3.19.0-be3b4618-20201113-200858
+#
+# 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.
+# {: deprecated}
+#
+# The IBM Watson Visual Recognition service uses deep learning algorithms to identify
+# scenes and objects in images that you upload to the service. You can create and train a
+# custom classifier to identify subjects that suit your needs.
 
 require "concurrent"
 require "erb"
@@ -31,34 +38,28 @@ module IBMWatson
   class VisualRecognitionV3 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
     DEFAULT_SERVICE_NAME = "visual_recognition"
-    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/visual-recognition/api"
+    DEFAULT_SERVICE_URL = "https://api.us-south.visual-recognition.watson.cloud.ibm.com"
+    attr_accessor :version
     ##
     # @!method initialize(args)
     # Construct a new client for the Visual Recognition service.
     #
     # @param args [Hash] The args to initialize with
-    # @option args version [String] The API version date to use with the service, in
-    #   "YYYY-MM-DD" format. Whenever the API is changed in a backwards
-    #   incompatible way, a new minor version of the API is released.
-    #   The service uses the API version for the date you specify, or
-    #   the most recent version before that date. Note that you should
-    #   not programmatically specify the current date at runtime, in
-    #   case the API has been updated since your application's release.
-    #   Instead, specify a version date that is compatible with your
-    #   application, and don't change it until your application is
-    #   ready for a later version.
+    # @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 `2018-03-19`.
     # @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.
     # @option args service_name [String] The name of the service to configure. Will be used as the key to load
     #   any external configuration, if applicable.
     def initialize(args = {})
+      warn "On 1 December 2021, Visual Recognition will no longer be available. For more information, see https://github.com/watson-developer-cloud/ruby-sdk/tree/master#visual-recognition-deprecation."
       @__async_initialized__ = false
       defaults = {}
-      defaults[:version] = nil
       defaults[:service_url] = DEFAULT_SERVICE_URL
       defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      defaults[:version] = nil
       user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
@@ -112,6 +113,8 @@ module IBMWatson
     # @param accept_language [String] The desired language of parts of the response. See the response for details.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def classify(images_file: nil, images_filename: nil, images_file_content_type: nil, url: nil, threshold: nil, owners: nil, classifier_ids: nil, accept_language: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
         "Accept-Language" => accept_language
       }
@@ -198,6 +201,8 @@ module IBMWatson
     # @param negative_examples_filename [String] The filename for negative_examples.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def create_classifier(name:, positive_examples:, negative_examples: nil, negative_examples_filename: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("name must be provided") if name.nil?
 
       raise ArgumentError.new("positive_examples must be a hash") unless positive_examples.is_a?(Hash)
@@ -253,6 +258,8 @@ module IBMWatson
     #   return a brief list of classifiers.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def list_classifiers(verbose: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "list_classifiers")
@@ -282,6 +289,8 @@ module IBMWatson
     # @param classifier_id [String] The ID of the classifier.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_classifier(classifier_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
@@ -350,6 +359,8 @@ module IBMWatson
     # @param negative_examples_filename [String] The filename for negative_examples.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def update_classifier(classifier_id:, positive_examples: nil, negative_examples: nil, negative_examples_filename: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       raise ArgumentError.new("positive_examples must be a hash") unless positive_examples.nil? || positive_examples.is_a?(Hash)
@@ -401,6 +412,8 @@ module IBMWatson
     # @param classifier_id [String] The ID of the classifier.
     # @return [nil]
     def delete_classifier(classifier_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
@@ -435,6 +448,8 @@ module IBMWatson
     # @param classifier_id [String] The ID of the classifier.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_core_ml_model(classifier_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
@@ -474,6 +489,8 @@ module IBMWatson
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("customer_id must be provided") if customer_id.nil?
 
       headers = {

data/lib/ibm_watson/visual_recognition_v4.rb

@@ -13,9 +13,16 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
-# Provide images to the IBM Watson™ Visual Recognition service for analysis. The
-# service detects objects based on a set of images with training data.
+#
+# IBM OpenAPI SDK Code Generator Version: 3.19.0-be3b4618-20201113-200858
+#
+# 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.
+# {: deprecated}
+#
+# Provide images to the IBM Watson Visual Recognition service for analysis. The service
+# detects objects based on a set of images with training data.
 
 require "concurrent"
 require "erb"
@@ -30,34 +37,28 @@ module IBMWatson
   class VisualRecognitionV4 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
     DEFAULT_SERVICE_NAME = "visual_recognition"
-    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/visual-recognition/api"
+    DEFAULT_SERVICE_URL = "https://api.us-south.visual-recognition.watson.cloud.ibm.com"
+    attr_accessor :version
     ##
     # @!method initialize(args)
     # Construct a new client for the Visual Recognition service.
     #
     # @param args [Hash] The args to initialize with
-    # @option args version [String] The API version date to use with the service, in
-    #   "YYYY-MM-DD" format. Whenever the API is changed in a backwards
-    #   incompatible way, a new minor version of the API is released.
-    #   The service uses the API version for the date you specify, or
-    #   the most recent version before that date. Note that you should
-    #   not programmatically specify the current date at runtime, in
-    #   case the API has been updated since your application's release.
-    #   Instead, specify a version date that is compatible with your
-    #   application, and don't change it until your application is
-    #   ready for a later version.
+    # @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 `2019-02-11`.
     # @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.
     # @option args service_name [String] The name of the service to configure. Will be used as the key to load
     #   any external configuration, if applicable.
     def initialize(args = {})
+      warn "On 1 December 2021, Visual Recognition will no longer be available. For more information, see https://github.com/watson-developer-cloud/ruby-sdk/tree/master#visual-recognition-deprecation."
       @__async_initialized__ = false
       defaults = {}
-      defaults[:version] = nil
       defaults[:service_url] = DEFAULT_SERVICE_URL
       defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      defaults[:version] = nil
       user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
@@ -101,6 +102,8 @@ module IBMWatson
     # @param threshold [Float] The minimum score a feature must have to be returned.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def analyze(collection_ids:, features:, images_file: nil, image_url: nil, threshold: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_ids must be provided") if collection_ids.nil?
 
       raise ArgumentError.new("features must be provided") if features.nil?
@@ -170,6 +173,8 @@ module IBMWatson
     # @param description [String] The description of the collection.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def create_collection(name: nil, description: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V4", "create_collection")
@@ -203,6 +208,8 @@ module IBMWatson
     # Retrieves a list of collections for the service instance.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def list_collections
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V4", "list_collections")
@@ -231,6 +238,8 @@ module IBMWatson
     # @param collection_id [String] The identifier of the collection.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_collection(collection_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       headers = {
@@ -267,6 +276,8 @@ module IBMWatson
     # @param description [String] The description of the collection.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def update_collection(collection_id:, name: nil, description: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       headers = {
@@ -303,6 +314,8 @@ module IBMWatson
     # @param collection_id [String] The identifier of the collection.
     # @return [nil]
     def delete_collection(collection_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       headers = {
@@ -342,6 +355,8 @@ module IBMWatson
     # @param model_format [String] The format of the returned model.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_model_file(collection_id:, feature:, model_format:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("feature must be provided") if feature.nil?
@@ -405,6 +420,8 @@ module IBMWatson
     #   than 32 characters.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def add_images(collection_id:, images_file: nil, image_url: nil, training_data: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       headers = {
@@ -454,6 +471,8 @@ module IBMWatson
     # @param collection_id [String] The identifier of the collection.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def list_images(collection_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       headers = {
@@ -485,6 +504,8 @@ module IBMWatson
     # @param image_id [String] The identifier of the image.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_image_details(collection_id:, image_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("image_id must be provided") if image_id.nil?
@@ -518,6 +539,8 @@ module IBMWatson
     # @param image_id [String] The identifier of the image.
     # @return [nil]
     def delete_image(collection_id:, image_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("image_id must be provided") if image_id.nil?
@@ -554,6 +577,8 @@ module IBMWatson
     #   For example, an original 800 x 1000 image is resized to 160 x 200 pixels.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_jpeg_image(collection_id:, image_id:, size: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("image_id must be provided") if image_id.nil?
@@ -590,6 +615,8 @@ module IBMWatson
     # @param collection_id [String] The identifier of the collection.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def list_object_metadata(collection_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       headers = {
@@ -625,6 +652,8 @@ module IBMWatson
     #   `sys-`.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def update_object_metadata(collection_id:, object:, new_object:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("object must be provided") if object.nil?
@@ -665,6 +694,8 @@ module IBMWatson
     # @param object [String] The name of the object.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_object_metadata(collection_id:, object:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("object must be provided") if object.nil?
@@ -699,6 +730,8 @@ module IBMWatson
     # @param object [String] The name of the object.
     # @return [nil]
     def delete_object(collection_id:, object:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("object must be provided") if object.nil?
@@ -736,6 +769,8 @@ module IBMWatson
     # @param collection_id [String] The identifier of the collection.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def train(collection_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       headers = {
@@ -777,6 +812,8 @@ module IBMWatson
     # @param objects [Array[TrainingDataObject]] Training data for specific objects.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def add_image_training_data(collection_id:, image_id:, objects: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
       raise ArgumentError.new("image_id must be provided") if image_id.nil?
@@ -812,14 +849,16 @@ module IBMWatson
     # Get training usage.
     # Information about the completed training events. You can use this information to
     #   determine how close you are to the training limits for the month.
-    # @param start_time [String] The earliest day to include training events. Specify dates in YYYY-MM-DD format.
+    # @param start_time [Time] The earliest day to include training events. Specify dates in YYYY-MM-DD format.
     #   If empty or not specified, the earliest training event is included.
-    # @param end_time [String] The most recent day to include training events. Specify dates in YYYY-MM-DD
+    # @param end_time [Time] The most recent day to include training events. Specify dates in YYYY-MM-DD
     #   format. All events for the day are included. If empty or not specified, the
     #   current day is used. Specify the same value as `start_time` to request events for
     #   a single day.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def get_training_usage(start_time: nil, end_time: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V4", "get_training_usage")
@@ -859,6 +898,8 @@ module IBMWatson
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("customer_id must be provided") if customer_id.nil?
 
       headers = {

data/test/integration/test_assistant_v1.rb

@@ -382,6 +382,15 @@ if !ENV["ASSISTANT_APIKEY"].nil? && !ENV["ASSISTANT_URL"].nil?
       )
       assert(service_response.nil?)
     end
+
+    def test_bulk_classify
+      skip "Covered with the unit test.  No need to run it here"
+
+      service_response = service.bulk_classify(
+        workspace_id: ENV["ASSISTANT_WORKSPACE_ID"]
+      )
+      assert(service_response.nil?)
+    end
   end
 else
   class AssistantV1Test < Minitest::Test