ibm_watson 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e5497c0b4d5432eeebd77445b2563795c103cd37eb7110d6405c28658d10ffa
-  data.tar.gz: 0ff12a91d90c19d074672665a2539ed5a9a4b2bafd0922e613d0e4121441be67
+  metadata.gz: 1f867b01332162f178deb7bb0382b95c2dc90254ff079f840b3fb64f6c8b2102
+  data.tar.gz: f5ede7a5fe4313e2e921ad7bac8700be471d250b89c3f03ad5b18c891d0feae1
 SHA512:
-  metadata.gz: 734634cbd63a3a5b3dda1e4fa6b77ba8285f7c493d4b8c107abd2119e4564b42e96eff6af4387da504c83ae2697a8a13fef8ade200e80d6b7d6142ce2fd334ef
-  data.tar.gz: 42d4aca1005a5a614411d10d0c8ca50d3227558f3cb9d9490fdb8386737850c0e490dbab6b8bf02a3581f4c927f657dba08575bfb99fdd6fdf91ff3c2a431a19
+  metadata.gz: 732f0fa20dfe3c4d29b48cb6cfcb6574eaac7188bf8b496af4e103a50ea258c3accef20f627b0e9a9e76d75e1dc7eed24511b81cfb47848a121d939403e92981
+  data.tar.gz: 812d8afe21c7076c9ad8f9009ea2627621dbc0c179d825f5d34a9abda2ec5d0ae13aad11102ffa341e644b4d5b490b56954010943072c49b7549ab1ef425320b

data/README.md

@@ -249,7 +249,7 @@ assistant.configure_http_client(
 
 ## Using Websockets
 
-The Speech-to-Text service supports websockets with the `recognize-with-websockets` method. The method accepts a custom callback class. The `eventmachine` loop that the websocket uses blocks the main thread by default. Here is an example of using the websockets method:
+The Speech-to-Text service supports websockets with the `recognize_using_websocket` method. The method accepts a custom callback class. The `eventmachine` loop that the websocket uses blocks the main thread by default. Here is an example of using the websockets method:
 
 ```ruby
 require "ibm_watson"
@@ -260,7 +260,7 @@ speech_to_text = IBMWatson::SpeechToTextV1.new(
   username: "<username>",
   password: "<password>"
 )
-websocket = speech_to_text.recognize_with_websocket(
+websocket = speech_to_text.recognize_using_websocket(
   audio: audio_file,
   recognize_callback: callback,
   interim_results: true
@@ -271,6 +271,7 @@ thr = Thread.new do # Start the websocket inside of a thread
 end
 thr.join # Wait for the thread to finish before ending the program or running other code
 ```
+Note: `recognize_with_websocket` has been **deprecated** in favor of **`recognize_using_websocket`**
 
 ## Ruby version
 

data/lib/ibm_watson/assistant_v1.rb

@@ -255,7 +255,7 @@ module IBMWatson
     end
 
     ##
-    # @!method create_workspace(name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil)
+    # @!method create_workspace(name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil)
     # Create workspace.
     # Create a workspace based on component objects. You must provide workspace
     #   components defining the content of the new workspace.
@@ -275,8 +275,9 @@ module IBMWatson
     # @param metadata [Object] Any metadata related to the workspace.
     # @param learning_opt_out [Boolean] Whether training data from the workspace can be used by IBM for general service
     #   improvements. `true` indicates that workspace training data is not to be used.
+    # @param system_settings [WorkspaceSystemSettings] Global settings for the workspace.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def create_workspace(name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil)
+    def create_workspace(name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil)
       headers = {
       }
       params = {
@@ -291,7 +292,8 @@ module IBMWatson
         "dialog_nodes" => dialog_nodes,
         "counterexamples" => counterexamples,
         "metadata" => metadata,
-        "learning_opt_out" => learning_opt_out
+        "learning_opt_out" => learning_opt_out,
+        "system_settings" => system_settings
       }
       method_url = "/v1/workspaces"
       response = request(
@@ -341,7 +343,7 @@ module IBMWatson
     end
 
     ##
-    # @!method update_workspace(workspace_id:, name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, append: nil)
+    # @!method update_workspace(workspace_id:, name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, append: nil)
     # Update workspace.
     # Update an existing workspace with new or modified data. You must provide component
     #   objects defining the content of the updated workspace.
@@ -362,6 +364,7 @@ module IBMWatson
     # @param metadata [Object] Any metadata related to the workspace.
     # @param learning_opt_out [Boolean] Whether training data from the workspace can be used by IBM for general service
     #   improvements. `true` indicates that workspace training data is not to be used.
+    # @param system_settings [WorkspaceSystemSettings] Global settings for the workspace.
     # @param append [Boolean] Whether the new data is to be appended to the existing data in the workspace. If
     #   **append**=`false`, elements included in the new data completely replace the
     #   corresponding existing elements, including all subelements. For example, if the
@@ -372,7 +375,7 @@ module IBMWatson
     #   added. If any elements in the new data collide with existing elements, the update
     #   request fails.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def update_workspace(workspace_id:, name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, append: nil)
+    def update_workspace(workspace_id:, name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, append: nil)
       raise ArgumentError("workspace_id must be provided") if workspace_id.nil?
       headers = {
       }
@@ -389,7 +392,8 @@ module IBMWatson
         "dialog_nodes" => dialog_nodes,
         "counterexamples" => counterexamples,
         "metadata" => metadata,
-        "learning_opt_out" => learning_opt_out
+        "learning_opt_out" => learning_opt_out,
+        "system_settings" => system_settings
       }
       method_url = "/v1/workspaces/%s" % [ERB::Util.url_encode(workspace_id)]
       response = request(
@@ -635,7 +639,8 @@ module IBMWatson
     ##
     # @!method list_examples(workspace_id:, intent:, page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
     # List user input examples.
-    # List the user input examples for an intent.
+    # List the user input examples for an intent, optionally including contextual entity
+    #   mentions.
     #
     #   This operation is limited to 2500 requests per 30 minutes. For more information,
     #   see **Rate limiting**.
@@ -675,7 +680,7 @@ module IBMWatson
     end
 
     ##
-    # @!method create_example(workspace_id:, intent:, text:)
+    # @!method create_example(workspace_id:, intent:, text:, mentions: nil)
     # Create user input example.
     # Add a new user input example to an intent.
     #
@@ -688,8 +693,9 @@ module IBMWatson
     #   - It cannot contain carriage return, newline, or tab characters.
     #   - It cannot consist of only whitespace characters.
     #   - It must be no longer than 1024 characters.
+    # @param mentions [Array[Mentions]] An array of contextual entity mentions.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def create_example(workspace_id:, intent:, text:)
+    def create_example(workspace_id:, intent:, text:, mentions: nil)
       raise ArgumentError("workspace_id must be provided") if workspace_id.nil?
       raise ArgumentError("intent must be provided") if intent.nil?
       raise ArgumentError("text must be provided") if text.nil?
@@ -699,7 +705,8 @@ module IBMWatson
         "version" => @version
       }
       data = {
-        "text" => text
+        "text" => text,
+        "mentions" => mentions
       }
       method_url = "/v1/workspaces/%s/intents/%s/examples" % [ERB::Util.url_encode(workspace_id), ERB::Util.url_encode(intent)]
       response = request(
@@ -748,7 +755,7 @@ module IBMWatson
     end
 
     ##
-    # @!method update_example(workspace_id:, intent:, text:, new_text: nil)
+    # @!method update_example(workspace_id:, intent:, text:, new_text: nil, new_mentions: nil)
     # Update user input example.
     # Update the text of a user input example.
     #
@@ -762,8 +769,9 @@ module IBMWatson
     #   - It cannot contain carriage return, newline, or tab characters.
     #   - It cannot consist of only whitespace characters.
     #   - It must be no longer than 1024 characters.
+    # @param new_mentions [Array[Mentions]] An array of contextual entity mentions.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def update_example(workspace_id:, intent:, text:, new_text: nil)
+    def update_example(workspace_id:, intent:, text:, new_text: nil, new_mentions: nil)
       raise ArgumentError("workspace_id must be provided") if workspace_id.nil?
       raise ArgumentError("intent must be provided") if intent.nil?
       raise ArgumentError("text must be provided") if text.nil?
@@ -773,7 +781,8 @@ module IBMWatson
         "version" => @version
       }
       data = {
-        "text" => new_text
+        "text" => new_text,
+        "mentions" => new_mentions
       }
       method_url = "/v1/workspaces/%s/intents/%s/examples/%s" % [ERB::Util.url_encode(workspace_id), ERB::Util.url_encode(intent), ERB::Util.url_encode(text)]
       response = request(
@@ -1204,6 +1213,46 @@ module IBMWatson
       nil
     end
     #########################
+    # Mentions
+    #########################
+
+    ##
+    # @!method list_mentions(workspace_id:, entity:, export: nil, include_audit: nil)
+    # List entity mentions.
+    # List mentions for a contextual entity. An entity mention is an occurrence of a
+    #   contextual entity in the context of an intent user input example.
+    #
+    #   This operation is limited to 200 requests per 30 minutes. For more information,
+    #   see **Rate limiting**.
+    # @param workspace_id [String] Unique identifier of the workspace.
+    # @param entity [String] The name of the entity.
+    # @param export [Boolean] Whether to include all element content in the returned data. If
+    #   **export**=`false`, the returned data includes only information about the element
+    #   itself. If **export**=`true`, all content, including subelements, is included.
+    # @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
+    #   the response.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def list_mentions(workspace_id:, entity:, export: nil, include_audit: nil)
+      raise ArgumentError("workspace_id must be provided") if workspace_id.nil?
+      raise ArgumentError("entity must be provided") if entity.nil?
+      headers = {
+      }
+      params = {
+        "version" => @version,
+        "export" => export,
+        "include_audit" => include_audit
+      }
+      method_url = "/v1/workspaces/%s/entities/%s/mentions" % [ERB::Util.url_encode(workspace_id), ERB::Util.url_encode(entity)]
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+    #########################
     # Values
     #########################
 
@@ -1677,7 +1726,7 @@ module IBMWatson
     end
 
     ##
-    # @!method create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, actions: nil, title: nil, node_type: nil, event_name: nil, variable: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil)
+    # @!method create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, actions: nil, title: nil, node_type: nil, event_name: nil, variable: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil, user_label: nil)
     # Create dialog node.
     # Create a new dialog node.
     #
@@ -1695,7 +1744,7 @@ module IBMWatson
     #   characters.
     # @param parent [String] The ID of the parent dialog node.
     # @param previous_sibling [String] The ID of the previous dialog node.
-    # @param output [Object] The output of the dialog node. For more information about how to specify dialog
+    # @param output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
     #   node output, see the
     #   [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex).
     # @param context [Object] The context for the dialog node.
@@ -1713,8 +1762,10 @@ module IBMWatson
     # @param digress_in [String] Whether this top-level dialog node can be digressed into.
     # @param digress_out [String] Whether this dialog node can be returned to after a digression.
     # @param digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
+    # @param user_label [String] A label that can be displayed externally to describe the purpose of the node to
+    #   users.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, actions: nil, title: nil, node_type: nil, event_name: nil, variable: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil)
+    def create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, actions: nil, title: nil, node_type: nil, event_name: nil, variable: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil, user_label: nil)
       raise ArgumentError("workspace_id must be provided") if workspace_id.nil?
       raise ArgumentError("dialog_node must be provided") if dialog_node.nil?
       headers = {
@@ -1739,7 +1790,8 @@ module IBMWatson
         "variable" => variable,
         "digress_in" => digress_in,
         "digress_out" => digress_out,
-        "digress_out_slots" => digress_out_slots
+        "digress_out_slots" => digress_out_slots,
+        "user_label" => user_label
       }
       method_url = "/v1/workspaces/%s/dialog_nodes" % [ERB::Util.url_encode(workspace_id)]
       response = request(
@@ -1786,7 +1838,7 @@ module IBMWatson
     end
 
     ##
-    # @!method update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil)
+    # @!method update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil, new_user_label: nil)
     # Update dialog node.
     # Update an existing dialog node with new or modified data.
     #
@@ -1805,7 +1857,7 @@ module IBMWatson
     #   characters.
     # @param new_parent [String] The ID of the parent dialog node.
     # @param new_previous_sibling [String] The ID of the previous sibling dialog node.
-    # @param new_output [Object] The output of the dialog node. For more information about how to specify dialog
+    # @param new_output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
     #   node output, see the
     #   [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex).
     # @param new_context [Object] The context for the dialog node.
@@ -1823,8 +1875,10 @@ module IBMWatson
     # @param new_digress_in [String] Whether this top-level dialog node can be digressed into.
     # @param new_digress_out [String] Whether this dialog node can be returned to after a digression.
     # @param new_digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
+    # @param new_user_label [String] A label that can be displayed externally to describe the purpose of the node to
+    #   users.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil)
+    def update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil, new_user_label: nil)
       raise ArgumentError("workspace_id must be provided") if workspace_id.nil?
       raise ArgumentError("dialog_node must be provided") if dialog_node.nil?
       headers = {
@@ -1849,7 +1903,8 @@ module IBMWatson
         "actions" => new_actions,
         "digress_in" => new_digress_in,
         "digress_out" => new_digress_out,
-        "digress_out_slots" => new_digress_out_slots
+        "digress_out_slots" => new_digress_out_slots,
+        "user_label" => new_user_label
       }
       method_url = "/v1/workspaces/%s/dialog_nodes/%s" % [ERB::Util.url_encode(workspace_id), ERB::Util.url_encode(dialog_node)]
       response = request(

data/lib/ibm_watson/discovery_v1.rb

@@ -1072,7 +1072,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, return_fields: 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)
+    # @!method query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, return_fields: 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, logging_opt_out: nil)
     # Query your collection.
     # After your content is uploaded and enriched by the Discovery service, you can
     #   build queries to search your content. For details, see the [Discovery service
@@ -1130,11 +1130,13 @@ module IBMWatson
     # @param similar_fields [Array[String]] A comma-separated list of field names that will be used as a basis for comparison
     #   to identify similar documents. If not specified, the entire document is used for
     #   comparison.
+    # @param logging_opt_out [Boolean] If `true`, queries are not stored in the Discovery **Logs** endpoint.
     # @return [DetailedResponse] A `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_fields: 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)
+    def query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, return_fields: 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, logging_opt_out: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
       headers = {
+        "X-Watson-Logging-Opt-Out" => logging_opt_out
       }
       params = {
         "version" => @version,

data/lib/ibm_watson/speech_to_text_v1.rb

@@ -349,35 +349,36 @@ module IBMWatson
     #   useful for stopping audio submission from a live microphone when a user simply
     #   walks away. Use `-1` for infinity.
     # @param keywords [Array[String]] An array of keyword strings to spot in the audio. Each keyword string can include
-    #   one or more tokens. Keywords are spotted only in the final results, not in interim
-    #   hypotheses. If you specify any keywords, you must also specify a keywords
+    #   one or more string tokens. Keywords are spotted only in the final results, not in
+    #   interim hypotheses. If you specify any keywords, you must also specify a keywords
     #   threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify
     #   an empty array if you do not need to spot keywords.
     # @param keywords_threshold [Float] A confidence value that is the lower bound for spotting a keyword. A word is
     #   considered to match a keyword if its confidence is greater than or equal to the
-    #   threshold. Specify a probability between 0 and 1 inclusive. No keyword spotting is
+    #   threshold. Specify a probability between 0.0 and 1.0. No keyword spotting is
     #   performed if you omit the parameter. If you specify a threshold, you must also
     #   specify one or more keywords.
-    # @param max_alternatives [Fixnum] The maximum number of alternative transcripts to be returned. By default, a single
-    #   transcription is returned.
+    # @param max_alternatives [Fixnum] The maximum number of alternative transcripts that the service is to return. By
+    #   default, a single transcription is returned.
     # @param word_alternatives_threshold [Float] A confidence value that is the lower bound for identifying a hypothesis as a
     #   possible word alternative (also known as \"Confusion Networks\"). An alternative
     #   word is considered if its confidence is greater than or equal to the threshold.
-    #   Specify a probability between 0 and 1 inclusive. No alternative words are computed
-    #   if you omit the parameter.
-    # @param word_confidence [Boolean] If `true`, a confidence measure in the range of 0 to 1 is returned for each word.
-    #   By default, no word confidence measures are returned.
-    # @param timestamps [Boolean] If `true`, time alignment is returned for each word. By default, no timestamps are
-    #   returned.
-    # @param profanity_filter [Boolean] If `true` (the default), filters profanity from all output except for keyword
+    #   Specify a probability between 0.0 and 1.0. No alternative words are computed if
+    #   you omit the parameter.
+    # @param word_confidence [Boolean] If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for
+    #   each word. By default, no word confidence measures are returned.
+    # @param timestamps [Boolean] If `true`, the service returns time alignment for each word. By default, no
+    #   timestamps are returned.
+    # @param profanity_filter [Boolean] If `true`, the service filters profanity from all output except for keyword
     #   results by replacing inappropriate words with a series of asterisks. Set the
     #   parameter to `false` to return results with no censoring. Applies to US English
     #   transcription only.
-    # @param smart_formatting [Boolean] If `true`, converts dates, times, series of digits and numbers, phone numbers,
-    #   currency values, and internet addresses into more readable, conventional
+    # @param smart_formatting [Boolean] If `true`, the service converts dates, times, series of digits and numbers, phone
+    #   numbers, currency values, and internet addresses into more readable, conventional
     #   representations in the final transcript of a recognition request. For US English,
-    #   also converts certain keyword strings to punctuation symbols. By default, no smart
-    #   formatting is performed. Applies to US English and Spanish transcription only.
+    #   the service also converts certain keyword strings to punctuation symbols. By
+    #   default, no smart formatting is performed. Applies to US English and Spanish
+    #   transcription only.
     # @param speaker_labels [Boolean] If `true`, the response includes labels that identify which words were spoken by
     #   which participants in a multi-person exchange. By default, no speaker labels are
     #   returned. Setting `speaker_labels` to `true` forces the `timestamps` parameter to
@@ -425,7 +426,7 @@ module IBMWatson
     end
 
     ##
-    # @!method recognize_with_websocket(audio: nil,chunk_data: false,content_type: "audio/l16; rate=44100",model: "en-US_BroadbandModel",recognize_callback: nil,customization_id: nil,acoustic_customization_id: nil,customization_weight: nil,version: nil,inactivity_timeout: 30,interim_results: false,keywords: nil,keywords_threshold: nil,max_alternatives: 1,word_alternatives_threshold: nil,word_confidence: false,timestamps: false,profanity_filter: nil,smart_formatting: false,speaker_labels: nil)
+    # @!method recognize_using_websocket(audio: nil,chunk_data: false,content_type: "audio/l16; rate=44100",model: "en-US_BroadbandModel",recognize_callback: nil,customization_id: nil,acoustic_customization_id: nil,customization_weight: nil,version: nil,inactivity_timeout: 30,interim_results: false,keywords: nil,keywords_threshold: nil,max_alternatives: 1,word_alternatives_threshold: nil,word_confidence: false,timestamps: false,profanity_filter: nil,smart_formatting: false,speaker_labels: nil)
     # Sends audio for speech recognition using web sockets.
     # @param audio [IO] Audio to transcribe in the format specified by the `Content-Type` header.
     # @param chunk_data [Boolean] If true, then the WebSocketClient will expect to receive data in chunks rather than as a single audio file
@@ -448,7 +449,7 @@ module IBMWatson
     # @param smart_formatting [Boolean] If `true`, converts dates, times, series of digits and numbers, phone numbers, currency values, and Internet addresses into more readable, conventional representations in the final transcript of a recognition request. If `false` (the default), no formatting is performed. Applies to US English transcription only.
     # @param speaker_labels [Boolean] Indicates whether labels that identify which words were spoken by which participants in a multi-person exchange are to be included in the response. The default is `false`; no speaker labels are returned. Setting `speaker_labels` to `true` forces the `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter.   To determine whether a language model supports speaker labels, use the `GET /v1/models` method and check that the attribute `speaker_labels` is set to `true`. You can also refer to [Speaker labels](https://console.bluemix.net/docs/services/speech-to-text/output.html#speaker_labels).
     # @return [WebSocketClient] Returns a new WebSocketClient object
-    def recognize_with_websocket(
+    def recognize_using_websocket(
       audio: nil,
       chunk_data: false,
       content_type: "audio/l16; rate=44100",
@@ -509,6 +510,56 @@ module IBMWatson
       options.delete_if { |_, v| v.nil? }
       WebSocketClient.new(audio: audio, chunk_data: chunk_data, options: options, recognize_callback: recognize_callback, url: url, headers: headers)
     end
+
+    # :nocov:
+    # @deprecated This will method be removed in the next major release. Use {#recognize_using_websocket} instead.
+    def recognize_with_websocket(
+      audio: nil,
+      chunk_data: false,
+      content_type: "audio/l16; rate=44100",
+      model: "en-US_BroadbandModel",
+      recognize_callback: nil,
+      customization_id: nil,
+      acoustic_customization_id: nil,
+      customization_weight: nil,
+      version: nil,
+      inactivity_timeout: 30,
+      interim_results: false,
+      keywords: nil,
+      keywords_threshold: nil,
+      max_alternatives: 1,
+      word_alternatives_threshold: nil,
+      word_confidence: false,
+      timestamps: false,
+      profanity_filter: nil,
+      smart_formatting: false,
+      speaker_labels: nil
+    )
+      Kernel.warn("[DEPRECATION] `recognize_with_websocket` is deprecated and will be removed in the next major release. Please use `recognize_using_websocket` instead.")
+      recognize_using_websocket(
+        audio: audio,
+        chunk_data: chunk_data,
+        content_type: content_type,
+        model: model,
+        recognize_callback: recognize_callback,
+        customization_id: customization_id,
+        acoustic_customization_id: acoustic_customization_id,
+        customization_weight: customization_weight,
+        version: version,
+        inactivity_timeout: inactivity_timeout,
+        interim_results: interim_results,
+        keywords: keywords,
+        keywords_threshold: keywords_threshold,
+        max_alternatives: max_alternatives,
+        word_alternatives_threshold: word_alternatives_threshold,
+        word_confidence: word_confidence,
+        timestamps: timestamps,
+        profanity_filter: profanity_filter,
+        smart_formatting: smart_formatting,
+        speaker_labels: speaker_labels
+      )
+    end
+    # :nocov:
     #########################
     # Asynchronous
     #########################
@@ -744,35 +795,36 @@ module IBMWatson
     #   useful for stopping audio submission from a live microphone when a user simply
     #   walks away. Use `-1` for infinity.
     # @param keywords [Array[String]] An array of keyword strings to spot in the audio. Each keyword string can include
-    #   one or more tokens. Keywords are spotted only in the final results, not in interim
-    #   hypotheses. If you specify any keywords, you must also specify a keywords
+    #   one or more string tokens. Keywords are spotted only in the final results, not in
+    #   interim hypotheses. If you specify any keywords, you must also specify a keywords
     #   threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify
     #   an empty array if you do not need to spot keywords.
     # @param keywords_threshold [Float] A confidence value that is the lower bound for spotting a keyword. A word is
     #   considered to match a keyword if its confidence is greater than or equal to the
-    #   threshold. Specify a probability between 0 and 1 inclusive. No keyword spotting is
+    #   threshold. Specify a probability between 0.0 and 1.0. No keyword spotting is
     #   performed if you omit the parameter. If you specify a threshold, you must also
     #   specify one or more keywords.
-    # @param max_alternatives [Fixnum] The maximum number of alternative transcripts to be returned. By default, a single
-    #   transcription is returned.
+    # @param max_alternatives [Fixnum] The maximum number of alternative transcripts that the service is to return. By
+    #   default, a single transcription is returned.
     # @param word_alternatives_threshold [Float] A confidence value that is the lower bound for identifying a hypothesis as a
     #   possible word alternative (also known as \"Confusion Networks\"). An alternative
     #   word is considered if its confidence is greater than or equal to the threshold.
-    #   Specify a probability between 0 and 1 inclusive. No alternative words are computed
-    #   if you omit the parameter.
-    # @param word_confidence [Boolean] If `true`, a confidence measure in the range of 0 to 1 is returned for each word.
-    #   By default, no word confidence measures are returned.
-    # @param timestamps [Boolean] If `true`, time alignment is returned for each word. By default, no timestamps are
-    #   returned.
-    # @param profanity_filter [Boolean] If `true` (the default), filters profanity from all output except for keyword
+    #   Specify a probability between 0.0 and 1.0. No alternative words are computed if
+    #   you omit the parameter.
+    # @param word_confidence [Boolean] If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for
+    #   each word. By default, no word confidence measures are returned.
+    # @param timestamps [Boolean] If `true`, the service returns time alignment for each word. By default, no
+    #   timestamps are returned.
+    # @param profanity_filter [Boolean] If `true`, the service filters profanity from all output except for keyword
     #   results by replacing inappropriate words with a series of asterisks. Set the
     #   parameter to `false` to return results with no censoring. Applies to US English
     #   transcription only.
-    # @param smart_formatting [Boolean] If `true`, converts dates, times, series of digits and numbers, phone numbers,
-    #   currency values, and internet addresses into more readable, conventional
+    # @param smart_formatting [Boolean] If `true`, the service converts dates, times, series of digits and numbers, phone
+    #   numbers, currency values, and internet addresses into more readable, conventional
     #   representations in the final transcript of a recognition request. For US English,
-    #   also converts certain keyword strings to punctuation symbols. By default, no smart
-    #   formatting is performed. Applies to US English and Spanish transcription only.
+    #   the service also converts certain keyword strings to punctuation symbols. By
+    #   default, no smart formatting is performed. Applies to US English and Spanish
+    #   transcription only.
     # @param speaker_labels [Boolean] If `true`, the response includes labels that identify which words were spoken by
     #   which participants in a multi-person exchange. By default, no speaker labels are
     #   returned. Setting `speaker_labels` to `true` forces the `timestamps` parameter to
@@ -1257,9 +1309,9 @@ module IBMWatson
     #   if it encounters non-ASCII characters. With cURL, 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 default), the request fails if
-    #   a corpus or audio resource with the same name already exists. The parameter has no
-    #   effect if a corpus or audio resource with the same name does not already exist.
+    #   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
+    #   corpus or audio resource with the same name does not already exist.
     # @param corpus_filename [String] The filename for corpus_file.
     # @return [nil]
     def add_corpus(customization_id:, corpus_name:, corpus_file:, allow_overwrite: nil, corpus_filename: nil)
@@ -2021,9 +2073,9 @@ module IBMWatson
     #   parameters that are used with some formats. For a complete list of supported audio
     #   formats, see [Audio formats](/docs/services/speech-to-text/input.html#formats).
     # @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 default), the request fails if
-    #   a corpus or audio resource with the same name already exists. The parameter has no
-    #   effect if a corpus or audio resource with the same name does not already exist.
+    #   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
+    #   corpus or audio resource with the same name does not already exist.
     # @return [nil]
     def add_audio(customization_id:, audio_name:, audio_resource:, content_type:, contained_content_type: nil, allow_overwrite: nil)
       raise ArgumentError("customization_id must be provided") if customization_id.nil?

data/lib/ibm_watson/version.rb

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

data/test/integration/test_speech_to_text_v1.rb

@@ -131,7 +131,7 @@ unless ENV["SPEECH_TO_TEXT_USERNAME"].nil? || ENV["SPEECH_TO_TEXT_PASSWORD"].nil
     def test_recognize_websocket_as_chunks
       audio_file = File.open(Dir.getwd + "/resources/speech.wav")
       mycallback = MyRecognizeCallback.new
-      speech = @service.recognize_with_websocket(
+      speech = @service.recognize_using_websocket(
         chunk_data: true,
         recognize_callback: mycallback,
         interim_results: true,
@@ -155,7 +155,7 @@ unless ENV["SPEECH_TO_TEXT_USERNAME"].nil? || ENV["SPEECH_TO_TEXT_PASSWORD"].nil
     def test_recognize_websocket
       audio_file = File.open(Dir.getwd + "/resources/speech.wav")
       mycallback = MyRecognizeCallback.new
-      speech = @service.recognize_with_websocket(
+      speech = @service.recognize_using_websocket(
         audio: audio_file,
         recognize_callback: mycallback,
         interim_results: true,
@@ -168,11 +168,11 @@ unless ENV["SPEECH_TO_TEXT_USERNAME"].nil? || ENV["SPEECH_TO_TEXT_PASSWORD"].nil
       thr.join
     end
 
-    def test_inactivity_timeout_with_websocket
+    def test_inactivity_timeout_using_websocket
       audio_file = File.open(Dir.getwd + "/resources/sound-with-pause.wav")
       atomic_boolean = Concurrent::AtomicBoolean.new
       mycallback = MyRecognizeCallback.new(atomic_boolean: atomic_boolean)
-      speech = @service.recognize_with_websocket(
+      speech = @service.recognize_using_websocket(
         audio: audio_file,
         recognize_callback: mycallback,
         interim_results: true,
@@ -187,11 +187,11 @@ unless ENV["SPEECH_TO_TEXT_USERNAME"].nil? || ENV["SPEECH_TO_TEXT_PASSWORD"].nil
       assert(atomic_boolean.true?)
     end
 
-    def test_broken_audio_with_websocket
+    def test_broken_audio_using_websocket
       audio_file = File.open(Dir.getwd + "/resources/car.jpg")
       atomic_boolean = Concurrent::AtomicBoolean.new
       mycallback = MyRecognizeCallback.new(atomic_boolean: atomic_boolean)
-      speech = @service.recognize_with_websocket(
+      speech = @service.recognize_using_websocket(
         audio: audio_file,
         recognize_callback: mycallback,
         interim_results: true,
@@ -205,7 +205,7 @@ unless ENV["SPEECH_TO_TEXT_USERNAME"].nil? || ENV["SPEECH_TO_TEXT_PASSWORD"].nil
       assert(atomic_boolean.true?)
     end
 
-    def test_invalid_auth_with_websocket
+    def test_invalid_auth_using_websocket
       audio_file = File.open(Dir.getwd + "/resources/speech.wav")
       atomic_boolean = Concurrent::AtomicBoolean.new
       mycallback = MyRecognizeCallback.new(atomic_boolean: atomic_boolean)
@@ -218,7 +218,7 @@ unless ENV["SPEECH_TO_TEXT_USERNAME"].nil? || ENV["SPEECH_TO_TEXT_PASSWORD"].nil
           "X-Watson-Test" => "1"
         }
       )
-      speech = temp_service.recognize_with_websocket(
+      speech = temp_service.recognize_using_websocket(
         audio: audio_file,
         recognize_callback: mycallback,
         interim_results: true,

data/test/unit/test_assistant_v1.rb

@@ -425,7 +425,7 @@ class AssistantV1Test < Minitest::Test
     }
     stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces/boguswid/intents/pizza_order/examples?version=2018-02-16")
       .with(
-        body: "{\"text\":\"Gimme a pizza with pepperoni\"}",
+        body: "{\"text\":\"Gimme a pizza with pepperoni\",\"mentions\":[{\"mentioned\":\"yes\"}]}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
@@ -441,7 +441,8 @@ class AssistantV1Test < Minitest::Test
     service_response = service.create_example(
       workspace_id: "boguswid",
       intent: "pizza_order",
-      text: "Gimme a pizza with pepperoni"
+      text: "Gimme a pizza with pepperoni",
+      mentions: [{ "mentioned" => "yes" }]
     )
     assert_equal(response, service_response.result)
   end
@@ -553,7 +554,7 @@ class AssistantV1Test < Minitest::Test
     }
     stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces/boguswid/intents/pizza_order/examples/Gimme%20a%20pizza%20with%20pepperoni?version=2018-02-16")
       .with(
-        body: "{\"text\":\"Gimme a pizza with pepperoni\"}",
+        body: "{\"text\":\"Gimme a pizza with pepperoni\",\"mentions\":[{\"mentioned\":\"yes\"}]}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
@@ -570,7 +571,8 @@ class AssistantV1Test < Minitest::Test
       workspace_id: "boguswid",
       intent: "pizza_order",
       text: "Gimme a pizza with pepperoni",
-      new_text: "Gimme a pizza with pepperoni"
+      new_text: "Gimme a pizza with pepperoni",
+      new_mentions: [{ "mentioned" => "yes" }]
     )
     assert_equal(response, service_response.result)
   end
@@ -1325,7 +1327,7 @@ class AssistantV1Test < Minitest::Test
     }
     stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces?version=2018-02-16")
       .with(
-        body: "{\"name\":\"Pizza app\",\"description\":\"Pizza app\",\"language\":\"en\",\"metadata\":{}}",
+        body: "{\"name\":\"Pizza app\",\"description\":\"Pizza app\",\"language\":\"en\",\"metadata\":{},\"system_settings\":{\"system_settings\":\"yes\"}}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
@@ -1342,7 +1344,8 @@ class AssistantV1Test < Minitest::Test
       name: "Pizza app",
       description: "Pizza app",
       language: "en",
-      metadata: {}
+      metadata: {},
+      system_settings: { "system_settings" => "yes" }
     )
     assert_equal(response, service_response.result)
   end
@@ -1458,7 +1461,7 @@ class AssistantV1Test < Minitest::Test
     }
     stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces/pizza_app-e0f3?version=2018-02-16")
       .with(
-        body: "{\"name\":\"Pizza app\",\"description\":\"Pizza app\",\"language\":\"en\",\"metadata\":{}}",
+        body: "{\"name\":\"Pizza app\",\"description\":\"Pizza app\",\"language\":\"en\",\"metadata\":{},\"system_settings\":{\"system_settings\":\"yes\"}}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
@@ -1476,7 +1479,8 @@ class AssistantV1Test < Minitest::Test
       name: "Pizza app",
       description: "Pizza app",
       language: "en",
-      metadata: {}
+      metadata: {},
+      system_settings: { "system_settings" => "yes" }
     )
     assert_equal(response, service_response.result)
   end
@@ -1493,7 +1497,7 @@ class AssistantV1Test < Minitest::Test
 
     stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces/id/dialog_nodes?version=2018-02-16")
       .with(
-        body: "{\"dialog_node\":\"location-done\"}",
+        body: "{\"dialog_node\":\"location-done\",\"user_label\":\"labeled\"}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
@@ -1503,7 +1507,8 @@ class AssistantV1Test < Minitest::Test
       ).to_return(status: 200, body: { "application/json" => { "dialog_node" => "location-done" } }.to_json, headers: headers)
     service_response = service.create_dialog_node(
       workspace_id: "id",
-      dialog_node: "location-done"
+      dialog_node: "location-done",
+      user_label: "labeled"
     )
     assert_equal("location-done", service_response.result["application/json"]["dialog_node"])
 
@@ -1580,7 +1585,7 @@ class AssistantV1Test < Minitest::Test
     )
     stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces/workspace_id/dialog_nodes/dialog_node?version=2018-02-16")
       .with(
-        body: "{\"description\":\"A new description\"}",
+        body: "{\"description\":\"A new description\",\"user_label\":\"new_label\"}",
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
@@ -1591,8 +1596,32 @@ class AssistantV1Test < Minitest::Test
     service_response = service.update_dialog_node(
       workspace_id: "workspace_id",
       dialog_node: "dialog_node",
-      new_description: "A new description"
+      new_description: "A new description",
+      new_user_label: "new_label"
     )
     assert_equal("Pseudo update dialog node response", service_response.result)
   end
+
+  def test_list_mentions
+    service = IBMWatson::AssistantV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-02-16"
+    )
+    stub_request(:get, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces/workspace_id/entities/entity/mentions?export=true&include_audit=true&version=2018-02-16")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "list_mentions_response" => "yes" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.list_mentions(
+      workspace_id: "workspace_id",
+      entity: "entity",
+      export: true,
+      include_audit: true
+    )
+    assert_equal({ "list_mentions_response" => "yes" }, service_response.result)
+  end
 end

data/test/unit/test_discovery_v1.rb

@@ -259,13 +259,15 @@ class DiscoveryV1Test < Minitest::Test
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
-          "Host" => "gateway.watsonplatform.net"
+          "Host" => "gateway.watsonplatform.net",
+          "X-Watson-Logging-Opt-Out" => true
         }
       ).to_return(status: 200, body: { body: "hello" }.to_json, headers: { "Content-Type" => "application/json" })
     service_response = service.query(
       environment_id: "envid",
       collection_id: "collid",
-      count: 10
+      count: 10,
+      logging_opt_out: true
     )
     assert_equal({ "body" => "hello" }, service_response.result)
   end

metadata

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