ibm_watson 0.7.0 → 0.8.0

data/lib/ibm_watson/text_to_speech_v1.rb

@@ -15,58 +15,23 @@
 # limitations under the License.
 
 # ### Service Overview
-# The IBM® Text to Speech service provides an API that uses IBM's speech-synthesis
+# The IBM® Text to Speech service provides APIs that use IBM's speech-synthesis
 # capabilities to synthesize text into natural-sounding speech in a variety of languages,
 # dialects, and voices. The service supports at least one male or female voice, sometimes
 # both, for each language. The audio is streamed back to the client with minimal delay.
-# For more information about the service, see the [IBM® Cloud
-# documentation](https://console.bluemix.net/docs/services/text-to-speech/index.html).
 #
-# ### API usage guidelines
-# * **Audio formats:** The service can produce audio in many formats (MIME types). See
-# [Specifying an audio
-# format](https://console.bluemix.net/docs/services/text-to-speech/http.html#format).
-# * **SSML:** Many methods refer to the Speech Synthesis Markup Language (SSML). SSML is
-# an XML-based markup language that provides text annotation for speech-synthesis
-# applications. See [Using
-# SSML](https://console.bluemix.net/docs/services/text-to-speech/SSML.html) and [Using IBM
-# SPR](https://console.bluemix.net/docs/services/text-to-speech/SPRs.html).
-# * **Word translations:** Many customization methods accept sounds-like or phonetic
-# translations for words. Phonetic translations are based on the SSML phoneme format for
-# representing a word. You can specify them in standard International Phonetic Alphabet
-# (IPA) representation
+# For speech synthesis, the service supports a synchronous HTTP Representational State
+# Transfer (REST) interface. It also supports a WebSocket interface that provides both
+# plain text and SSML input, including the SSML <mark> element and word timings.
+# SSML is an XML-based markup language that provides text annotation for speech-synthesis
+# applications.
 #
-#   <phoneme alphabet="ipa" ph="təmˈɑto"></phoneme>
-#
-#   or in the proprietary IBM Symbolic Phonetic Representation (SPR)
-#
-#   <phoneme alphabet="ibm" ph="1gAstroEntxrYFXs"></phoneme>
-#
-#   See [Understanding
-# customization](https://console.bluemix.net/docs/services/text-to-speech/custom-intro.html).
-# * **WebSocket interface:** The service also offers a WebSocket interface for speech
-# synthesis. The WebSocket interface supports both plain text and SSML input, including
-# the SSML <mark> element and word timings. See [The WebSocket
-# interface](https://console.bluemix.net/docs/services/text-to-speech/websockets.html).
-# * **Customization IDs:** Many methods accept a customization ID, which is a Globally
-# Unique Identifier (GUID). Customization IDs are hexadecimal strings that have the format
-# `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`.
-# * **`X-Watson-Learning-Opt-Out`:** By default, all Watson services log requests and
-# their results. Logging is done only to improve the services for future users. The logged
-# data is not shared or made public. To prevent IBM from accessing your data for general
-# service improvements, set the `X-Watson-Learning-Opt-Out` request header to `true` for
-# all requests. You must set the header on each request that you do not want IBM to access
-# for general service improvements.
-#
-#   Methods of the customization interface do not log words and translations that you use
-# to build custom voice models. Your training data is never used to improve the service's
-# base models. However, the service does log such data when a custom model is used with a
-# synthesize request. You must set the `X-Watson-Learning-Opt-Out` request header to
-# `true` to prevent IBM from accessing the data to improve the service.
-# * **`X-Watson-Metadata`:** This header allows you to associate a customer ID with data
-# that is passed with a request. If necessary, you can use the **Delete labeled data**
-# method to delete the data for a customer ID. See [Information
-# security](https://console.bluemix.net/docs/services/text-to-speech/information-security.html).
+# The service also offers a customization interface. You can use the interface to define
+# sounds-like or phonetic translations for words. A sounds-like translation consists of
+# one or more words that, when combined, sound like the word. A phonetic translation is
+# based on the SSML phoneme format for representing a word. You can specify a phonetic
+# translation in standard International Phonetic Alphabet (IPA) representation or in the
+# proprietary IBM Symbolic Phonetic Representation (SPR).
 
 require "concurrent"
 require "erb"
@@ -132,6 +97,9 @@ module IBMWatson
     # Lists all voices available for use with the service. The information includes the
     #   name, language, gender, and other details about the voice. To see information
     #   about a specific voice, use the **Get a voice** method.
