ibm_watson 0.20.1 → 1.0.0.rc1

data/lib/ibm_watson/text_to_speech_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018 IBM All Rights Reserved.
+# (C) Copyright IBM Corp. 2019.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -85,18 +85,9 @@ module IBMWatson
       @__async_initialized__ = false
       defaults = {}
       defaults[:url] = "https://stream.watsonplatform.net/text-to-speech/api"
-      defaults[:username] = nil
-      defaults[:password] = nil
-      defaults[:iam_apikey] = nil
-      defaults[:iam_access_token] = nil
-      defaults[:iam_url] = nil
-      defaults[:iam_client_id] = nil
-      defaults[:iam_client_secret] = nil
-      defaults[:icp4d_access_token] = nil
-      defaults[:icp4d_url] = nil
+      defaults[:authenticator] = nil
       defaults[:authentication_type] = nil
       args = defaults.merge(args)
-      args[:vcap_services_name] = "text_to_speech"
       args[:display_name] = "Text to Speech"
       super
     end
@@ -123,6 +114,7 @@ module IBMWatson
 
       method_url = "/v1/voices"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -163,6 +155,7 @@ module IBMWatson
 
       method_url = "/v1/voices/%s" % [ERB::Util.url_encode(voice)]
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -177,7 +170,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method synthesize(text:, voice: nil, customization_id: nil, accept: nil)
+    # @!method synthesize(text:, accept: nil, voice: nil, customization_id: nil)
     # Synthesize audio.
     # Synthesizes text to audio that is spoken in the specified voice. The service bases
     #   its understanding of the language for the input text on the specified voice. Use a
@@ -265,22 +258,22 @@ module IBMWatson
     #    If a request includes invalid query parameters, the service returns a `Warnings`
     #   response header that provides messages about the invalid parameters. The warning
     #   includes a descriptive message and a list of invalid argument strings. For
-    #   example, a message such as `\"Unknown arguments:\"` or `\"Unknown url query
-    #   arguments:\"` followed by a list of the form `\"{invalid_arg_1},
-    #   {invalid_arg_2}.\"` The request succeeds despite the warnings.
+    #   example, a message such as `"Unknown arguments:"` or `"Unknown url query
+    #   arguments:"` followed by a list of the form `"{invalid_arg_1}, {invalid_arg_2}."`
+    #   The request succeeds despite the warnings.
     # @param text [String] The text to synthesize.
+    # @param accept [String] The requested format (MIME type) of the audio. You can use the `Accept` header or
+    #   the `accept` parameter to specify the audio format. For more information about
+    #   specifying an audio format, see **Audio formats (accept types)** in the method
+    #   description.
     # @param voice [String] The voice to use for synthesis.
     # @param customization_id [String] The customization ID (GUID) of a custom voice model to use for the synthesis. If a
     #   custom voice model is specified, it is guaranteed to work only if it matches the
     #   language of the indicated voice. You must make the request with credentials for
     #   the instance of the service that owns the custom model. Omit the parameter to use
     #   the specified voice with no customization.
