ibm_watson 0.9.2 → 0.10.0

data/lib/ibm_watson/language_translator_v3.rb

@@ -96,31 +96,30 @@ module IBMWatson
     # Translates the input text from the source language to the target language.
     # @param text [Array[String]] Input text in UTF-8 encoding. Multiple entries will result in multiple
     #   translations in the response.
-    # @param model_id [String] Model ID of the translation model to use. If this is specified, the **source** and
-    #   **target** parameters will be ignored. The method requires either a model ID or
-    #   both the **source** and **target** parameters.
-    # @param source [String] Language code of the source text language. Use with `target` as an alternative way
-    #   to select a translation model. When `source` and `target` are set, and a model ID
-    #   is not set, the system chooses a default model for the language pair (usually the
-    #   model based on the news domain).
-    # @param target [String] Language code of the translation target language. Use with source as an
-    #   alternative way to select a translation model.
+    # @param model_id [String] A globally unique string that identifies the underlying model that is used for
+    #   translation.
+    # @param source [String] Translation source language code.
+    # @param target [String] Translation target language code.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def translate(text:, model_id: nil, source: nil, target: nil)
-      raise ArgumentError("text must be provided") if text.nil?
+      raise ArgumentError.new("text must be provided") if text.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       data = {
         "text" => text,
         "model_id" => model_id,
         "source" => source,
         "target" => target
       }
+
       method_url = "/v3/translate"