+    #
+    #   **See also:** [Specifying a
+    #   voice](https://console.bluemix.net/docs/services/text-to-speech/http.html#voices).
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_voices
       headers = {
@@ -153,6 +121,9 @@ module IBMWatson
     #   language, gender, and other details about the voice. Specify a customization ID to
     #   obtain information for that custom voice model of the specified voice. To list
     #   information about all available voices, use the **List voices** method.
+    #
+    #   **See also:** [Specifying a
+    #   voice](https://console.bluemix.net/docs/services/text-to-speech/http.html#voices).
     # @param voice [String] The voice for which information is to be returned.
     # @param customization_id [String] The customization ID (GUID) of a custom voice model for which information is to be
     #   returned. You must make the request with service credentials created for the
@@ -187,11 +158,7 @@ module IBMWatson
     # Synthesizes text to spoken audio, returning the synthesized audio stream as an
     #   array of bytes. You can pass a maximum of 5 KB of text.  Use the `Accept` header
     #   or the `accept` query parameter to specify the requested format (MIME type) of the
-    #   response audio. By default, the service uses `audio/ogg;codecs=opus`. For detailed
-    #   information about the supported audio formats and sampling rates, see [Specifying
-    #   an audio
-    #   format](https://console.bluemix.net/docs/services/text-to-speech/http.html#format).
-    #
+    #   response audio. By default, the service uses `audio/ogg;codecs=opus`.
     #
     #   If a request includes invalid query parameters, the service returns a `Warnings`
     #   response header that provides messages about the invalid parameters. The warning
@@ -199,6 +166,9 @@ module IBMWatson
     #   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.
+    #
+    #   **See also:** [Synthesizing text to
+    #   audio](https://console.bluemix.net/docs/services/text-to-speech/http.html#synthesize).
     # @param text [String] The text to synthesize.
     # @param accept [String] The requested audio format (MIME type) of the audio. You can use the `Accept`
     #   header or the `accept` query parameter to specify the audio format. (For the
@@ -251,6 +221,9 @@ module IBMWatson
     #   for a specific custom voice model to see the translation for that voice model.
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Querying a word from a
+    #   language](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordsQueryLanguage).
     # @param text [String] The word for which the pronunciation is requested.
     # @param voice [String] A voice that specifies the language in which the pronunciation is to be returned.
     #   All voices for the same language (for example, `en-US`) return the same
@@ -299,6 +272,9 @@ module IBMWatson
     #   used to create it.
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Creating a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsCreate).
     # @param name [String] The name of the new custom voice model.
     # @param language [String] The language of the new custom voice model. Omit the parameter to use the the
     #   default language, `en-US`.
@@ -337,6 +313,9 @@ module IBMWatson
     #   about it.
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Querying all custom
+    #   models](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsQueryAll).
     # @param language [String] The language for which custom voice models that are owned by the requesting
     #   service credentials are to be returned. Omit the parameter to see all custom voice
     #   models that are owned by the requester.
@@ -368,7 +347,29 @@ module IBMWatson
     #   custom model can contain no more than 20,000 entries. You must use credentials for
     #   the instance of the service that owns a model to update it.
     #
+    #   You can define sounds-like or phonetic translations for words. A sounds-like
+    #   translation consists of one or more words that, when combined, sound like the
+    #   word. Phonetic translations are based on the SSML phoneme format for representing
+    #   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>
+    #
+    #     or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+    #
+    #     <code>&lt;phoneme alphabet=\"ibm\"
+    #   ph=\"1gAstroEntxrYFXs\"&gt;&lt;/phoneme&gt;</code>
+    #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:**
+    #   * [Updating a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsUpdate)
+    #   * [Adding words to a Japanese custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuJapaneseAdd)
+    #   * [Understanding
+    #   customization](https://console.bluemix.net/docs/services/text-to-speech/custom-intro.html).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -408,6 +409,9 @@ module IBMWatson
     #   voice model, use the **List custom models** method.
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Querying a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsQuery).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -434,6 +438,9 @@ module IBMWatson
     #   instance of the service that owns a model to delete it.
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Deleting a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsDelete).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -465,7 +472,29 @@ module IBMWatson
     #   than 20,000 entries. You must use credentials for the instance of the service that
     #   owns a model to add words to it.
     #
+    #   You can define sounds-like or phonetic translations for words. A sounds-like
+    #   translation consists of one or more words that, when combined, sound like the
+    #   word. Phonetic translations are based on the SSML phoneme format for representing
+    #   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>
+    #
+    #     or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+    #
+    #     <code>&lt;phoneme alphabet=\"ibm\"
+    #   ph=\"1gAstroEntxrYFXs\"&gt;&lt;/phoneme&gt;</code>
+    #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:**
+    #   * [Adding multiple words to a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordsAdd)
+    #   * [Adding words to a Japanese custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuJapaneseAdd)
+    #   * [Understanding
+    #   customization](https://console.bluemix.net/docs/services/text-to-speech/custom-intro.html).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -508,6 +537,9 @@ module IBMWatson
     #   words.
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Querying all words from a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordsQueryModel).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -536,7 +568,29 @@ module IBMWatson
     #   entries. You must use credentials for the instance of the service that owns a
     #   model to add a word to it.
     #
+    #   You can define sounds-like or phonetic translations for words. A sounds-like
+    #   translation consists of one or more words that, when combined, sound like the
+    #   word. Phonetic translations are based on the SSML phoneme format for representing
+    #   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>
+    #
+    #     or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+    #
+    #     <code>&lt;phoneme alphabet=\"ibm\"
+    #   ph=\"1gAstroEntxrYFXs\"&gt;&lt;/phoneme&gt;</code>
+    #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:**
+    #   * [Adding a single word to a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordAdd)
+    #   * [Adding words to a Japanese custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuJapaneseAdd)
+    #   * [Understanding
+    #   customization](https://console.bluemix.net/docs/services/text-to-speech/custom-intro.html).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -584,6 +638,9 @@ module IBMWatson
     #   the instance of the service that owns a model to list its words.
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Querying a single word from a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordQueryModel).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -614,6 +671,9 @@ module IBMWatson
     #
     #
     #   **Note:** This method is currently a beta release.
