ibm_watson 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7ab67f5e1862edec369814a6922632805dfd6168754a3f5fe4f308c2563ede1
-  data.tar.gz: 9439f61e848fb0683c0c82b15c7146611504b2d31b33dc897ebc149bab870e58
+  metadata.gz: 0eb3dece96d55c7c9cf48e0e2e85912e1b044710c6483f7f39c1993c9e7ce0ed
+  data.tar.gz: db5d372a1e33c321f3c4e0156d777513909872e48b87d81e0a5eadbb661ef30e
 SHA512:
-  metadata.gz: 278793e0322df1edfe1d5aa1ba33e89b2142e0d9c02ee0d4f2243452e7c0731cbf427d3ee24b8f3aadd8993bc5a0a181c52fffa4f1c8197d66b22560f4424bd6
-  data.tar.gz: 3fde12cf25463d7368a9febb161ea311d9ff61f099e86a2368f71eda35f8006755c10e206bac8181c9fc332dbf3f97a3f784c9eebcb8f05649ee5e56fa84d8e8
+  metadata.gz: a7af1ca50217a8900f58b4599aafd28e7f376283f631a4e99fef5bae499e47a0315af2b573e99fb08377f00d0f33a6c2ac2b4ab50b69633d1f785c7bc9482d3d
+  data.tar.gz: daa066a5ff004c629c069d123619fa6e1da2074af5e5d0323cc824d41bce9c34c07209a74be159ba737976c37ab095dd32c43257723dbb0f99a2aa52016a9332

data/README.md

@@ -35,6 +35,8 @@ Ruby gem to quickly get started with the various [IBM Watson][wdc] services.
 ## Before you begin
 * You need an [IBM Cloud][ibm-cloud-onboarding] account.
 
+> Watson Assistant v2 API is released in beta. For details, see the ["Introducing Watson Assistant"](https://www.ibm.com/blogs/watson/2018/03/the-future-of-watson-conversation-watson-assistant/) blog post.
+
 ## Installation
 
 Install the gem:

data/lib/ibm_watson/discovery_v1.rb

@@ -838,6 +838,98 @@ module IBMWatson
       )
       nil
     end
+
+    ##
+    # @!method get_tokenization_dictionary_status(environment_id:, collection_id:)
+    # Get tokenization dictionary status.
+    # Returns the current status of the tokenization dictionary for the specified
+    #   collection.
+    # @param environment_id [String] The ID of the environment.
+    # @param collection_id [String] The ID of the collection.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def get_tokenization_dictionary_status(environment_id:, collection_id:)
+      raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
+      headers = {
+      }
+      params = {
+        "version" => @version
+      }
+      method_url = "/v1/environments/%s/collections/%s/word_lists/tokenization_dictionary" % [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
+
+    ##
+    # @!method create_tokenization_dictionary(environment_id:, collection_id:, tokenization_rules: nil)
+    # Create tokenization dictionary.
+    # Upload a custom tokenization dictionary to use with the specified collection.
+    # @param environment_id [String] The ID of the environment.
+    # @param collection_id [String] The ID of the collection.
+    # @param tokenization_rules [Array[TokenDictRule]] An array of tokenization rules. Each rule contains, the original `text` string,
+    #   component `tokens`, any alternate character set `readings`, and which
+    #   `part_of_speech` the text is from.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def create_tokenization_dictionary(environment_id:, collection_id:, tokenization_rules: nil)
+      raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
+      headers = {
+      }
+      params = {
+        "version" => @version
+      }
+      data = {
+        "tokenization_rules" => tokenization_rules
+      }
+      method_url = "/v1/environments/%s/collections/%s/word_lists/tokenization_dictionary" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(collection_id)]
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method delete_tokenization_dictionary(environment_id:, collection_id:)
+    # Delete tokenization dictionary.
+    # Delete the tokenization dictionary from the collection.
+    # @param environment_id [String] The ID of the environment.
+    # @param collection_id [String] The ID of the collection.
+    # @return [nil]
+    def delete_tokenization_dictionary(environment_id:, collection_id:)
+      raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
+      headers = {
+      }
+      params = {
+        "version" => @version
+      }
+      method_url = "/v1/environments/%s/collections/%s/word_lists/tokenization_dictionary" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(collection_id)]
+      request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      nil
+    end
     #########################
     # Documents
     #########################

data/lib/ibm_watson/natural_language_understanding_v1.rb

@@ -15,14 +15,14 @@
 # limitations under the License.
 
 # Analyze various features of text content at scale. Provide text, raw HTML, or a public
-# URL, and IBM Watson Natural Language Understanding will give you results for the
-# features you request. The service cleans HTML content before analysis by default, so the
-# results can ignore most advertisements and other unwanted content.
+# URL and IBM Watson Natural Language Understanding will give you results for the features
+# you request. The service cleans HTML content before analysis by default, so the results
+# can ignore most advertisements and other unwanted content.
 #
-# You can create <a target="_blank"
-# href="https://www.ibm.com/watson/developercloud/doc/natural-language-understanding/customizing.html">custom
-# models</a> with Watson Knowledge Studio that can be used to detect custom entities and
-# relations in Natural Language Understanding.
+# You can create [custom
+# models](/docs/services/natural-language-understanding/customizing.html) with Watson
+# Knowledge Studio to detect custom entities and relations in Natural Language
+# Understanding.
 
 require "concurrent"
 require "erb"
@@ -97,52 +97,9 @@ 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.
-    #
-    #   ### Concepts
-    #   Identify general concepts that are referenced or alluded to in your content.
-    #   Concepts that are detected typically have an associated link to a DBpedia
-    #   resource.
-    #
-    #   ### Emotion
-    #   Detect anger, disgust, fear, joy, or sadness that is conveyed by your content.
-    #   Emotion information can be returned for detected entities, keywords, or
-    #   user-specified target phrases found in the text.
-    #
-    #   ### Entities
-    #   Detect important people, places, geopolitical entities and other types of entities
-    #   in your content. Entity detection recognizes consecutive coreferences of each
-    #   entity. For example, analysis of the following text would count \"Barack Obama\"
-    #   and \"He\" as the same entity:
-    #
-    #   \"Barack Obama was the 44th President of the United States. He took office in
-    #   January 2009.\"
-    #
-    #   ### Keywords
-    #   Determine the most important keywords in your content. Keyword phrases are
-    #   organized by relevance in the results.
-    #
-    #   ### Metadata
-    #   Get author information, publication date, and the title of your text/HTML content.
-    #
-    #   ### Relations
-    #   Recognize when two entities are related, and identify the type of relation.  For
-    #   example, you can identify an \"awardedTo\" relation between an award and its
-    #   recipient.
-    #
-    #   ### Semantic Roles
-    #   Parse sentences into subject-action-object form, and identify entities and
-    #   keywords that are subjects or objects of an action.
-    #
-    #   ### Sentiment
-    #   Determine whether your content conveys postive or negative sentiment. Sentiment
-    #   information can be returned for detected entities, keywords, or user-specified
-    #   target phrases found in the text.
-    #
-    #   ### Categories
-    #   Categorize your content into a hierarchical 5-level taxonomy. For example,
-    #   \"Leonardo DiCaprio won an Oscar\" returns \"/art and entertainment/movies and
-    #   tv/movies\" as the most confident classification.
+    # 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.
     # @param text [String] The plain text to analyze. One of the `text`, `html`, or `url` parameters is
     #   required.

data/lib/ibm_watson/speech_to_text_v1.rb

@@ -24,8 +24,8 @@
 # For speech recognition, the service supports synchronous and asynchronous HTTP
 # Representational State Transfer (REST) interfaces. It also supports a WebSocket
 # interface that provides a full-duplex, low-latency communication channel: Clients send
-# requests and audio to the service and receive results over a single connection in an
-# asynchronous fashion.
+# requests and audio to the service and receive results over a single connection
+# asynchronously.
 #
 # The service also offers two customization interfaces. Use language model customization
 # to expand the vocabulary of a base model with domain-specific terminology. Use acoustic
@@ -146,14 +146,13 @@ module IBMWatson
     #########################
 
     ##
-    # @!method recognize(audio:, content_type:, model: nil, customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil)
+    # @!method recognize(audio:, content_type:, model: nil, language_customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil, customization_id: nil)
     # Recognize audio.
     # Sends audio and returns transcription results for a recognition request. Returns
     #   only the final results; to enable interim results, use the WebSocket API. The
     #   service imposes a data size limit of 100 MB. It automatically detects the
     #   endianness of the incoming audio and, for audio that includes multiple channels,
-    #   downmixes the audio to one-channel mono during transcoding. (For the `audio/l16`
-    #   format, you can specify the endianness.)
+    #   downmixes the audio to one-channel mono during transcoding.
     #
     #   **See also:** [Making a basic HTTP
     #   request](https://console.bluemix.net/docs/services/speech-to-text/http.html#HTTP-basic).
@@ -178,16 +177,23 @@ module IBMWatson
     #
     #   ### Audio formats (content types)
     #
-    #    Use the `Content-Type` header to specify the audio format (MIME type) of the
-    #   audio. The service accepts the following formats, including specifying the
-    #   sampling rate, channels, and endianness where indicated.
-    #   * `audio/basic` (Use only with narrowband models.)
+    #    The service accepts audio in the following formats (MIME types).
+    #   * For formats that are labeled **Required**, you must use the `Content-Type`
+    #   header with the request to specify the format of the audio.
+    #   * For all other formats, you can omit the `Content-Type` header or specify
+    #   `application/octet-stream` with the header to have the service automatically
+    #   detect the format of the audio. (With the `curl` command, you can specify either
+    #   `\"Content-Type:\"` or `\"Content-Type: application/octet-stream\"`.)
+    #
+    #   Where indicated, the format that you specify must include the sampling rate and
+    #   can optionally include the number of channels and the endianness of the audio.
+    #   * `audio/basic` (**Required.** Use only with narrowband models.)
     #   * `audio/flac`
-    #   * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of
-    #   channels (`channels`) and endianness (`endianness`) of the audio.)
+    #   * `audio/l16` (**Required.** Specify the sampling rate (`rate`) and optionally the
+    #   number of channels (`channels`) and endianness (`endianness`) of the audio.)
     #   * `audio/mp3`
     #   * `audio/mpeg`
-    #   * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.)
+    #   * `audio/mulaw` (**Required.** Specify the sampling rate (`rate`) of the audio.)
     #   * `audio/ogg` (The service automatically detects the codec of the input audio.)
     #   * `audio/ogg;codecs=opus`
     #   * `audio/ogg;codecs=vorbis`
@@ -200,6 +206,9 @@ module IBMWatson
     #   formats](https://console.bluemix.net/docs/services/speech-to-text/audio-formats.html).
     #
     #
+    #   **Note:** You must pass a content type when using any of the Watson SDKs. The SDKs
+    #   require the content-type parameter for all audio formats.
+    #
     #   ### Multipart speech recognition
     #
     #    The method also supports multipart recognition requests. With multipart requests,
@@ -214,15 +223,19 @@ module IBMWatson
     #
     #   **See also:** [Making a multipart HTTP
     #   request](https://console.bluemix.net/docs/services/speech-to-text/http.html#HTTP-multi).
-    # @param audio [String] The audio to transcribe in the format specified by the `Content-Type` header.
+    # @param audio [String] The audio to transcribe.
     # @param content_type [String] The type of the input.
     # @param model [String] The identifier of the model that is to be used for the recognition request.
-    # @param customization_id [String] The customization ID (GUID) of a custom language model that is to be used with the
+    # @param language_customization_id [String] The customization ID (GUID) of a custom language model that is to be used with the
     #   recognition request. The base model of the specified custom language model must
     #   match the model specified with the `model` parameter. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model. By default, no custom language model is used. See [Custom
     #   models](https://console.bluemix.net/docs/services/speech-to-text/input.html#custom).
+    #
+    #
+    #   **Note:** Use this parameter instead of the deprecated `customization_id`
+    #   parameter.
     # @param acoustic_customization_id [String] The customization ID (GUID) of a custom acoustic model that is to be used with the
     #   recognition request. The base model of the specified custom acoustic model must
     #   match the model specified with the `model` parameter. You must make the request
@@ -305,8 +318,11 @@ module IBMWatson
     #   method and check that the attribute `speaker_labels` is set to `true`. See
     #   [Speaker
     #   labels](https://console.bluemix.net/docs/services/speech-to-text/output.html#speaker_labels).
+    # @param customization_id [String] **Deprecated.** Use the `language_customization_id` parameter to specify the
+    #   customization ID (GUID) of a custom language model that is to be used with the
+    #   recognition request. Do not specify both parameters with a request.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def recognize(audio:, content_type:, model: nil, customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil)
+    def recognize(audio:, content_type:, model: nil, language_customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil, customization_id: nil)
       raise ArgumentError("audio must be provided") if audio.nil?
 
       raise ArgumentError("content_type must be provided") if content_type.nil?
@@ -316,7 +332,7 @@ module IBMWatson
       }
       params = {
         "model" => model,
-        "customization_id" => customization_id,
+        "language_customization_id" => language_customization_id,
         "acoustic_customization_id" => acoustic_customization_id,
         "base_model_version" => base_model_version,
         "customization_weight" => customization_weight,
@@ -329,7 +345,8 @@ module IBMWatson
         "timestamps" => timestamps,
         "profanity_filter" => profanity_filter,
         "smart_formatting" => smart_formatting,
-        "speaker_labels" => speaker_labels
+        "speaker_labels" => speaker_labels,
+        "customization_id" => customization_id
       }
       data = audio
       method_url = "/v1/recognize"
@@ -583,7 +600,7 @@ module IBMWatson
     end
 
     ##
-    # @!method create_job(audio:, content_type:, model: nil, callback_url: nil, events: nil, user_token: nil, results_ttl: nil, customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil)
+    # @!method create_job(audio:, content_type:, model: nil, callback_url: nil, events: nil, user_token: nil, results_ttl: nil, language_customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil, customization_id: nil)
     # Create a job.
     # Creates a job for a new asynchronous recognition request. The job is owned by the
     #   user whose service credentials are used to create it. How you learn the status and
@@ -641,16 +658,23 @@ module IBMWatson
     #
     #   ### Audio formats (content types)
     #
-    #    Use the `Content-Type` header to specify the audio format (MIME type) of the
-    #   audio. The service accepts the following formats, including specifying the
-    #   sampling rate, channels, and endianness where indicated.
-    #   * `audio/basic` (Use only with narrowband models.)
+    #    The service accepts audio in the following formats (MIME types).
+    #   * For formats that are labeled **Required**, you must use the `Content-Type`
+    #   header with the request to specify the format of the audio.
+    #   * For all other formats, you can omit the `Content-Type` header or specify
+    #   `application/octet-stream` with the header to have the service automatically
+    #   detect the format of the audio. (With the `curl` command, you can specify either
+    #   `\"Content-Type:\"` or `\"Content-Type: application/octet-stream\"`.)
+    #
+    #   Where indicated, the format that you specify must include the sampling rate and
+    #   can optionally include the number of channels and the endianness of the audio.
+    #   * `audio/basic` (**Required.** Use only with narrowband models.)
     #   * `audio/flac`
-    #   * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of
-    #   channels (`channels`) and endianness (`endianness`) of the audio.)
+    #   * `audio/l16` (**Required.** Specify the sampling rate (`rate`) and optionally the
+    #   number of channels (`channels`) and endianness (`endianness`) of the audio.)
     #   * `audio/mp3`
     #   * `audio/mpeg`