+
       response = request(
         method: "POST",
         url: method_url,
@@ -144,10 +143,13 @@ module IBMWatson
     def list_identifiable_languages
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v3/identifiable_languages"
+
       response = request(
         method: "GET",
         url: method_url,
@@ -165,16 +167,20 @@ module IBMWatson
     # @param text [String] Input text in UTF-8 format.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def identify(text:)
-      raise ArgumentError("text must be provided") if text.nil?
+      raise ArgumentError.new("text must be provided") if text.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       data = text
       headers["Content-Type"] = "text/plain"
+
       method_url = "/v3/identify"
+
       response = request(
         method: "POST",
         url: method_url,
@@ -203,13 +209,16 @@ module IBMWatson
     def list_models(source: nil, target: nil, default_models: nil)
       headers = {
       }
+
       params = {
         "version" => @version,
         "source" => source,
         "target" => target,
         "default" => default_models
       }
+
       method_url = "/v3/models"
+
       response = request(
         method: "GET",
         url: method_url,
@@ -257,47 +266,43 @@ module IBMWatson
     # @param parallel_corpus_filename [String] The filename for parallel_corpus.
     # @return [DetailedResponse] A `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)
-      raise ArgumentError("base_model_id must be provided") if base_model_id.nil?
+      raise ArgumentError.new("base_model_id must be provided") if base_model_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version,
         "base_model_id" => base_model_id,
         "name" => name
       }
+
+      form_data = {}
+
       unless forced_glossary.nil?
-        mime_type = "application/octet-stream"
         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
-        if forced_glossary_filename
-          forced_glossary = forced_glossary.instance_of?(StringIO) ? HTTP::FormData::File.new(forced_glossary, content_type: mime_type, filename: forced_glossary_filename) : HTTP::FormData::File.new(forced_glossary.path, content_type: mime_type, filename: forced_glossary_filename)
-        else
-          forced_glossary = forced_glossary.instance_of?(StringIO) ? HTTP::FormData::File.new(forced_glossary, content_type: mime_type) : HTTP::FormData::File.new(forced_glossary.path, content_type: mime_type)
-        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)
       end
+
       unless parallel_corpus.nil?
-        mime_type = "application/octet-stream"
         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
-        if parallel_corpus_filename
-          parallel_corpus = parallel_corpus.instance_of?(StringIO) ? HTTP::FormData::File.new(parallel_corpus, content_type: mime_type, filename: parallel_corpus_filename) : HTTP::FormData::File.new(parallel_corpus.path, content_type: mime_type, filename: parallel_corpus_filename)
-        else
-          parallel_corpus = parallel_corpus.instance_of?(StringIO) ? HTTP::FormData::File.new(parallel_corpus, content_type: mime_type) : HTTP::FormData::File.new(parallel_corpus.path, content_type: mime_type)
-        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)
       end
+
       method_url = "/v3/models"
+
       response = request(
         method: "POST",
         url: method_url,
         headers: headers,
         params: params,
-        form: {
-          forced_glossary: forced_glossary,
-          parallel_corpus: parallel_corpus
-        },
+        form: form_data,
         accept_json: true
       )
       response
@@ -310,14 +315,17 @@ module IBMWatson
     # @param model_id [String] Model ID of the model to delete.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def delete_model(model_id:)
-      raise ArgumentError("model_id must be provided") if model_id.nil?
+      raise ArgumentError.new("model_id must be provided") if model_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v3/models/%s" % [ERB::Util.url_encode(model_id)]
+
       response = request(
         method: "DELETE",
         url: method_url,
@@ -337,14 +345,17 @@ module IBMWatson
     # @param model_id [String] Model ID of the model to get.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_model(model_id:)
-      raise ArgumentError("model_id must be provided") if model_id.nil?
+      raise ArgumentError.new("model_id must be provided") if model_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v3/models/%s" % [ERB::Util.url_encode(model_id)]
+
       response = request(
         method: "GET",
         url: method_url,

data/lib/ibm_watson/natural_language_classifier_v1.rb

@@ -86,16 +86,19 @@ module IBMWatson
     # @param text [String] The submitted phrase. The maximum length is 2048 characters.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def classify(classifier_id:, text:)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
-      raise ArgumentError("text must be provided") if text.nil?
+      raise ArgumentError.new("text must be provided") if text.nil?
 
       headers = {
       }
+
       data = {
         "text" => text
       }
+
       method_url = "/v1/classifiers/%s/classify" % [ERB::Util.url_encode(classifier_id)]
+
       response = request(
         method: "POST",
         url: method_url,
@@ -117,16 +120,19 @@ module IBMWatson
     # @param collection [Array[ClassifyInput]] The submitted phrases.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def classify_collection(classifier_id:, collection:)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
-      raise ArgumentError("collection must be provided") if collection.nil?
+      raise ArgumentError.new("collection must be provided") if collection.nil?
 
       headers = {
       }
+
       data = {
         "collection" => collection
       }
+
       method_url = "/v1/classifiers/%s/classify_collection" % [ERB::Util.url_encode(classifier_id)]
+
       response = request(
         method: "POST",
         url: method_url,
@@ -153,45 +159,40 @@ module IBMWatson
     #   (`de`), Italian (`it`), Japanese (`ja`), Korean (`ko`), Brazilian Portuguese
     #   (`pt`), and Spanish (`es`).
     # @param training_data [File] Training data in CSV format. Each text value must have at least one class. The
-    #   data can include up to 20,000 records. For details, see [Data
+    #   data can include up to 3,000 classes and 20,000 records. For details, see [Data
     #   preparation](https://console.bluemix.net/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 [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_classifier(metadata:, training_data:, metadata_filename: nil, training_data_filename: nil)
-      raise ArgumentError("metadata must be provided") if metadata.nil?
+      raise ArgumentError.new("metadata must be provided") if metadata.nil?
 
-      raise ArgumentError("training_data must be provided") if training_data.nil?
+      raise ArgumentError.new("training_data must be provided") if training_data.nil?
 
       headers = {
       }
-      mime_type = "application/json"
+
+      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
-      if metadata_filename
-        metadata = metadata.instance_of?(StringIO) ? HTTP::FormData::File.new(metadata, content_type: mime_type, filename: metadata_filename) : HTTP::FormData::File.new(metadata.path, content_type: mime_type, filename: metadata_filename)
-      else
-        metadata = metadata.instance_of?(StringIO) ? HTTP::FormData::File.new(metadata, content_type: mime_type) : HTTP::FormData::File.new(metadata.path, content_type: mime_type)
-      end
-      mime_type = "text/csv"
+      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)
+
       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
-      if training_data_filename
-        training_data = training_data.instance_of?(StringIO) ? HTTP::FormData::File.new(training_data, content_type: mime_type, filename: training_data_filename) : HTTP::FormData::File.new(training_data.path, content_type: mime_type, filename: training_data_filename)
-      else
-        training_data = training_data.instance_of?(StringIO) ? HTTP::FormData::File.new(training_data, content_type: mime_type) : HTTP::FormData::File.new(training_data.path, content_type: mime_type)
-      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)
+
       method_url = "/v1/classifiers"
+
       response = request(
         method: "POST",
         url: method_url,
         headers: headers,
-        form: {
-          training_metadata: metadata,
-          training_data: training_data
-        },
+        form: form_data,
         accept_json: true
       )
       response
@@ -205,7 +206,9 @@ module IBMWatson
     def list_classifiers
       headers = {
       }
+
       method_url = "/v1/classifiers"
+
       response = request(
         method: "GET",
         url: method_url,
@@ -222,11 +225,13 @@ module IBMWatson
     # @param classifier_id [String] Classifier ID to query.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_classifier(classifier_id:)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
       }
+
       method_url = "/v1/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
+
       response = request(
         method: "GET",
         url: method_url,
@@ -242,11 +247,13 @@ module IBMWatson
     # @param classifier_id [String] Classifier ID to delete.
     # @return [nil]
     def delete_classifier(classifier_id:)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
       }
+
       method_url = "/v1/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
+
       request(
         method: "DELETE",
         url: method_url,

data/lib/ibm_watson/natural_language_understanding_v1.rb

@@ -20,7 +20,7 @@
 # can ignore most advertisements and other unwanted content.
 #
 # You can create [custom
-# models](/docs/services/natural-language-understanding/customizing.html) with Watson
+# models](https://console.bluemix.net/docs/services/natural-language-understanding/customizing.html) with Watson
 # Knowledge Studio to detect custom entities and relations in Natural Language
 # Understanding.
 
@@ -96,22 +96,33 @@ module IBMWatson
 
     ##
     # @!method analyze(features:, text: nil, html: nil, url: nil, clean: nil, xpath: nil, fallback_to_raw: nil, return_analyzed_text: nil, language: nil, limit_text_characters: nil)
-    # Analyze text, HTML, or a public webpage.
-    # Analyzes text, HTML, or a public webpage with one or more text analysis features,
-    #   including categories, concepts, emotion, entities, keywords, metadata, relations,
-    #   semantic roles, and sentiment.
-    # @param features [Features] Specific features to analyze the document for.
+    # Analyze text.
+    # Analyzes text, HTML, or a public webpage for the following features:
+    #   - Categories
+    #   - Concepts
+    #   - Emotion
+    #   - Entities
+    #   - Keywords
+    #   - Metadata
+    #   - Relations
+    #   - Semantic roles
+    #   - Sentiment.
+    # @param features [Features] Analysis features and options.
     # @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
     #   required.
-    # @param url [String] The web page to analyze. One of the `text`, `html`, or `url` parameters is
+    # @param url [String] The webpage to analyze. One of the `text`, `html`, or `url` parameters is
     #   required.
-    # @param clean [Boolean] Remove website elements, such as links, ads, etc.
-    # @param xpath [String] An [XPath query](https://www.w3.org/TR/xpath/) to perform on `html` or `url`
-    #   input. Results of the query will be appended to the cleaned webpage text before it
-    #   is analyzed. To analyze only the results of the XPath query, set the `clean`
-    #   parameter to `false`.
+    # @param clean [Boolean] Set this to `false` to disable webpage cleaning. To learn more about webpage
+    #   cleaning, see the [Analyzing
+    #   webpages](https://console.bluemix.net/docs/services/natural-language-understanding/analyzing-webpages.html)
+    #   documentation.
+    # @param xpath [String] An [XPath
+    #   query](https://console.bluemix.net/docs/services/natural-language-understanding/analyzing-webpages.html#xpath)
+    #   to perform on `html` or `url` input. Results of the query will be appended to the
+    #   cleaned webpage text before it is analyzed. To analyze only the results of the
+    #   XPath query, set the `clean` parameter to `false`.
     # @param fallback_to_raw [Boolean] Whether to use raw HTML content if text cleaning fails.
     # @param return_analyzed_text [Boolean] Whether or not to return the analyzed text.
     # @param language [String] ISO 639-1 code that specifies the language of your text. This overrides automatic
@@ -122,13 +133,15 @@ module IBMWatson
     # @param limit_text_characters [Fixnum] Sets the maximum number of characters that are processed by the service.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def analyze(features:, text: nil, html: nil, url: nil, clean: nil, xpath: nil, fallback_to_raw: nil, return_analyzed_text: nil, language: nil, limit_text_characters: nil)
-      raise ArgumentError("features must be provided") if features.nil?
+      raise ArgumentError.new("features must be provided") if features.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       data = {
         "features" => features,
         "text" => text,
@@ -141,7 +154,9 @@ module IBMWatson
         "language" => language,
         "limit_text_characters" => limit_text_characters
       }
+
       method_url = "/v1/analyze"
+
       response = request(
         method: "POST",
         url: method_url,
@@ -159,17 +174,20 @@ module IBMWatson
     ##
     # @!method list_models
     # List models.
-    # Lists available models for Relations and Entities features, including Watson
-    #   Knowledge Studio custom models that you have created and linked to your Natural
-    #   Language Understanding service.
+    # Lists Watson Knowledge Studio [custom
+    #   models](https://console.bluemix.net/docs/services/natural-language-understanding/customizing.html) that are
+    #   deployed to your Natural Language Understanding service.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_models
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v1/models"
+
       response = request(
         method: "GET",
         url: method_url,
@@ -187,14 +205,17 @@ module IBMWatson
     # @param model_id [String] model_id of the model to delete.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def delete_model(model_id:)
-      raise ArgumentError("model_id must be provided") if model_id.nil?
+      raise ArgumentError.new("model_id must be provided") if model_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v1/models/%s" % [ERB::Util.url_encode(model_id)]
+
       response = request(
         method: "DELETE",
         url: method_url,