+    #
+    #   **See also:** [Deleting a word from a custom
+    #   model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordDelete).
     # @param customization_id [String] The customization ID (GUID) of the custom voice model. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model.
@@ -649,8 +709,9 @@ module IBMWatson
     #   the service that was used to associate the customer ID with the data.
     #
     #   You associate a customer ID with data by passing the `X-Watson-Metadata` header
-    #   with a request that passes the data. For more information about customer IDs and
-    #   about using this method, see [Information
+    #   with a request that passes the data.
+    #
+    #   **See also:** [Information
     #   security](https://console.bluemix.net/docs/services/text-to-speech/information-security.html).
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]

data/lib/ibm_watson/tone_analyzer_v3.rb

@@ -116,6 +116,9 @@ module IBMWatson
     #   to indicate the character encoding of the input text; for example: `Content-Type:
     #   text/plain;charset=utf-8`. For `text/html`, the service removes HTML tags and
     #   analyzes only the textual content.
+    #
+    #   **See also:** [Using the general-purpose
+    #   endpoint](https://console.bluemix.net/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
@@ -186,10 +189,11 @@ module IBMWatson
     #   overall content and analyzes only the first 50 utterances. If you submit a single
     #   utterance that contains more than 500 characters, the service returns an error for
     #   that utterance and does not analyze the utterance. The request fails if all
-    #   utterances have more than 500 characters.
+    #   utterances have more than 500 characters. Per the JSON specification, the default
+    #   character encoding for JSON content is effectively always UTF-8.
     #
-    #   Per the JSON specification, the default character encoding for JSON content is
-    #   effectively always UTF-8.
+    #   **See also:** [Using the customer-engagement
+    #   endpoint](https://console.bluemix.net/docs/services/tone-analyzer/using-tone-chat.html#using-the-customer-engagement-endpoint).
     # @param utterances [Array[Utterance]] An array of `Utterance` objects that provides the input content that the service
     #   is to analyze.
     # @param content_language [String] The language of the input text for the request: English or French. Regional

data/lib/ibm_watson/version.rb

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

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -49,7 +49,6 @@ module IBMWatson
     # @option args url [String] The base url to use when contacting the service (e.g.
     #   "https://gateway.watsonplatform.net/visual-recognition/api").
     #   The base url may differ between Bluemix regions.
-    # @option args api_key [String] The API Key used to authenticate.
     # @option args iam_apikey [String] An API key that can be used to request IAM tokens. If
     #   this API key is provided, the SDK will manage the token and handle the
     #   refreshing.
@@ -64,7 +63,6 @@ module IBMWatson
       defaults = {}
       defaults[:version] = nil
       defaults[:url] = "https://gateway.watsonplatform.net/visual-recognition/api"
-      defaults[:api_key] = nil
       defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil

data/lib/ibm_watson/watson_service.rb

@@ -28,7 +28,6 @@ class WatsonService
       username: nil,
       password: nil,
       use_vcap_services: true,
-      api_key: nil,
       iam_apikey: nil,
       iam_access_token: nil,
       iam_url: nil

data/test/integration/test_discovery_v1.rb

@@ -196,8 +196,9 @@ if !ENV["DISCOVERY_USERNAME"].nil? && !ENV["DISCOVERY_PASSWORD"].nil?
         environment_id: @environment_id,
         collection_id: @collection_id,
         filter: "extracted_metadata.sha1::9181d244*",
-        return_fields: ["extracted_metadata.sha1"]
+        return_fields: "extracted_metadata.sha1"
       ).result
+      puts query_results
       refute(query_results.nil?)
     end
 

data/test/unit/test_discovery_v1.rb

@@ -254,8 +254,9 @@ class DiscoveryV1Test < Minitest::Test
       password: "password",
       version: "2018-03-05"
     )
-    stub_request(:get, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/collid/query?count=10&version=2018-03-05")
+    stub_request(:post, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/collid/query?version=2018-03-05")
       .with(
+        body: "{\"count\":10}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
@@ -952,12 +953,14 @@ class DiscoveryV1Test < Minitest::Test
       password: "password",
       version: "2018-03-05"
     )
-    stub_request(:get, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/query?collection_ids=collid&version=2018-03-05")
+    stub_request(:post, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/query?&version=2018-03-05")
       .with(
+        body:  "{\"collection_ids\":[\"collid\"]}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
-          "Host" => "gateway.watsonplatform.net"
+          "Host" => "gateway.watsonplatform.net",
+          "Content-type" => "application/json"
         }
       ).to_return(status: 200, body: { "received" => "true" }.to_json, headers: { "Content-Type" => "application/json" })
     service_response = service.federated_query(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_watson
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Max Nussbaum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby