ibm_watson 1.0.0.rc3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b31e9a1c0716de79a3d3414f8fd6f7416e344cbb0bc6e6e10fc1ab65640c7e5
-  data.tar.gz: bc1236ce05639ec9c74dc833d3ab1879ec69a5c68f547e9465b53918df1dc5f7
+  metadata.gz: 39e10926734524673eccb99a00cdcb9356d3570514b6ee6e320054b6a11f310e
+  data.tar.gz: 50a19a96c0bfb3843eba4540bc36a417ed0aed27ca1eb02e491c73a2897c2912
 SHA512:
-  metadata.gz: '08bc9c5be324d9104cb530f0b7406f921a74dea49a6ff1cfa9593df4c641fe9b1e8e293fe074ea53a4f246d089fbfb44ffc4ee91cde8212a1508a217049cf745'
-  data.tar.gz: 90108045c649d473fe6a8defc62b4033fa86382a37862f96439d1f3b2e7302e34d9abaa45675e3a014b21d872eccde599dc47890eb08a23d730e45d29b45f23f
+  metadata.gz: 313e51742037b568acc09e6caff75508e6a3f900cea657a499fc4f7f0b15052c224071577ccd4beb6774a3fc0c60eda8f22fe2393c2eaf84f594d6a5cc38b32b
+  data.tar.gz: d35a075c19323141bac2c5c15bf61b873d616ac5c4bb9578969713294056b81207d3d200560fba3947ca019acc00a6bb30bdebc8638e95c8ffca50df810e03ed

data/README.md

@@ -92,8 +92,8 @@ With a credential file, you just need to put the file in the right place and the
 
 The file downloaded will be called `ibm-credentials.env`. This is the name the SDK will search for and **must** be preserved unless you want to configure the file path (more on that later). The SDK will look for your `ibm-credentials.env` file in the following places (in order):
 
-* Your system's home directory
 * The top-level directory of the project you're using the SDK in
+* Your system's home directory
 
  As long as you set that up correctly, you don't have to worry about setting any authentication options in your code. So, for example, if you created and downloaded the credential file for your Discovery instance, you just need to do the following:
 
@@ -130,7 +130,7 @@ You supply either an IAM service **API key** or an **access token**:
 
 ```ruby
 # In the constructor, letting the SDK manage the IAM token
-authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
   apikey: "<iam_apikey>",
   url: "<iam_url>" # optional - the default value is https://iam.cloud.ibm.com/identity/token
 )
@@ -144,7 +144,7 @@ discover.service_url = "<service-url>" # setting service url
 #### Supplying the access token
 
 ```ruby
