ibm_watson 0.14.0 → 0.15.0

data/lib/ibm_watson/language_translator_v3.rb

@@ -23,7 +23,6 @@
 require "concurrent"
 require "erb"
 require "json"
-
 require "ibm_cloud_sdk_core"
 require_relative "./common.rb"
 
@@ -107,7 +106,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "language_translator", service_version: "V3", operation_id: "translate")
+      sdk_headers = Common.new.get_sdk_headers("language_translator", "V3", "translate")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -136,33 +136,6 @@ module IBMWatson
     # Identification
     #########################
 
-    ##
-    # @!method list_identifiable_languages
-    # List identifiable languages.
-    # Lists the languages that the service can identify. Returns the language code (for
-    #   example, `en` for English or `es` for Spanish) and name of each language.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def list_identifiable_languages
-      headers = {
-      }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "language_translator", service_version: "V3", operation_id: "list_identifiable_languages")
-
-      params = {
-        "version" => @version
-      }
-
-      method_url = "/v3/identifiable_languages"
-
-      response = request(
-        method: "GET",
-        url: method_url,
-        headers: headers,
-        params: params,
-        accept_json: true
-      )
-      response
-    end
-
     ##
     # @!method identify(text:)
     # Identify language.
@@ -174,7 +147,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "language_translator", service_version: "V3", operation_id: "identify")
+      sdk_headers = Common.new.get_sdk_headers("language_translator", "V3", "identify")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -195,34 +169,24 @@ module IBMWatson
       )
       response
     end
-    #########################
-    # Models
-    #########################
 
     ##
-    # @!method list_models(source: nil, target: nil, default_models: nil)
-    # List models.
-    # Lists available translation models.
-    # @param source [String] Specify a language code to filter results by source language.
-    # @param target [String] Specify a language code to filter results by target language.
-    # @param default_models [Boolean] If the default parameter isn't specified, the service will return all models
-    #   (default and non-default) for each language pair. To return only default models,
-    #   set this to `true`. To return only non-default models, set this to `false`. There
-    #   is exactly one default model per language pair, the IBM provided base model.
+    # @!method list_identifiable_languages
+    # List identifiable languages.
+    # Lists the languages that the service can identify. Returns the language code (for
+    #   example, `en` for English or `es` for Spanish) and name of each language.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def list_models(source: nil, target: nil, default_models: nil)
+    def list_identifiable_languages
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "language_translator", service_version: "V3", operation_id: "list_models")
+      sdk_headers = Common.new.get_sdk_headers("language_translator", "V3", "list_identifiable_languages")
+      headers.merge!(sdk_headers)
 
       params = {
-        "version" => @version,
-        "source" => source,
-        "target" => target,
-        "default" => default_models
+        "version" => @version
       }
 
-      method_url = "/v3/models"
+      method_url = "/v3/identifiable_languages"
 
       response = request(
         method: "GET",
@@ -233,9 +197,12 @@ module IBMWatson
       )
       response
     end
+    #########################
+    # Models
+    #########################
 
     ##
-    # @!method create_model(base_model_id:, name: nil, forced_glossary: nil, parallel_corpus: nil, forced_glossary_filename: nil, parallel_corpus_filename: nil)
+    # @!method create_model(base_model_id:, forced_glossary: nil, parallel_corpus: nil, name: nil)
     # Create model.
     # Uploads Translation Memory eXchange (TMX) files to customize a translation model.
     #
@@ -256,9 +223,6 @@ module IBMWatson
     #   models, use the `List models` method. Usually all IBM provided models are
     #   customizable. In addition, all your models that have been created via parallel
     #   corpus customization, can be further customized with a forced glossary.
-    # @param name [String] An optional model name that you can use to identify the model. Valid characters
-    #   are letters, numbers, dashes, underscores, spaces and apostrophes. The maximum
-    #   length is 32 characters.
     # @param forced_glossary [File] A TMX file with your customizations. The customizations in the file completely
     #   overwrite the domain translaton data, including high frequency or high confidence
     #   phrase translations. You can upload only one glossary with a file size less than
@@ -267,15 +231,17 @@ module IBMWatson
     #   multiple parallel_corpus files in one request. All uploaded parallel_corpus files
     #   combined, your parallel corpus must contain at least 5,000 parallel sentences to
     #   train successfully.