-    #   * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.)
+    #   * `audio/mulaw` (**Required.** Specify the sampling rate (`rate`) of the audio.)
     #   * `audio/ogg` (The service automatically detects the codec of the input audio.)
     #   * `audio/ogg;codecs=opus`
     #   * `audio/ogg;codecs=vorbis`
@@ -661,7 +685,11 @@ module IBMWatson
     #
     #   **See also:** [Audio
     #   formats](https://console.bluemix.net/docs/services/speech-to-text/audio-formats.html).
-    # @param audio [String] The audio to transcribe in the format specified by the `Content-Type` header.
+    #
+    #
+    #   **Note:** You must pass a content type when using any of the Watson SDKs. The SDKs
+    #   require the content-type parameter for all audio formats.
+    # @param audio [String] The audio to transcribe.
     # @param content_type [String] The type of the input.
     # @param model [String] The identifier of the model that is to be used for the recognition request.
     # @param callback_url [String] A URL to which callback notifications are to be sent. The URL must already be
@@ -698,12 +726,16 @@ module IBMWatson
     #   finished. If not delivered via a callback, the results must be retrieved within
     #   this time. Omit the parameter to use a time to live of one week. The parameter is
     #   valid with or without a callback URL.
-    # @param customization_id [String] The customization ID (GUID) of a custom language model that is to be used with the
+    # @param language_customization_id [String] The customization ID (GUID) of a custom language model that is to be used with the
     #   recognition request. The base model of the specified custom language model must
     #   match the model specified with the `model` parameter. You must make the request
     #   with service credentials created for the instance of the service that owns the
     #   custom model. By default, no custom language model is used. See [Custom
     #   models](https://console.bluemix.net/docs/services/speech-to-text/input.html#custom).
+    #
+    #
+    #   **Note:** Use this parameter instead of the deprecated `customization_id`
+    #   parameter.
     # @param acoustic_customization_id [String] The customization ID (GUID) of a custom acoustic model that is to be used with the
     #   recognition request. The base model of the specified custom acoustic model must
     #   match the model specified with the `model` parameter. You must make the request
@@ -786,8 +818,11 @@ module IBMWatson
     #   method and check that the attribute `speaker_labels` is set to `true`. See
     #   [Speaker
     #   labels](https://console.bluemix.net/docs/services/speech-to-text/output.html#speaker_labels).
+    # @param customization_id [String] **Deprecated.** Use the `language_customization_id` parameter to specify the
+    #   customization ID (GUID) of a custom language model that is to be used with the
+    #   recognition request. Do not specify both parameters with a request.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def create_job(audio:, content_type:, model: nil, callback_url: nil, events: nil, user_token: nil, results_ttl: nil, customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil)
+    def create_job(audio:, content_type:, model: nil, callback_url: nil, events: nil, user_token: nil, results_ttl: nil, language_customization_id: nil, acoustic_customization_id: nil, base_model_version: nil, customization_weight: nil, inactivity_timeout: nil, keywords: nil, keywords_threshold: nil, max_alternatives: nil, word_alternatives_threshold: nil, word_confidence: nil, timestamps: nil, profanity_filter: nil, smart_formatting: nil, speaker_labels: nil, customization_id: nil)
       raise ArgumentError("audio must be provided") if audio.nil?
 
       raise ArgumentError("content_type must be provided") if content_type.nil?
@@ -801,7 +836,7 @@ module IBMWatson
         "events" => events,
         "user_token" => user_token,
         "results_ttl" => results_ttl,
-        "customization_id" => customization_id,
+        "language_customization_id" => language_customization_id,
         "acoustic_customization_id" => acoustic_customization_id,
         "base_model_version" => base_model_version,
         "customization_weight" => customization_weight,
@@ -814,7 +849,8 @@ module IBMWatson
         "timestamps" => timestamps,
         "profanity_filter" => profanity_filter,
         "smart_formatting" => smart_formatting,
-        "speaker_labels" => speaker_labels
+        "speaker_labels" => speaker_labels,
+        "customization_id" => customization_id
       }
       data = audio
       method_url = "/v1/recognitions"
@@ -873,7 +909,7 @@ module IBMWatson
     #
     #   **See also:** [Checking the status and retrieving the results of a
     #   job](https://console.bluemix.net/docs/services/speech-to-text/async.html#job).
-    # @param id [String] The ID of the asynchronous job.
+    # @param id [String] The identifier of the asynchronous job that is to be used for the request.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def check_job(id:)
       raise ArgumentError("id must be provided") if id.nil?
@@ -901,7 +937,7 @@ module IBMWatson
     #
     #   **See also:** [Deleting a
     #   job](https://console.bluemix.net/docs/services/speech-to-text/async.html#delete).
-    # @param id [String] The ID of the asynchronous job.
+    # @param id [String] The identifier of the asynchronous job that is to be used for the request.
     # @return [nil]
     def delete_job(id:)
       raise ArgumentError("id must be provided") if id.nil?
@@ -1020,9 +1056,9 @@ module IBMWatson
     #
     #   **See also:** [Listing custom language
     #   models](https://console.bluemix.net/docs/services/speech-to-text/language-models.html#listModels).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_language_model(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1049,9 +1085,9 @@ module IBMWatson
     #
     #   **See also:** [Deleting a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-models.html#deleteModel).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [nil]
     def delete_language_model(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1100,9 +1136,9 @@ module IBMWatson
     #
     #   **See also:** [Train the custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-create.html#trainModel).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param word_type_to_add [String] The type of words from the custom language model's words resource on which to
     #   train the model:
     #   * `all` (the default) trains the model on all new words, regardless of whether
@@ -1155,9 +1191,9 @@ module IBMWatson
     #
     #   **See also:** [Resetting a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-models.html#resetModel).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [nil]
     def reset_language_model(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1195,9 +1231,9 @@ module IBMWatson
     #
     #   **See also:** [Upgrading a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/custom-upgrade.html#upgradeLanguage).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [nil]
     def upgrade_language_model(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1227,9 +1263,9 @@ module IBMWatson
     #
     #   **See also:** [Listing corpora for a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-corpora.html#listCorpora).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_corpora(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1293,9 +1329,9 @@ module IBMWatson
     #   corpora](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#workingCorpora)
     #   * [Add corpora to the custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-create.html#addCorpora).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param corpus_name [String] The name of the new corpus for the custom language model. Use a localized name
     #   that matches the language of the custom model and reflects the contents of the
     #   corpus.
@@ -1306,8 +1342,8 @@ module IBMWatson
     #   words that are added or modified by the user.
     # @param corpus_file [File] A plain text file that contains the training data for the corpus. Encode the file
     #   in UTF-8 if it contains non-ASCII characters; the service assumes UTF-8 encoding
-    #   if it encounters non-ASCII characters. With cURL, use the `--data-binary` option
-    #   to upload the file for the request.
+    #   if it encounters non-ASCII characters. With the `curl` command, use the
+    #   `--data-binary` option to upload the file for the request.
     # @param allow_overwrite [Boolean] If `true`, the specified corpus or audio resource overwrites an existing corpus or
     #   audio resource with the same name. If `false`, the request fails if a corpus or
     #   audio resource with the same name already exists. The parameter has no effect if a
@@ -1359,9 +1395,9 @@ module IBMWatson
     #
     #   **See also:** [Listing corpora for a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-corpora.html#listCorpora).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param corpus_name [String] The name of the corpus for the custom language model.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_corpus(customization_id:, corpus_name:)
@@ -1394,9 +1430,9 @@ module IBMWatson
     #
     #   **See also:** [Deleting a corpus from a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-corpora.html#deleteCorpus).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param corpus_name [String] The name of the corpus for the custom language model.
     # @return [nil]
     def delete_corpus(customization_id:, corpus_name:)
@@ -1432,9 +1468,9 @@ module IBMWatson
     #
     #   **See also:** [Listing words from a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-words.html#listWords).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param word_type [String] The type of words to be listed from the custom language model's words resource:
     #   * `all` (the default) shows all words.
     #   * `user` shows only custom words that were added or modified by the user.
@@ -1445,7 +1481,7 @@ module IBMWatson
     #   are sorted in ascending alphabetical order. For alphabetical ordering, the
     #   lexicographical precedence is numeric values, uppercase letters, and lowercase
     #   letters. For count ordering, values with the same count are ordered
-    #   alphabetically. With cURL, URL encode the `+` symbol as `%2B`.
+    #   alphabetically. With the `curl` command, URL encode the `+` symbol as `%2B`.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_words(customization_id:, word_type: nil, sort: nil)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1527,9 +1563,9 @@ module IBMWatson
     #   words](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#workingWords)
     #   * [Add words to the custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-create.html#addWords).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param words [Array[CustomWord]] An array of objects that provides information about each custom word that is to be
     #   added to or updated in the custom language model.
     # @return [nil]
@@ -1595,9 +1631,9 @@ module IBMWatson
     #   words](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#workingWords)
     #   * [Add words to the custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-create.html#addWords).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param word_name [String] The custom word for the custom language model. When you add or update a custom
     #   word with the **Add a custom word** method, do not include spaces in the word. Use
     #   a `-` (dash) or `_` (underscore) to connect the tokens of compound words.
@@ -1654,9 +1690,9 @@ module IBMWatson
     #
     #   **See also:** [Listing words from a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-words.html#listWords).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param word_name [String] The custom word for the custom language model. When you add or update a custom
     #   word with the **Add a custom word** method, do not include spaces in the word. Use
     #   a `-` (dash) or `_` (underscore) to connect the tokens of compound words.
@@ -1691,9 +1727,9 @@ module IBMWatson
     #
     #   **See also:** [Deleting a word from a custom language
     #   model](https://console.bluemix.net/docs/services/speech-to-text/language-words.html#deleteWord).
-    # @param customization_id [String] The customization ID (GUID) of the custom language model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom language model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param word_name [String] The custom word for the custom language model. When you add or update a custom
     #   word with the **Add a custom word** method, do not include spaces in the word. Use
     #   a `-` (dash) or `_` (underscore) to connect the tokens of compound words.
@@ -1804,9 +1840,9 @@ module IBMWatson
     #
     #   **See also:** [Listing custom acoustic
     #   models](https://console.bluemix.net/docs/services/speech-to-text/acoustic-models.html#listModels).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_acoustic_model(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1833,9 +1869,9 @@ module IBMWatson
     #
     #   **See also:** [Deleting a custom acoustic
     #   model](https://console.bluemix.net/docs/services/speech-to-text/acoustic-models.html#deleteModel).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [nil]
     def delete_acoustic_model(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1894,9 +1930,9 @@ module IBMWatson
     #
     #   **See also:** [Train the custom acoustic
     #   model](https://console.bluemix.net/docs/services/speech-to-text/acoustic-create.html#trainModel).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param custom_language_model_id [String] The customization ID (GUID) of a custom language model that is to be used during
     #   training of the custom acoustic model. Specify a custom language model that has
     #   been trained with verbatim transcriptions of the audio resources or that contains
@@ -1932,9 +1968,9 @@ module IBMWatson
     #
     #   **See also:** [Resetting a custom acoustic
     #   model](https://console.bluemix.net/docs/services/speech-to-text/acoustic-models.html#resetModel).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [nil]
     def reset_acoustic_model(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -1979,9 +2015,9 @@ module IBMWatson
     #
     #   **See also:** [Upgrading a custom acoustic
     #   model](https://console.bluemix.net/docs/services/speech-to-text/custom-upgrade.html#upgradeAcoustic).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param custom_language_model_id [String] If the custom acoustic model was trained with a custom language model, the
     #   customization ID (GUID) of that custom language model. The custom language model
     #   must be upgraded before the custom acoustic model can be upgraded.
@@ -2020,9 +2056,9 @@ module IBMWatson
     #
     #   **See also:** [Listing audio resources for a custom acoustic
     #   model](https://console.bluemix.net/docs/services/speech-to-text/acoustic-audio.html#listAudio).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_audio(customization_id:)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?
@@ -2139,9 +2175,9 @@ module IBMWatson
     #   * Do not include spaces, slashes, or backslashes in the file name.
     #   * Do not use the name of an audio file that has already been added to the custom
     #   model as part of an archive-type resource.
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param audio_name [String] The name of the new audio resource for the custom acoustic model. Use a localized
     #   name that matches the language of the custom model and reflects the contents of
     #   the resource.
@@ -2217,9 +2253,9 @@ module IBMWatson
     #
     #   **See also:** [Listing audio resources for a custom acoustic
     #   model](https://console.bluemix.net/docs/services/speech-to-text/acoustic-audio.html#listAudio).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param audio_name [String] The name of the audio resource for the custom acoustic model.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_audio(customization_id:, audio_name:)
@@ -2252,9 +2288,9 @@ module IBMWatson
     #
     #   **See also:** [Deleting an audio resource from a custom acoustic
     #   model](https://console.bluemix.net/docs/services/speech-to-text/acoustic-audio.html#deleteAudio).
-    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model. You must make the
-    #   request with service credentials created for the instance of the service that owns
-    #   the custom model.
+    # @param customization_id [String] The customization ID (GUID) of the custom acoustic model that is to be used for
+    #   the request. You must make the request with service credentials created for the
+    #   instance of the service that owns the custom model.
     # @param audio_name [String] The name of the audio resource for the custom acoustic model.
     # @return [nil]
     def delete_audio(customization_id:, audio_name:)

data/lib/ibm_watson/version.rb

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

data/test/unit/test_discovery_v1.rb

@@ -906,6 +906,63 @@ class DiscoveryV1Test < Minitest::Test
     assert_nil(service_response)
   end
 
+  def test_tokenization_dictionary
+    service = IBMWatson::DiscoveryV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-03-05"
+    )
+    stub_request(:get, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/collid/word_lists/tokenization_dictionary?version=2018-03-05")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { tokenization_dictionary: "results" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_tokenization_dictionary_status(
+      environment_id: "envid",
+      collection_id: "collid"
+    )
+    assert_equal({ "tokenization_dictionary" => "results" }, service_response.result)
+
+    stub_request(:post, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/collid/word_lists/tokenization_dictionary?version=2018-03-05")
+      .with(
+        body: "{\"tokenization_rules\":[{\"rule1\":\"messi\",\"rule2\":\"ronaldo\"}]}",
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { discription: "success" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.create_tokenization_dictionary(
+      environment_id: "envid",
+      collection_id: "collid",
+      tokenization_rules: [
+        {
+          "rule1" => "messi",
+          "rule2" => "ronaldo"
+        }
+      ]
+    )
+    assert_equal({ "discription" => "success" }, service_response.result)
+
+    stub_request(:delete, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/collid/word_lists/tokenization_dictionary?version=2018-03-05")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { description: "success" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.delete_tokenization_dictionary(
+      environment_id: "envid",
+      collection_id: "collid"
+    )
+    assert_nil(service_response)
+  end
+
   def test_delete_user_data
     service = IBMWatson::DiscoveryV1.new(
       username: "username",
@@ -955,7 +1012,7 @@ class DiscoveryV1Test < Minitest::Test
     )
     stub_request(:post, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/query?&version=2018-03-05")
       .with(
-        body:  "{\"collection_ids\":[\"collid\"]}",
+        body: "{\"collection_ids\":[\"collid\"]}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",

metadata

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