ibm_watson 0.14.0 → 0.15.0

data/lib/ibm_watson/tone_analyzer_v3.rb

@@ -29,7 +29,6 @@
 require "concurrent"
 require "erb"
 require "json"
-
 require "ibm_cloud_sdk_core"
 require_relative "./common.rb"
 
@@ -98,7 +97,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method tone(tone_input:, content_type: nil, sentences: nil, tones: nil, content_language: nil, accept_language: nil)
+    # @!method tone(tone_input:, sentences: nil, tones: nil, content_language: nil, accept_language: nil, content_type: nil)
     # Analyze general tone.
     # Use the general purpose endpoint to analyze the tone of your input content. The
     #   service analyzes the content for emotional and language tones. The method always
@@ -122,8 +121,6 @@ module IBMWatson
     #   endpoint](https://cloud.ibm.com/docs/services/tone-analyzer/using-tone.html#using-the-general-purpose-endpoint).
     # @param tone_input [ToneInput] JSON, plain text, or HTML input that contains the content to be analyzed. For JSON
     #   input, provide an object of type `ToneInput`.
-    # @param content_type [String] The type of the input. A character encoding can be specified by including a
-    #   `charset` parameter. For example, 'text/plain;charset=utf-8'.
     # @param sentences [Boolean] Indicates whether the service is to return an analysis of each individual sentence
     #   in addition to its analysis of the full document. If `true` (the default), the
     #   service returns results for each sentence.
@@ -145,16 +142,19 @@ module IBMWatson
     #   variants are treated as their parent language; for example, `en-US` is interpreted
     #   as `en`. You can use different languages for **Content-Language** and
     #   **Accept-Language**.
+    # @param content_type [String] The type of the input. A character encoding can be specified by including a
+    #   `charset` parameter. For example, 'text/plain;charset=utf-8'.
     # @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)
+    def tone(tone_input:, sentences: nil, tones: nil, content_language: nil, accept_language: nil, content_type: nil)
       raise ArgumentError.new("tone_input must be provided") if tone_input.nil?
 
       headers = {
-        "Content-Type" => content_type,
         "Content-Language" => content_language,
-        "Accept-Language" => accept_language
+        "Accept-Language" => accept_language,
+        "Content-Type" => content_type
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "tone_analyzer", service_version: "V3", operation_id: "tone")
+      sdk_headers = Common.new.get_sdk_headers("tone_analyzer", "V3", "tone")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version,
@@ -219,7 +219,8 @@ module IBMWatson
         "Content-Language" => content_language,
         "Accept-Language" => accept_language
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "tone_analyzer", service_version: "V3", operation_id: "tone_chat")
+      sdk_headers = Common.new.get_sdk_headers("tone_analyzer", "V3", "tone_chat")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version

data/lib/ibm_watson/version.rb

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

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -21,7 +21,6 @@
 require "concurrent"
 require "erb"
 require "json"
-
 require "ibm_cloud_sdk_core"
 require_relative "./common.rb"
 
@@ -78,33 +77,33 @@ module IBMWatson
     #########################
 
     ##
-    # @!method classify(images_file: nil, accept_language: nil, url: nil, threshold: nil, owners: nil, classifier_ids: nil, images_file_content_type: nil, images_filename: nil)
+    # @!method classify(images_file: nil, images_filename: nil, images_file_content_type: nil, url: nil, threshold: nil, owners: nil, classifier_ids: nil, accept_language: nil)
     # Classify images.
     # Classify images with built-in or custom classifiers.
-    # @param images_file [File] An image file (.jpg, .png) or .zip file with images. Maximum image size is 10 MB.
-    #   Include no more than 20 images and limit the .zip file to 100 MB. Encode the image
-    #   and .zip file names in UTF-8 if they contain non-ASCII characters. The service
-    #   assumes UTF-8 encoding if it encounters non-ASCII characters.
+    # @param images_file [File] An image file (.gif, .jpg, .png, .tif) or .zip file with images. Maximum image
+    #   size is 10 MB. Include no more than 20 images and limit the .zip file to 100 MB.
+    #   Encode the image and .zip file names in UTF-8 if they contain non-ASCII
+    #   characters. The service assumes UTF-8 encoding if it encounters non-ASCII
+    #   characters.
     #
     #   You can also include an image with the **url** parameter.
-    # @param accept_language [String] The desired language of parts of the response. See the response for details.
-    # @param url [String] The URL of an image to analyze. Must be in .jpg, or .png format. The minimum
-    #   recommended pixel density is 32X32 pixels per inch, and the maximum image size is
-    #   10 MB.
+    # @param images_filename [String] The filename for images_file.
+    # @param images_file_content_type [String] The content type of images_file.
+    # @param url [String] The URL of an image (.gif, .jpg, .png, .tif) to analyze. The minimum recommended
+    #   pixel density is 32X32 pixels, but the service tends to perform better with images
+    #   that are at least 224 x 224 pixels. The maximum image size is 10 MB.
     #
     #   You can also include images with the **images_file** parameter.
     # @param threshold [Float] The minimum score a class must have to be displayed in the response. Set the
-    #   threshold to `0.0` to ignore the classification score and return all values.
-    # @param owners [Array[String]] The categories of classifiers to apply. Use `IBM` to classify against the
-    #   `default` general classifier, and use `me` to classify against your custom
-    #   classifiers. To analyze the image against both classifier categories, set the
-    #   value to both `IBM` and `me`.
-    #
-    #   The built-in `default` classifier is used if both **classifier_ids** and
-    #   **owners** parameters are empty.
-    #
-    #   The **classifier_ids** parameter overrides **owners**, so make sure that
-    #   **classifier_ids** is empty.
+    #   threshold to `0.0` to return all identified classes.
+    # @param owners [Array[String]] The categories of classifiers to apply. The **classifier_ids** parameter overrides
+    #   **owners**, so make sure that **classifier_ids** is empty.
+    #   - Use `IBM` to classify against the `default` general classifier. You get the same
+    #   result if both **classifier_ids** and **owners** parameters are empty.
+    #   - Use `me` to classify against all your custom classifiers. However, for better
+    #   performance use **classifier_ids** to specify the specific custom classifiers to
+    #   apply.
+    #   - Use both `IBM` and `me` to analyze the image against both classifier categories.
     # @param classifier_ids [Array[String]] Which classifiers to apply. Overrides the **owners** parameter. You can specify
     #   both custom and built-in classifier IDs. The built-in `default` classifier is used
     #   if both **classifier_ids** and **owners** parameters are empty.
@@ -113,14 +112,14 @@ module IBMWatson
     #   - `default`: Returns classes from thousands of general tags.
     #   - `food`: Enhances specificity and accuracy for images of food items.
     #   - `explicit`: Evaluates whether the image might be pornographic.
-    # @param images_file_content_type [String] The content type of images_file.
-    # @param images_filename [String] The filename for images_file.
+    # @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, accept_language: nil, url: nil, threshold: nil, owners: nil, classifier_ids: nil, images_file_content_type: nil, images_filename: nil)
+    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)
       headers = {
         "Accept-Language" => accept_language
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "classify")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "classify")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -164,7 +163,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method detect_faces(images_file: nil, url: nil, images_file_content_type: nil, images_filename: nil, accept_language: nil)
+    # @!method detect_faces(images_file: nil, images_filename: nil, images_file_content_type: nil, url: nil, accept_language: nil)
     # Detect faces in images.
     # **Important:** On April 2, 2018, the identity information in the response to calls
     #   to the Face model was removed. The identity information refers to the `name` of
@@ -187,21 +186,22 @@ module IBMWatson
     #   characters.
     #
     #   You can also include an image with the **url** parameter.
+    # @param images_filename [String] The filename for images_file.
+    # @param images_file_content_type [String] The content type of images_file.
     # @param url [String] The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The
     #   minimum recommended pixel density is 32X32 pixels, but the service tends to
     #   perform better with images that are at least 224 x 224 pixels. The maximum image
     #   size is 10 MB. Redirects are followed, so you can use a shortened URL.
     #
     #   You can also include images with the **images_file** parameter.
-    # @param images_file_content_type [String] The content type of images_file.
-    # @param images_filename [String] The filename for images_file.
     # @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 detect_faces(images_file: nil, url: nil, accept_language: nil, images_file_content_type: nil, images_filename: nil)
+    def detect_faces(images_file: nil, images_filename: nil, images_file_content_type: nil, url: nil, accept_language: nil)
       headers = {
         "Accept-Language" => accept_language
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "detect_faces")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "detect_faces")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -236,7 +236,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method create_classifier(name:, positive_examples:, negative_examples: nil, positive_examples_filename: nil, negative_examples_filename: nil)
+    # @!method create_classifier(name:, positive_examples:, negative_examples: nil, negative_examples_filename: nil)
     # Create a classifier.
     # Train a new multi-faceted classifier on the uploaded image data. Create your
     #   custom classifier with positive or negative examples. Include at least two sets of
@@ -247,7 +247,7 @@ module IBMWatson
     #   file names, and classifier and class names). The service assumes UTF-8 encoding if
     #   it encounters non-ASCII characters.
     # @param name [String] The name of the new classifier. Encode special characters in UTF-8.
-    # @param positive_examples [Hash] A .zip file of images that depict the visual subject of a class in the new
+    # @param positive_examples [File] A .zip file of images that depict the visual subject of a class in the new
     #   classifier. You can include more than one positive example file in a call.
     #
     #   Specify the parameter name by appending `_positive_examples` to the class name.
@@ -263,20 +263,18 @@ module IBMWatson
     #   of the new classifier. Must contain a minimum of 10 images.
     #
     #   Encode special characters in the file name in UTF-8.
-    # @param positive_examples_filename [Hash] The filename for positive_examples.
     # @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, positive_examples_filename: nil, negative_examples_filename: nil)
+    def create_classifier(name:, positive_examples:, negative_examples: nil, negative_examples_filename: 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)
       raise ArgumentError.new("positive_examples must have at least one hash entry") if positive_examples.empty?
 
-      raise ArgumentError.new("positive_examples_filename must be a hash") unless positive_examples_filename.nil? || positive_examples_filename.is_a?(Hash)
-
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "create_classifier")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "create_classifier")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -291,8 +289,7 @@ module IBMWatson
         unless value.instance_of?(StringIO) || value.instance_of?(File)
           value = value.respond_to?(:to_json) ? StringIO.new(value.to_json) : StringIO.new(value)
         end
-        filename = positive_examples_filename[key] if !positive_examples_filename.nil? && positive_examples_filename.key?(key)
-        filename = value.path if filename.nil? && value.respond_to?(:path)
+        filename = value.path if value.respond_to?(:path)
         form_data[part_name.to_sym] = HTTP::FormData::File.new(value, content_type: "application/octet-stream", filename: filename)
       end
 
@@ -318,31 +315,32 @@ module IBMWatson
     end
 
     ##
-    # @!method list_classifiers(verbose: nil)
-    # Retrieve a list of classifiers.
-    # @param verbose [Boolean] Specify `true` to return details about the classifiers. Omit this parameter to
-    #   return a brief list of classifiers.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def list_classifiers(verbose: nil)
+    # @!method delete_classifier(classifier_id:)
+    # Delete a classifier.
+    # @param classifier_id [String] The ID of the classifier.
+    # @return [nil]
+    def delete_classifier(classifier_id:)
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
+
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "list_classifiers")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "delete_classifier")
+      headers.merge!(sdk_headers)
 
       params = {
-        "version" => @version,
-        "verbose" => verbose
+        "version" => @version
       }
 
-      method_url = "/v3/classifiers"
+      method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
-      response = request(
-        method: "GET",
+      request(
+        method: "DELETE",
         url: method_url,
         headers: headers,
         params: params,
         accept_json: true
       )
-      response
+      nil
     end
 
     ##
@@ -356,7 +354,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "get_classifier")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "get_classifier")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -375,11 +374,40 @@ module IBMWatson
     end
 
     ##