-    # @param accept [String] The requested format (MIME type) of the audio. You can use the `Accept` header or
-    #   the `accept` parameter to specify the audio format. For more information about
-    #   specifying an audio format, see **Audio formats (accept types)** in the method
-    #   description.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def synthesize(text:, voice: nil, customization_id: nil, accept: nil)
+    def synthesize(text:, accept: nil, voice: nil, customization_id: nil)
       raise ArgumentError.new("text must be provided") if text.nil?
 
       headers = {
@@ -300,6 +293,7 @@ module IBMWatson
 
       method_url = "/v1/synthesize"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -357,6 +351,7 @@ module IBMWatson
 
       method_url = "/v1/pronunciation"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -404,6 +399,7 @@ module IBMWatson
 
       method_url = "/v1/customizations"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -444,6 +440,7 @@ module IBMWatson
 
       method_url = "/v1/customizations"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -470,13 +467,13 @@ module IBMWatson
     #   a word. You can specify them in standard International Phonetic Alphabet (IPA)
     #   representation
     #
-    #     <code>&lt;phoneme alphabet=\"ipa\"
-    #   ph=\"t&#601;m&#712;&#593;to\"&gt;&lt;/phoneme&gt;</code>
+    #     <code>&lt;phoneme alphabet="ipa"
+    #   ph="t&#601;m&#712;&#593;to"&gt;&lt;/phoneme&gt;</code>
     #
     #     or in the proprietary IBM Symbolic Phonetic Representation (SPR)
     #
-    #     <code>&lt;phoneme alphabet=\"ibm\"
-    #   ph=\"1gAstroEntxrYFXs\"&gt;&lt;/phoneme&gt;</code>
+    #     <code>&lt;phoneme alphabet="ibm"
+    #   ph="1gAstroEntxrYFXs"&gt;&lt;/phoneme&gt;</code>
     #
     #   **Note:** This method is currently a beta release.
     #
@@ -511,6 +508,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s" % [ERB::Util.url_encode(customization_id)]
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "POST",
         url: method_url,
@@ -546,6 +544,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s" % [ERB::Util.url_encode(customization_id)]
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -578,6 +577,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s" % [ERB::Util.url_encode(customization_id)]
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "DELETE",
         url: method_url,
@@ -605,13 +605,13 @@ module IBMWatson
     #   a word. You can specify them in standard International Phonetic Alphabet (IPA)
     #   representation
     #
-    #     <code>&lt;phoneme alphabet=\"ipa\"
-    #   ph=\"t&#601;m&#712;&#593;to\"&gt;&lt;/phoneme&gt;</code>
+    #     <code>&lt;phoneme alphabet="ipa"
+    #   ph="t&#601;m&#712;&#593;to"&gt;&lt;/phoneme&gt;</code>
     #
     #     or in the proprietary IBM Symbolic Phonetic Representation (SPR)
     #
-    #     <code>&lt;phoneme alphabet=\"ibm\"
-    #   ph=\"1gAstroEntxrYFXs\"&gt;&lt;/phoneme&gt;</code>
+    #     <code>&lt;phoneme alphabet="ibm"
+    #   ph="1gAstroEntxrYFXs"&gt;&lt;/phoneme&gt;</code>
     #
     #   **Note:** This method is currently a beta release.
     #
@@ -649,6 +649,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s/words" % [ERB::Util.url_encode(customization_id)]
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "POST",
         url: method_url,
@@ -684,6 +685,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s/words" % [ERB::Util.url_encode(customization_id)]
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -708,13 +710,13 @@ module IBMWatson
     #   a word. You can specify them in standard International Phonetic Alphabet (IPA)
     #   representation
     #
-    #     <code>&lt;phoneme alphabet=\"ipa\"
-    #   ph=\"t&#601;m&#712;&#593;to\"&gt;&lt;/phoneme&gt;</code>
+    #     <code>&lt;phoneme alphabet="ipa"
+    #   ph="t&#601;m&#712;&#593;to"&gt;&lt;/phoneme&gt;</code>
     #
     #     or in the proprietary IBM Symbolic Phonetic Representation (SPR)
     #
-    #     <code>&lt;phoneme alphabet=\"ibm\"
-    #   ph=\"1gAstroEntxrYFXs\"&gt;&lt;/phoneme&gt;</code>
+    #     <code>&lt;phoneme alphabet="ibm"
+    #   ph="1gAstroEntxrYFXs"&gt;&lt;/phoneme&gt;</code>
     #
     #   **Note:** This method is currently a beta release.
     #
@@ -758,6 +760,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s/words/%s" % [ERB::Util.url_encode(customization_id), ERB::Util.url_encode(word)]
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "PUT",
         url: method_url,
@@ -795,6 +798,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s/words/%s" % [ERB::Util.url_encode(customization_id), ERB::Util.url_encode(word)]
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -831,6 +835,7 @@ module IBMWatson
 
       method_url = "/v1/customizations/%s/words/%s" % [ERB::Util.url_encode(customization_id), ERB::Util.url_encode(word)]
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "DELETE",
         url: method_url,
@@ -873,6 +878,7 @@ module IBMWatson
 
       method_url = "/v1/user_data"
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "DELETE",
         url: method_url,

data/lib/ibm_watson/tone_analyzer_v3.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018 IBM All Rights Reserved.
+# (C) Copyright IBM Corp. 2019.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -77,12 +77,6 @@ module IBMWatson
     #   'https://iam.cloud.ibm.com/identity/token'.
     # @option args iam_client_id [String] An optional client id for the IAM service API.
     # @option args iam_client_secret [String] An optional client secret for the IAM service API.
-    # @option args icp4d_access_token [STRING]  A ICP4D(IBM Cloud Pak for Data) access token is
-    #   fully managed by the application. Responsibility falls on the application to
-    #   refresh the token, either before it expires or reactively upon receiving a 401
-    #   from the service as any requests made with an expired token will fail.
-    # @option args icp4d_url [STRING] In order to use an SDK-managed token with ICP4D authentication, this
-    #   URL must be passed in.
     # @option args authentication_type [STRING] Specifies the authentication pattern to use. Values that it
     #   takes are basic, iam or icp4d.
     def initialize(args = {})
@@ -90,21 +84,14 @@ module IBMWatson
       defaults = {}
       defaults[:version] = nil
       defaults[:url] = "https://gateway.watsonplatform.net/tone-analyzer/api"
-      defaults[:username] = nil
-      defaults[:password] = nil
-      defaults[:iam_apikey] = nil
-      defaults[:iam_access_token] = nil
-      defaults[:iam_url] = nil
-      defaults[:iam_client_id] = nil
-      defaults[:iam_client_secret] = nil
-      defaults[:icp4d_access_token] = nil
-      defaults[:icp4d_url] = nil
+      defaults[:authenticator] = nil
       defaults[:authentication_type] = nil
       args = defaults.merge(args)
-      args[:vcap_services_name] = "tone_analyzer"
+      @version = args[:version]
+      raise ArgumentError.new("version must be provided") if @version.nil?
+
       args[:display_name] = "Tone Analyzer"
       super
-      @version = args[:version]
     end
 
     #########################
@@ -112,7 +99,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method tone(tone_input:, sentences: nil, tones: nil, content_language: nil, accept_language: nil, content_type: nil)
+    # @!method tone(tone_input:, content_type: nil, sentences: nil, tones: nil, content_language: nil, accept_language: 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
@@ -136,6 +123,8 @@ module IBMWatson
     #   endpoint](https://cloud.ibm.com/docs/services/tone-analyzer?topic=tone-analyzer-utgpe#utgpe).
     # @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.
@@ -157,16 +146,14 @@ 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:, sentences: nil, tones: nil, content_language: nil, accept_language: nil, content_type: nil)
+    def tone(tone_input:, content_type: nil, sentences: nil, tones: nil, content_language: nil, accept_language: 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,
-        "Content-Type" => content_type
+        "Accept-Language" => accept_language
       }
       sdk_headers = Common.new.get_sdk_headers("tone_analyzer", "V3", "tone")
       headers.merge!(sdk_headers)
@@ -185,6 +172,7 @@ module IBMWatson
 
       method_url = "/v3/tone"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -247,6 +235,7 @@ module IBMWatson
 
       method_url = "/v3/tone_chat"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,

data/lib/ibm_watson/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IBMWatson
-  VERSION = "0.20.1"
+  VERSION = "1.0.0.rc1"
 end

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018 IBM All Rights Reserved.
+# (C) Copyright IBM Corp. 2019.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -59,12 +59,6 @@ module IBMWatson
     #   'https://iam.cloud.ibm.com/identity/token'.
     # @option args iam_client_id [String] An optional client id for the IAM service API.
     # @option args iam_client_secret [String] An optional client secret for the IAM service API.
-    # @option args icp4d_access_token [STRING]  A ICP4D(IBM Cloud Pak for Data) access token is
-    #   fully managed by the application. Responsibility falls on the application to
-    #   refresh the token, either before it expires or reactively upon receiving a 401
-    #   from the service as any requests made with an expired token will fail.
-    # @option args icp4d_url [STRING] In order to use an SDK-managed token with ICP4D authentication, this
-    #   URL must be passed in.
     # @option args authentication_type [STRING] Specifies the authentication pattern to use. Values that it
     #   takes are basic, iam or icp4d.
     def initialize(args = {})