-    # @param forced_glossary_filename [String] The filename for forced_glossary.
-    # @param parallel_corpus_filename [String] The filename for parallel_corpus.
+    # @param name [String] An optional model name that you can use to identify the model. Valid characters
+    #   are letters, numbers, dashes, underscores, spaces and apostrophes. The maximum
+    #   length is 32 characters.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def create_model(base_model_id:, name: nil, forced_glossary: nil, parallel_corpus: nil, forced_glossary_filename: nil, parallel_corpus_filename: nil)
+    def create_model(base_model_id:, forced_glossary: nil, parallel_corpus: nil, name: nil)
       raise ArgumentError.new("base_model_id must be provided") if base_model_id.nil?
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "language_translator", service_version: "V3", operation_id: "create_model")
+      sdk_headers = Common.new.get_sdk_headers("language_translator", "V3", "create_model")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version,
@@ -289,16 +255,14 @@ module IBMWatson
         unless forced_glossary.instance_of?(StringIO) || forced_glossary.instance_of?(File)
           forced_glossary = forced_glossary.respond_to?(:to_json) ? StringIO.new(forced_glossary.to_json) : StringIO.new(forced_glossary)
         end
-        forced_glossary_filename = forced_glossary.path if forced_glossary_filename.nil? && forced_glossary.respond_to?(:path)
-        form_data[:forced_glossary] = HTTP::FormData::File.new(forced_glossary, content_type: "application/octet-stream", filename: forced_glossary_filename)
+        form_data[:forced_glossary] = HTTP::FormData::File.new(forced_glossary, content_type: "application/octet-stream", filename: forced_glossary.respond_to?(:path) ? forced_glossary.path : nil)
       end
 
       unless parallel_corpus.nil?
         unless parallel_corpus.instance_of?(StringIO) || parallel_corpus.instance_of?(File)
           parallel_corpus = parallel_corpus.respond_to?(:to_json) ? StringIO.new(parallel_corpus.to_json) : StringIO.new(parallel_corpus)
         end
-        parallel_corpus_filename = parallel_corpus.path if parallel_corpus_filename.nil? && parallel_corpus.respond_to?(:path)
-        form_data[:parallel_corpus] = HTTP::FormData::File.new(parallel_corpus, content_type: "application/octet-stream", filename: parallel_corpus_filename)
+        form_data[:parallel_corpus] = HTTP::FormData::File.new(parallel_corpus, content_type: "application/octet-stream", filename: parallel_corpus.respond_to?(:path) ? parallel_corpus.path : nil)
       end
 
       method_url = "/v3/models"
@@ -325,7 +289,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "language_translator", service_version: "V3", operation_id: "delete_model")
+      sdk_headers = Common.new.get_sdk_headers("language_translator", "V3", "delete_model")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -356,7 +321,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "language_translator", service_version: "V3", operation_id: "get_model")
+      sdk_headers = Common.new.get_sdk_headers("language_translator", "V3", "get_model")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -373,5 +339,41 @@ module IBMWatson
       )
       response
     end
+
+    ##
+    # @!method list_models(source: nil, target: nil, default_models: nil)
+    # List models.
+    # Lists available translation models.
+    # @param source [String] Specify a language code to filter results by source language.
+    # @param target [String] Specify a language code to filter results by target language.
+    # @param default_models [Boolean] If the default parameter isn't specified, the service will return all models
+    #   (default and non-default) for each language pair. To return only default models,
+    #   set this to `true`. To return only non-default models, set this to `false`. There
+    #   is exactly one default model per language pair, the IBM provided base model.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_models(source: nil, target: nil, default_models: nil)
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("language_translator", "V3", "list_models")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "source" => source,
+        "target" => target,
+        "default" => default_models
+      }
+
+      method_url = "/v3/models"
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
   end
 end

data/lib/ibm_watson/natural_language_classifier_v1.rb

@@ -22,7 +22,6 @@
 require "concurrent"
 require "erb"
 require "json"
-
 require "ibm_cloud_sdk_core"
 require_relative "./common.rb"
 
@@ -93,7 +92,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural_language_classifier", service_version: "V1", operation_id: "classify")
+      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "classify")
+      headers.merge!(sdk_headers)
 
       data = {
         "text" => text
@@ -128,7 +128,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural_language_classifier", service_version: "V1", operation_id: "classify_collection")
+      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "classify_collection")
+      headers.merge!(sdk_headers)
 
       data = {
         "collection" => collection
@@ -150,7 +151,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method create_classifier(metadata:, training_data:, metadata_filename: nil, training_data_filename: nil)
+    # @!method create_classifier(metadata:, training_data:)
     # Create classifier.
     # Sends data to create and train a classifier and returns information about the new
     #   classifier.
@@ -164,31 +165,28 @@ module IBMWatson
     # @param training_data [File] Training data in CSV format. Each text value must have at least one class. The
     #   data can include up to 3,000 classes and 20,000 records. For details, see [Data
     #   preparation](https://cloud.ibm.com/docs/services/natural-language-classifier/using-your-data.html).
-    # @param metadata_filename [String] The filename for training_metadata.
-    # @param training_data_filename [String] The filename for training_data.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def create_classifier(metadata:, training_data:, metadata_filename: nil, training_data_filename: nil)
+    def create_classifier(metadata:, training_data:)
       raise ArgumentError.new("metadata must be provided") if metadata.nil?
 
       raise ArgumentError.new("training_data must be provided") if training_data.nil?
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural_language_classifier", service_version: "V1", operation_id: "create_classifier")
+      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "create_classifier")
+      headers.merge!(sdk_headers)
 
       form_data = {}
 
       unless metadata.instance_of?(StringIO) || metadata.instance_of?(File)
         metadata = metadata.respond_to?(:to_json) ? StringIO.new(metadata.to_json) : StringIO.new(metadata)
       end