-    # @!method update_classifier(classifier_id:, positive_examples: nil, negative_examples: nil, positive_examples_filename: nil, negative_examples_filename: nil)
+    # @!method list_classifiers(verbose: nil)
+    # Retrieve a list of classifiers.
+    # @param verbose [Boolean] Specify `true` to return details about the classifiers. Omit this parameter to
+    #   return a brief list of classifiers.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_classifiers(verbose: nil)
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "list_classifiers")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "verbose" => verbose
+      }
+
+      method_url = "/v3/classifiers"
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method update_classifier(classifier_id:, positive_examples: nil, negative_examples: nil, negative_examples_filename: nil)
     # Update a classifier.
-    # Update a custom classifier by adding new positive or negative classes (examples)
-    #   or by adding new images to existing classes. You must supply at least one set of
-    #   positive or negative examples. For details, see [Updating custom
+    # Update a custom classifier by adding new positive or negative classes or by adding
+    #   new images to existing classes. You must supply at least one set of positive or
+    #   negative examples. For details, see [Updating custom
     #   classifiers](https://cloud.ibm.com/docs/services/visual-recognition/customizing.html#updating-custom-classifiers).
     #
     #   Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image
@@ -391,7 +419,7 @@ module IBMWatson
     #   previous requests. The retrained property shows the last time the classifier
     #   retraining finished.
     # @param classifier_id [String] The ID of the classifier.
-    # @param positive_examples [Hash] A .zip file of images that depict the visual subject of a class in the classifier.
+    # @param positive_examples [File] A .zip file of images that depict the visual subject of a class in the classifier.
     #   The positive examples create or update classes in the classifier. You can include
     #   more than one positive example file in a call.
     #
@@ -408,19 +436,17 @@ module IBMWatson
     #   of the new classifier. Must contain a minimum of 10 images.
     #
     #   Encode special characters in the file name in UTF-8.
-    # @param positive_examples_filename [Hash] The filename for positive_examples.
     # @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, positive_examples_filename: nil, negative_examples_filename: nil)
+    def update_classifier(classifier_id:, positive_examples: nil, negative_examples: nil, negative_examples_filename: 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)
 
-      raise ArgumentError.new("positive_examples_filename must be a hash") unless positive_examples_filename.nil? || positive_examples_filename.is_a?(Hash)
-
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "update_classifier")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "update_classifier")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -433,8 +459,7 @@ module IBMWatson
         unless value.instance_of?(StringIO) || value.instance_of?(File)
           value = value.respond_to?(:to_json) ? StringIO.new(value.to_json) : StringIO.new(value)
         end
-        filename = positive_examples_filename[key] if !positive_examples_filename.nil? && positive_examples_filename.key?(key)
-        filename = value.path if filename.nil? && value.respond_to?(:path)
+        filename = value.path if value.respond_to?(:path)
         form_data[part_name.to_sym] = HTTP::FormData::File.new(value, content_type: "application/octet-stream", filename: filename)
       end
 
@@ -458,34 +483,6 @@ module IBMWatson
       )
       response
     end
-
-    ##
-    # @!method delete_classifier(classifier_id:)
-    # Delete a classifier.
-    # @param classifier_id [String] The ID of the classifier.
-    # @return [nil]
-    def delete_classifier(classifier_id:)
-      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
-
-      headers = {
-      }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "delete_classifier")
-
-      params = {
-        "version" => @version
-      }
-
-      method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
-
-      request(
-        method: "DELETE",
-        url: method_url,
-        headers: headers,
-        params: params,
-        accept_json: true
-      )
-      nil
-    end
     #########################
     # Core ML
     #########################
@@ -502,7 +499,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "get_core_ml_model")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "get_core_ml_model")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -540,7 +538,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "watson_vision_combined", service_version: "V3", operation_id: "delete_user_data")
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "delete_user_data")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version,

data/lib/ibm_watson/websocket/speech_to_text_websocket_listener.rb

@@ -53,7 +53,7 @@ class WebSocketClient
         end
       elsif json_object.key?("results") || json_object.key?("speaker_labels")
         hypothesis = ""
-        unless json_object["results"].nil?
+        unless json_object["results"].nil? && json_object["speaker_labels"].nil?
           hypothesis = json_object.dig("results", 0, "alternatives", 0, "transcript")
           b_final = json_object.dig("results", 0, "final")
           transcripts = extract_transcripts(alternatives: json_object.dig("results", 0, "alternatives"))