@@ -72,19 +66,14 @@ module IBMWatson
       defaults = {}
       defaults[:version] = nil
       defaults[:url] = "https://gateway.watsonplatform.net/visual-recognition/api"
-      defaults[:iam_apikey] = nil
-      defaults[:iam_access_token] = nil
-      defaults[:iam_url] = nil
-      defaults[:iam_client_id] = nil
-      defaults[:iam_client_secret] = nil
-      defaults[:icp4d_access_token] = nil
-      defaults[:icp4d_url] = nil
+      defaults[:authenticator] = nil
       defaults[:authentication_type] = nil
       args = defaults.merge(args)
-      args[:vcap_services_name] = "watson_vision_combined"
+      @version = args[:version]
+      raise ArgumentError.new("version must be provided") if @version.nil?
+
       args[:display_name] = "Visual Recognition"
       super
-      @version = args[:version]
     end
 
     #########################
@@ -163,6 +152,7 @@ module IBMWatson
 
       method_url = "/v3/classify"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -236,6 +226,7 @@ module IBMWatson
 
       method_url = "/v3/detect_faces"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -254,11 +245,18 @@ module IBMWatson
     # @!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
-    #   examples, either two positive example files or one positive and one negative file.
-    #   You can upload a maximum of 256 MB per call.
+    #   custom classifier with positive or negative example training images. Include at
+    #   least two sets of examples, either two positive example files or one positive and
+    #   one negative file. You can upload a maximum of 256 MB per call.
     #
-    #   Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image
+    #   **Tips when creating:**
+    #
+    #   - If you set the **X-Watson-Learning-Opt-Out** header parameter to `true` when you
+    #   create a classifier, the example training images are not stored. Save your
+    #   training images locally. For more information, see [Data
+    #   collection](#data-collection).
+    #
+    #   - Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image
     #   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.
@@ -318,6 +316,7 @@ module IBMWatson
 
       method_url = "/v3/classifiers"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -348,6 +347,7 @@ module IBMWatson
 
       method_url = "/v3/classifiers"
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -378,6 +378,7 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -400,10 +401,17 @@ module IBMWatson
     #   file names, and classifier and class names). The service assumes UTF-8 encoding if
     #   it encounters non-ASCII characters.
     #
-    #   **Tip:** Don't make retraining calls on a classifier until the status is ready.
-    #   When you submit retraining requests in parallel, the last request overwrites the
-    #   previous requests. The retrained property shows the last time the classifier
-    #   retraining finished.
+    #   **Tips about retraining:**
+    #
+    #   - You can't update the classifier if the **X-Watson-Learning-Opt-Out** header
+    #   parameter was set to `true` when the classifier was created. Training images are
+    #   not stored in that case. Instead, create another classifier. For more information,
+    #   see [Data collection](#data-collection).
+    #
+    #   - Don't make retraining calls on a classifier until the status is ready. When you
+    #   submit retraining requests in parallel, the last request overwrites the 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 [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
@@ -459,6 +467,7 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -489,6 +498,7 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "DELETE",
         url: method_url,
@@ -506,7 +516,7 @@ module IBMWatson
     # @!method get_core_ml_model(classifier_id:)
     # Retrieve a Core ML model of a classifier.
     # Download a Core ML model file (.mlmodel) of a custom classifier that returns
-    #   <tt>\"core_ml_enabled\": true</tt> in the classifier details.
+    #   <tt>"core_ml_enabled": true</tt> in the classifier details.
     # @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:)
@@ -523,6 +533,7 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s/core_ml_model" % [ERB::Util.url_encode(classifier_id)]
 
+      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -563,6 +574,7 @@ module IBMWatson
 
       method_url = "/v3/user_data"
 
+      headers = authenticator.authenticate(headers)
       request(
         method: "DELETE",
         url: method_url,