-authenticator = IBMCloudSdkCore::BearerTokenAuthenticator.new(
+authenticator = IBMWatson::Authenticators::BearerTokenAuthenticator.new(
   bearer_token: "<access_token>"
 )
 discovery = IBMWatson::DiscoveryV1.new(version: "2017-10-16", authenticator)
@@ -157,7 +157,7 @@ require "ibm_watson"
 require "ibm_cloud_sdk_core"
 include IBMWatson
 # In the constructor
-authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+authenticator = IBMWatson::Authenticators::BasicAuthenticator.new(
   username: "<username>",
   password: "<password>"
 )
@@ -177,7 +177,7 @@ Requests can be sent asynchronously. There are two asynchronous methods availabl
 When `await` is used, the request is made synchronously.
 
 ```ruby
-authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+authenticator = IBMWatson::Authenticators::BasicAuthenticator.new(
   username: "<username>",
   password: "<password>"
 )
@@ -196,7 +196,7 @@ output = future.value # The response is accessible at future.value
 When `async` is used, the request is made asynchronously
 
 ```ruby
-authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+authenticator = IBMWatson::Authenticators::BasicAuthenticator.new(
   username: "<username>",
   password: "<password>"
 )
@@ -350,7 +350,7 @@ The SDK will manage the token for the user
 
 ```ruby
 
-authenticator = IBMCloudSdkCore::CLoudPakForDataAuthenticator.new(
+authenticator = IBMWatson::Authenticators::CLoudPakForDataAuthenticator.new(
   username: "<username>",
   password: "<password>",
   url: "<authentication url>",
@@ -394,4 +394,4 @@ We'd love to highlight cool open-source projects that use this SDK! If you'd lik
 [license]: http://www.apache.org/licenses/LICENSE-2.0
 [vcap_services]: https://cloud.ibm.com/docs/services/watson?topic=watson-vcapServices
 [ibm-cloud-onboarding]: http://cloud.ibm.com/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Ruby
-[ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html
+[ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html

data/lib/ibm_watson.rb

@@ -7,15 +7,6 @@ module IBMWatson
   ApiException = IBMCloudSdkCore::ApiException
   DetailedResponse = IBMCloudSdkCore::DetailedResponse
 
-  module Authenticators
-    BasicAuthenticator = IBMCloudSdkCore::BasicAuthenticator
-    BearerTokenAuthenticator = IBMCloudSdkCore::BearerTokenAuthenticator
-    CloudPakForDataAuthenticator = IBMCloudSdkCore::CloudPakForDataAuthenticator
-    ConfigBasedAuthenticatorFactory = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory
-    IamAuthenticator = IBMCloudSdkCore::IamAuthenticator
-    NoAuthAuthenticator = IBMCloudSdkCore::NoAuthAuthenticator
-  end
-
   require_relative("./ibm_watson/personality_insights_v3.rb")
   require_relative("./ibm_watson/tone_analyzer_v3.rb")
   require_relative("./ibm_watson/assistant_v1.rb")
@@ -25,9 +16,11 @@ module IBMWatson
   require_relative("./ibm_watson/natural_language_understanding_v1.rb")
   require_relative("./ibm_watson/speech_to_text_v1.rb")
   require_relative("./ibm_watson/visual_recognition_v3.rb")
+  require_relative("./ibm_watson/visual_recognition_v4.rb")
   require_relative("./ibm_watson/natural_language_classifier_v1.rb")
   require_relative("./ibm_watson/language_translator_v3.rb")
   require_relative("./ibm_watson/compare_comply_v1.rb")
   require_relative("./ibm_watson/websocket/recognize_callback.rb")
+  require_relative("./ibm_watson/authenticators.rb")
   require_relative("./ibm_watson/common.rb")
 end

data/lib/ibm_watson/assistant_v1.rb

@@ -17,6 +17,9 @@
 # The IBM Watson™ Assistant service combines machine learning, natural language
 # understanding, and an integrated dialog editor to create conversation flows between your
 # apps and your users.
+#
+# The Assistant v1 API provides authoring methods your application can use to create or
+# update a workspace.
 
 require "concurrent"
 require "erb"
@@ -72,8 +75,8 @@ module IBMWatson
     # Get response to user input.
     # Send user input to a workspace and receive a response.
     #
-    #   **Note:** For most applications, there are significant advantages to using the v2
-    #   runtime API instead. These advantages include ease of deployment, automatic state
+    #   **Important:** This method has been superseded by the new v2 runtime API. The v2
+    #   API offers significant advantages, including ease of deployment, automatic state
     #   management, versioning, and search capabilities. For more information, see the
     #   [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-api-overview).
     #

data/lib/ibm_watson/assistant_v2.rb

@@ -17,6 +17,9 @@
 # The IBM Watson™ Assistant service combines machine learning, natural language
 # understanding, and an integrated dialog editor to create conversation flows between your
 # apps and your users.
+#
+# The Assistant v2 API provides runtime methods your client application can use to send
+# user input to an assistant and receive a response.
 
 require "concurrent"
 require "erb"

data/lib/ibm_watson/authenticators.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require("ibm_cloud_sdk_core")
+
+# Module for the Watson APIs
+module IBMWatson
+  class Authenticators
+    BasicAuthenticator = IBMCloudSdkCore::BasicAuthenticator
+    BearerTokenAuthenticator = IBMCloudSdkCore::BearerTokenAuthenticator
+    CloudPakForDataAuthenticator = IBMCloudSdkCore::CloudPakForDataAuthenticator
+    ConfigBasedAuthenticatorFactory = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory
+    IamAuthenticator = IBMCloudSdkCore::IamAuthenticator
+    NoAuthAuthenticator = IBMCloudSdkCore::NoAuthAuthenticator
+  end
+end

data/lib/ibm_watson/discovery_v1.rb

@@ -260,10 +260,11 @@ module IBMWatson
       }
       sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "list_fields")
       headers.merge!(sdk_headers)
+      collection_ids *= "," unless collection_ids.nil?
 
       params = {
         "version" => @version,
-        "collection_ids" => collection_ids.to_a
+        "collection_ids" => collection_ids
       }
 
       method_url = "/v1/environments/%s/fields" % [ERB::Util.url_encode(environment_id)]
@@ -1305,7 +1306,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, passages_fields: nil, passages_count: nil, passages_characters: nil, deduplicate: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil, bias: nil, x_watson_logging_opt_out: nil)
+    # @!method query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, passages_fields: nil, passages_count: nil, passages_characters: nil, deduplicate: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil, bias: nil, spelling_suggestions: nil, x_watson_logging_opt_out: nil)
     # Query a collection.
     # By using this method, you can construct long queries. For details, see the
     #   [Discovery
@@ -1364,9 +1365,15 @@ module IBMWatson
     #   a **number** type field is specified, returned results are biased towards higher
     #   field values. This parameter cannot be used in the same query as the **sort**
     #   parameter.
+    # @param spelling_suggestions [Boolean] When `true` and the **natural_language_query** parameter is used, the
+    #   **natural_languge_query** parameter is spell checked. The most likely correction
+    #   is retunred in the **suggested_query** field of the response (if one exists).
+    #
+    #   **Important:** this parameter is only valid when using the Cloud Pak version of
+    #   Discovery.
     # @param x_watson_logging_opt_out [Boolean] If `true`, queries are not stored in the Discovery **Logs** endpoint.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, passages_fields: nil, passages_count: nil, passages_characters: nil, deduplicate: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil, bias: nil, x_watson_logging_opt_out: nil)
+    def query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, passages_fields: nil, passages_count: nil, passages_characters: nil, deduplicate: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil, bias: nil, spelling_suggestions: nil, x_watson_logging_opt_out: nil)
       raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
 
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
@@ -1400,7 +1407,8 @@ module IBMWatson
         "similar" => similar,
         "similar.document_ids" => similar_document_ids,
         "similar.fields" => similar_fields,
-        "bias" => bias
+        "bias" => bias,
+        "spelling_suggestions" => spelling_suggestions
       }
 
       method_url = "/v1/environments/%s/collections/%s/query" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(collection_id)]
@@ -1478,6 +1486,11 @@ module IBMWatson
       }
       sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "query_notices")
       headers.merge!(sdk_headers)
+      _return *= "," unless _return.nil?
+      sort *= "," unless sort.nil?
+      passages_fields *= "," unless passages_fields.nil?
+      similar_document_ids *= "," unless similar_document_ids.nil?
+      similar_fields *= "," unless similar_fields.nil?
 
       params = {
         "version" => @version,
@@ -1487,17 +1500,17 @@ module IBMWatson
         "passages" => passages,
         "aggregation" => aggregation,
         "count" => count,
-        "return" => _return.to_a,
+        "return" => _return,
         "offset" => offset,
-        "sort" => sort.to_a,
+        "sort" => sort,
         "highlight" => highlight,
-        "passages.fields" => passages_fields.to_a,
+        "passages.fields" => passages_fields,
         "passages.count" => passages_count,
         "passages.characters" => passages_characters,
         "deduplicate.field" => deduplicate_field,
         "similar" => similar,
-        "similar.document_ids" => similar_document_ids.to_a,
-        "similar.fields" => similar_fields.to_a
+        "similar.document_ids" => similar_document_ids,
+        "similar.fields" => similar_fields
       }
 
       method_url = "/v1/environments/%s/collections/%s/notices" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(collection_id)]
@@ -1679,23 +1692,28 @@ module IBMWatson
       }
       sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "federated_query_notices")
       headers.merge!(sdk_headers)
+      collection_ids *= "," unless collection_ids.nil?
+      _return *= "," unless _return.nil?
+      sort *= "," unless sort.nil?
+      similar_document_ids *= "," unless similar_document_ids.nil?
+      similar_fields *= "," unless similar_fields.nil?
 
       params = {
         "version" => @version,
-        "collection_ids" => collection_ids.to_a,
+        "collection_ids" => collection_ids,
         "filter" => filter,
         "query" => query,
         "natural_language_query" => natural_language_query,
         "aggregation" => aggregation,
         "count" => count,
-        "return" => _return.to_a,
+        "return" => _return,
         "offset" => offset,
-        "sort" => sort.to_a,
+        "sort" => sort,
         "highlight" => highlight,
         "deduplicate.field" => deduplicate_field,
         "similar" => similar,
-        "similar.document_ids" => similar_document_ids.to_a,
-        "similar.fields" => similar_fields.to_a
+        "similar.document_ids" => similar_document_ids,
+        "similar.fields" => similar_fields
       }
 
       method_url = "/v1/environments/%s/notices" % [ERB::Util.url_encode(environment_id)]
@@ -1709,6 +1727,51 @@ module IBMWatson
       )
       response
     end
+
+    ##
+    # @!method get_autocompletion(environment_id:, collection_id:, prefix:, field: nil, count: nil)
+    # Get Autocomplete Suggestions.
+    # Returns completion query suggestions for the specified prefix.  /n/n
+    #   **Important:** this method is only valid when using the Cloud Pak version of
+    #   Discovery.
+    # @param environment_id [String] The ID of the environment.
+    # @param collection_id [String] The ID of the collection.
+    # @param prefix [String] The prefix to use for autocompletion. For example, the prefix `Ho` could
+    #   autocomplete to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are.
+    # @param field [String] The field in the result documents that autocompletion suggestions are identified
+    #   from.
+    # @param count [Fixnum] The number of autocompletion suggestions to return.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_autocompletion(environment_id:, collection_id:, prefix:, field: nil, count: nil)
+      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
+
+      raise ArgumentError.new("prefix must be provided") if prefix.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "get_autocompletion")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "prefix" => prefix,
+        "field" => field,
+        "count" => count
+      }
+
+      method_url = "/v1/environments/%s/collections/%s/autocompletion" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(collection_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
     #########################
     # Training data
     #########################
@@ -2215,6 +2278,7 @@ module IBMWatson
       }
       sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "query_log")
       headers.merge!(sdk_headers)
+      sort *= "," unless sort.nil?
 
       params = {
         "version" => @version,
@@ -2222,7 +2286,7 @@ module IBMWatson
         "query" => query,
         "count" => count,
         "offset" => offset,
-        "sort" => sort.to_a
+        "sort" => sort
       }
 
       method_url = "/v1/logs"

data/lib/ibm_watson/speech_to_text_v1.rb

@@ -365,9 +365,9 @@ module IBMWatson
       headers = {
         "Content-Type" => content_type
       }
-      keywords *= "," unless keywords.nil?
       sdk_headers = Common.new.get_sdk_headers("speech_to_text", "V1", "recognize")
       headers.merge!(sdk_headers)
+      keywords *= "," unless keywords.nil?
 
       params = {
         "model" => model,
@@ -942,6 +942,7 @@ module IBMWatson
       }
       sdk_headers = Common.new.get_sdk_headers("speech_to_text", "V1", "create_job")
       headers.merge!(sdk_headers)
+      keywords *= "," unless keywords.nil?
 
       params = {
         "model" => model,
@@ -954,7 +955,7 @@ module IBMWatson
         "base_model_version" => base_model_version,
         "customization_weight" => customization_weight,
         "inactivity_timeout" => inactivity_timeout,
-        "keywords" => keywords.to_a,
+        "keywords" => keywords,
         "keywords_threshold" => keywords_threshold,
         "max_alternatives" => max_alternatives,
         "word_alternatives_threshold" => word_alternatives_threshold,

data/lib/ibm_watson/text_to_speech_v1.rb

@@ -158,7 +158,8 @@ module IBMWatson
     #    The service can return audio in the following formats (MIME types).
     #   * Where indicated, you can optionally specify the sampling rate (`rate`) of the
     #   audio. You must specify a sampling rate for the `audio/l16` and `audio/mulaw`
-    #   formats. A specified sampling rate must lie in the range of 8 kHz to 192 kHz.
+    #   formats. A specified sampling rate must lie in the range of 8 kHz to 192 kHz. Some
+    #   formats restrict the sampling rate to certain values, as noted.
     #   * For the `audio/l16` format, you can optionally specify the endianness
     #   (`endianness`) of the audio: `endianness=big-endian` or
     #   `endianness=little-endian`.
@@ -167,55 +168,33 @@ module IBMWatson
     #   of the response audio. If you omit an audio format altogether, the service returns
     #   the audio in Ogg format with the Opus codec (`audio/ogg;codecs=opus`). The service
     #   always returns single-channel audio.
-    #   * `audio/basic`
-    #
-    #     The service returns audio with a sampling rate of 8000 Hz.
-    #   * `audio/flac`
-    #
-    #     You can optionally specify the `rate` of the audio. The default sampling rate is
-    #   22,050 Hz.
-    #   * `audio/l16`
-    #
-    #     You must specify the `rate` of the audio. You can optionally specify the
-    #   `endianness` of the audio. The default endianness is `little-endian`.
-    #   * `audio/mp3`
-    #
-    #     You can optionally specify the `rate` of the audio. The default sampling rate is
-    #   22,050 Hz.
-    #   * `audio/mpeg`
-    #
-    #     You can optionally specify the `rate` of the audio. The default sampling rate is
-    #   22,050 Hz.
-    #   * `audio/mulaw`
-    #
-    #     You must specify the `rate` of the audio.
-    #   * `audio/ogg`
-    #
-    #     The service returns the audio in the `vorbis` codec. You can optionally specify
-    #   the `rate` of the audio. The default sampling rate is 22,050 Hz.
-    #   * `audio/ogg;codecs=opus`
-    #
-    #     You can optionally specify the `rate` of the audio. The default sampling rate is
-    #   22,050 Hz.
-    #   * `audio/ogg;codecs=vorbis`
-    #
-    #     You can optionally specify the `rate` of the audio. The default sampling rate is
-    #   22,050 Hz.
-    #   * `audio/wav`
-    #
-    #     You can optionally specify the `rate` of the audio. The default sampling rate is
-    #   22,050 Hz.
-    #   * `audio/webm`
-    #
-    #     The service returns the audio in the `opus` codec. The service returns audio
-    #   with a sampling rate of 48,000 Hz.
-    #   * `audio/webm;codecs=opus`
-    #
-    #     The service returns audio with a sampling rate of 48,000 Hz.
-    #   * `audio/webm;codecs=vorbis`
-    #
-    #     You can optionally specify the `rate` of the audio. The default sampling rate is
-    #   22,050 Hz.
+    #   * `audio/basic` - The service returns audio with a sampling rate of 8000 Hz.
+    #   * `audio/flac` - You can optionally specify the `rate` of the audio. The default
+    #   sampling rate is 22,050 Hz.
+    #   * `audio/l16` - You must specify the `rate` of the audio. You can optionally
+    #   specify the `endianness` of the audio. The default endianness is `little-endian`.
+    #   * `audio/mp3` - You can optionally specify the `rate` of the audio. The default
+    #   sampling rate is 22,050 Hz.
+    #   * `audio/mpeg` - You can optionally specify the `rate` of the audio. The default
+    #   sampling rate is 22,050 Hz.
+    #   * `audio/mulaw` - You must specify the `rate` of the audio.
+    #   * `audio/ogg` - The service returns the audio in the `vorbis` codec. You can
+    #   optionally specify the `rate` of the audio. The default sampling rate is 22,050
+    #   Hz.
+    #   * `audio/ogg;codecs=opus` - You can optionally specify the `rate` of the audio.
+    #   Only the following values are valid sampling rates: `48000`, `24000`, `16000`,
+    #   `12000`, or `8000`. If you specify a value other than one of these, the service
+    #   returns an error. The default sampling rate is 48,000 Hz.
+    #   * `audio/ogg;codecs=vorbis` - You can optionally specify the `rate` of the audio.
+    #   The default sampling rate is 22,050 Hz.
+    #   * `audio/wav` - You can optionally specify the `rate` of the audio. The default
+    #   sampling rate is 22,050 Hz.
+    #   * `audio/webm` - The service returns the audio in the `opus` codec. The service
+    #   returns audio with a sampling rate of 48,000 Hz.
+    #   * `audio/webm;codecs=opus` - The service returns audio with a sampling rate of
+    #   48,000 Hz.
+    #   * `audio/webm;codecs=vorbis` - You can optionally specify the `rate` of the audio.
+    #   The default sampling rate is 22,050 Hz.
     #
     #   For more information about specifying an audio format, including additional
     #   details about some of the formats, see [Audio