-      metadata_filename = metadata.path if metadata_filename.nil? && metadata.respond_to?(:path)
-      form_data[:training_metadata] = HTTP::FormData::File.new(metadata, content_type: "application/json", filename: metadata_filename)
+      form_data[:training_metadata] = HTTP::FormData::File.new(metadata, content_type: "application/json", filename: metadata.respond_to?(:path) ? metadata.path : nil)
 
       unless training_data.instance_of?(StringIO) || training_data.instance_of?(File)
         training_data = training_data.respond_to?(:to_json) ? StringIO.new(training_data.to_json) : StringIO.new(training_data)
       end
-      training_data_filename = training_data.path if training_data_filename.nil? && training_data.respond_to?(:path)
-      form_data[:training_data] = HTTP::FormData::File.new(training_data, content_type: "text/csv", filename: training_data_filename)
+      form_data[:training_data] = HTTP::FormData::File.new(training_data, content_type: "text/csv", filename: training_data.respond_to?(:path) ? training_data.path : nil)
 
       method_url = "/v1/classifiers"
 
@@ -203,24 +201,27 @@ module IBMWatson
     end
 
     ##
-    # @!method list_classifiers
-    # List classifiers.
-    # Returns an empty array if no classifiers are available.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def list_classifiers
+    # @!method delete_classifier(classifier_id:)
+    # Delete classifier.
+    # @param classifier_id [String] Classifier ID to delete.
+    # @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: "natural_language_classifier", service_version: "V1", operation_id: "list_classifiers")
+      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "delete_classifier")
+      headers.merge!(sdk_headers)
 
-      method_url = "/v1/classifiers"
+      method_url = "/v1/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
-      response = request(
-        method: "GET",
+      request(
+        method: "DELETE",
         url: method_url,
         headers: headers,
         accept_json: true
       )
-      response
+      nil
     end
 
     ##
@@ -234,7 +235,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural_language_classifier", service_version: "V1", operation_id: "get_classifier")
+      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "get_classifier")
+      headers.merge!(sdk_headers)
 
       method_url = "/v1/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
@@ -248,26 +250,25 @@ module IBMWatson
     end
 
     ##
-    # @!method delete_classifier(classifier_id:)
-    # Delete classifier.
-    # @param classifier_id [String] Classifier ID to delete.
-    # @return [nil]
-    def delete_classifier(classifier_id:)
-      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
-
+    # @!method list_classifiers
+    # List classifiers.
+    # Returns an empty array if no classifiers are available.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_classifiers
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural_language_classifier", service_version: "V1", operation_id: "delete_classifier")
+      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "list_classifiers")
+      headers.merge!(sdk_headers)
 
-      method_url = "/v1/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
+      method_url = "/v1/classifiers"
 
-      request(
-        method: "DELETE",
+      response = request(
+        method: "GET",
         url: method_url,
         headers: headers,
         accept_json: true
       )
-      nil
+      response
     end
   end
 end

data/lib/ibm_watson/natural_language_understanding_v1.rb

@@ -21,13 +21,12 @@
 #
 # You can create [custom
 # models](https://cloud.ibm.com/docs/services/natural-language-understanding/customizing.html)
-# with Watson Knowledge Studio to detect custom entities and relations in Natural Language
-# Understanding.
+# with Watson Knowledge Studio to detect custom entities, relations, and categories in
+# Natural Language Understanding.
 
 require "concurrent"
 require "erb"
 require "json"
-
 require "ibm_cloud_sdk_core"
 require_relative "./common.rb"
 
@@ -107,8 +106,9 @@ module IBMWatson
     #   - Metadata
     #   - Relations
     #   - Semantic roles
-    #   - Sentiment.
-    # @param features [Features] Analysis features and options.
+    #   - Sentiment
+    #   - Syntax (Experimental).
+    # @param features [Features] Specific features to analyze the document for.
     # @param text [String] The plain text to analyze. One of the `text`, `html`, or `url` parameters is
     #   required.
     # @param html [String] The HTML file to analyze. One of the `text`, `html`, or `url` parameters is
@@ -138,7 +138,8 @@ module IBMWatson
 
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural-language-understanding", service_version: "V1", operation_id: "analyze")
+      sdk_headers = Common.new.get_sdk_headers("natural-language-understanding", "V1", "analyze")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
@@ -174,25 +175,27 @@ module IBMWatson
     #########################
 
     ##
-    # @!method list_models
-    # List models.
-    # Lists Watson Knowledge Studio [custom
-    #   models](https://cloud.ibm.com/docs/services/natural-language-understanding/customizing.html)
-    #   that are deployed to your Natural Language Understanding service.
+    # @!method delete_model(model_id:)
+    # Delete model.
+    # Deletes a custom model.
+    # @param model_id [String] Model ID of the model to delete.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def list_models
+    def delete_model(model_id:)
+      raise ArgumentError.new("model_id must be provided") if model_id.nil?
+
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural-language-understanding", service_version: "V1", operation_id: "list_models")
+      sdk_headers = Common.new.get_sdk_headers("natural-language-understanding", "V1", "delete_model")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
       }
 
-      method_url = "/v1/models"
+      method_url = "/v1/models/%s" % [ERB::Util.url_encode(model_id)]
 
       response = request(
-        method: "GET",
+        method: "DELETE",
         url: method_url,
         headers: headers,
         params: params,
@@ -202,26 +205,26 @@ module IBMWatson
     end
 
     ##
-    # @!method delete_model(model_id:)
-    # Delete model.
-    # Deletes a custom model.
-    # @param model_id [String] Model ID of the model to delete.
+    # @!method list_models
+    # List models.
+    # Lists Watson Knowledge Studio [custom
+    #   models](https://cloud.ibm.com/docs/services/natural-language-understanding/customizing.html)
+    #   that are deployed to your Natural Language Understanding service.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def delete_model(model_id:)
-      raise ArgumentError.new("model_id must be provided") if model_id.nil?
-
+    def list_models
       headers = {
       }
-      headers = Common.new.get_sdk_headers(headers: headers, service_name: "natural-language-understanding", service_version: "V1", operation_id: "delete_model")
+      sdk_headers = Common.new.get_sdk_headers("natural-language-understanding", "V1", "list_models")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
       }
 
-      method_url = "/v1/models/%s" % [ERB::Util.url_encode(model_id)]
+      method_url = "/v1/models"
 
       response = request(
-        method: "DELETE",
+        method: "GET",
         url: method_url,
         headers: headers,
         params: params,

data/lib/ibm_watson/personality_insights_v3.rb

@@ -38,7 +38,6 @@
 require "concurrent"
 require "erb"
 require "json"
-
 require "ibm_cloud_sdk_core"
 require_relative "./common.rb"
 
@@ -107,7 +106,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method profile(content:, accept:, content_type: nil, content_language: nil, accept_language: nil, raw_scores: nil, csv_headers: nil, consumption_preferences: nil)
+    # @!method profile(content:, accept:, content_language: nil, accept_language: nil, raw_scores: nil, csv_headers: nil, consumption_preferences: nil, content_type: nil)
     # Get profile.
     # Generates a personality profile for the author of the input text. The service
     #   accepts a maximum of 20 MB of input content, but it requires much less text to
@@ -158,10 +157,6 @@ module IBMWatson
     #   For JSON input, provide an object of type `Content`.
     # @param accept [String] The type of the response. For more information, see **Accept types** in the method
     #   description.
-    # @param content_type [String] The type of the input. For more information, see **Content types** in the method
-    #   description.
-    #
-    #   Default: `text/plain`.
     # @param content_language [String] The language of the input text for the request: Arabic, English, Japanese, Korean,
     #   or Spanish. Regional variants are treated as their parent language; for example,
     #   `en-US` is interpreted as `en`.
@@ -186,19 +181,24 @@ module IBMWatson
     #   (`text/csv`).
     # @param consumption_preferences [Boolean] Indicates whether consumption preferences are returned with the results. By
     #   default, no consumption preferences are returned.
+    # @param content_type [String] The type of the input. For more information, see **Content types** in the method
+    #   description.
+    #
+    #   Default: `text/plain`.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def profile(content:, accept:, content_type: nil, content_language: nil, accept_language: nil, raw_scores: nil, csv_headers: nil, consumption_preferences: nil)
+    def profile(content:, accept:, content_language: nil, accept_language: nil, raw_scores: nil, csv_headers: nil, consumption_preferences: nil, content_type: nil)
       raise ArgumentError.new("content must be provided") if content.nil?
 
       raise ArgumentError.new("accept must be provided") if accept.nil?
 
       headers = {
         "Accept" => accept,
-        "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: "personality_insights", service_version: "V3", operation_id: "profile")
+      sdk_headers = Common.new.get_sdk_headers("personality_insights", "V3", "profile")
+      headers.merge!(sdk_headers)
 
       params = {
         "version" => @version,