ibm_watson 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d4c227c6c5c5022489eaf6a69b8b674ec91facde966f3e077b9c53c969ccd80
-  data.tar.gz: 1eed5dfb21f288d25d555828a741c5836b6b25c984d7f2b1eb3de2a9f703f977
+  metadata.gz: b197aaa628e62691bfa2a18c5b15bb0bc7688d73c3d8ed7f005d2e805f72f549
+  data.tar.gz: d9db08b75ff0bcc1fad6af8f9e6b234e97523dae6ce9d01eea5a65f64d46529a
 SHA512:
-  metadata.gz: f8a58cdc4bc68c22395584350e43e47d3d93a82602d41443dfb7160f9887241d76616372ec8a77f596686b47a7216a26b710107776d19c601f54dd05e2a20089
-  data.tar.gz: 5e80aa7bba94a5951ac4bbfae545c82a72f161f360b7e4b9633da07461d3ef679ceeb54880552216c84a33b7d8407599ac85035926f3b830fa9351664c70a4bf
+  metadata.gz: 9650dad4ea8eda2cd026015cc4863fc0a2834ab081f3602ed52be9dec392cac4fe47b4d9d918cba76be42994de3e53d658e147516b2272c3e4dfb68c102a54b6
+  data.tar.gz: cf68a5911478d0171f4e4fed85e839ec10187eeb5ec2fda145a812389787ad7a9245c5dfc51d6826f574b6ea80c29d01c807ec411a9286dd5203d8882ea4c176

data/README.md

@@ -398,8 +398,10 @@ If you have issues with the APIs or have a question about the Watson services, s
 
 Tested on:
 
-* MRI Ruby (RVM): 2.3.7, 2.4.4, 2.5.1
-* RubyInstaller (Windows x64): 2.3.3, 2.4.4, 2.5.1
+* MRI Ruby (RVM): 2.5.1, 2.6.1
+* RubyInstaller (Windows x64): 2.5.1, 2.6.1
+
+2.3.7 and 2.4.4 should still work but support will be deprecated in next major release.
 
 ## Contributing
 

data/lib/ibm_watson/assistant_v2.rb

@@ -160,8 +160,10 @@ module IBMWatson
 
     ##
     # @!method message(assistant_id:, session_id:, input: nil, context: nil)
-    # Send user input to assistant.
-    # Send user input to an assistant and receive a response.
+    # Send user input to assistant (stateful).
+    # Send user input to an assistant and receive a response, with conversation state
+    #   (including context data) stored by Watson Assistant for the duration of the
+    #   session.
     #
     #   There is no rate limit for this operation.
     # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
@@ -172,9 +174,12 @@ module IBMWatson
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @param session_id [String] Unique identifier of the session.
     # @param input [MessageInput] An input object that includes the input text.
-    # @param context [MessageContext] State information for the conversation. The context is stored by the assistant on
-    #   a per-session basis. You can use this property to set or modify context variables,
-    #   which can also be accessed by dialog nodes.
+    # @param context [MessageContext] Context data for the conversation. You can use this property to set or modify
+    #   context variables, which can also be accessed by dialog nodes. The context is
+    #   stored by the assistant on a per-session basis.
+    #
+    #   **Note:** The total size of the context data stored for a stateful session cannot
+    #   exceed 100KB.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def message(assistant_id:, session_id:, input: nil, context: nil)
       raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
@@ -207,5 +212,57 @@ module IBMWatson
       )
       response
     end
+
+    ##
+    # @!method message_stateless(assistant_id:, input: nil, context: nil)
+    # Send user input to assistant (stateless).
+    # Send user input to an assistant and receive a response, with conversation state
+    #   (including context data) managed by your application.
+    #
+    #   There is no rate limit for this operation.
+    # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
+    #   Assistant user interface, open the assistant settings and click **API Details**.
+    #   For information about creating assistants, see the
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
+    #
+    #   **Note:** Currently, the v2 API does not support creating assistants.
+    # @param input [MessageInputStateless] An input object that includes the input text.
+    # @param context [MessageContextStateless] Context data for the conversation. You can use this property to set or modify
+    #   context variables, which can also be accessed by dialog nodes. The context is not
+    #   stored by the assistant. To maintain session state, include the context from the
+    #   previous response.
+    #
+    #   **Note:** The total size of the context data for a stateless session cannot exceed
+    #   250KB.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def message_stateless(assistant_id:, input: nil, context: nil)
+      raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("conversation", "V2", "message_stateless")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "input" => input,
+        "context" => context
+      }
+
+      method_url = "/v2/assistants/%s/message" % [ERB::Util.url_encode(assistant_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        accept_json: true
+      )
+      response
+    end
   end
 end

data/lib/ibm_watson/discovery_v2.rb

@@ -467,6 +467,9 @@ module IBMWatson
     #   **Note:** This operation only works on collections created to accept direct file
     #   uploads. It cannot be used to modify a collection that connects to an external
     #   source such as Microsoft SharePoint.
+    #
+    #   **Note:** If an uploaded document is segmented, all segments will be overwritten,
+    #   even if the updated version of the document has fewer segments.
     # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
     #   Discovery administrative tooling.
     # @param collection_id [String] The ID of the collection.
@@ -537,6 +540,9 @@ module IBMWatson
     #   **Note:** This operation only works on collections created to accept direct file
     #   uploads. It cannot be used to modify a collection that connects to an external
     #   source such as Microsoft SharePoint.
+    #
+    #   **Note:** Segments of an uploaded document cannot be deleted individually. Delete
+    #   all segments by deleting using the `parent_document_id` of a segment result.
     # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
     #   Discovery administrative tooling.
     # @param collection_id [String] The ID of the collection.

data/lib/ibm_watson/speech_to_text_v1.rb

@@ -488,7 +488,7 @@ module IBMWatson
     # @param customization_id [String] The GUID of a custom language model that is to be used with the 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.
     # @param acoustic_customization_id [String] The GUID of a custom acoustic model that is to be used with the request. The base model of the specified custom acoustic 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 acoustic model is used.
     # @param language_customization_id [String] The GUID of a custom language model that is to be used with the 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.
-    # @param base_model_version [String] The version of the specified base `model` that is to be used for speech recognition. Multiple versions of a base model can exist when a model is updated for internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a new base model. The default value depends on whether the parameter is used with or without a custom model. For more information, see [Base model version](https://console.bluemix.net/docs/services/speech-to-text/input.html#version).
+    # @param base_model_version [String] The version of the specified base `model` that is to be used for speech recognition. Multiple versions of a base model can exist when a model is updated for internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a new base model. The default value depends on whether the parameter is used with or without a custom model. For more information, see [Base model version](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#version).
     # @param inactivity_timeout [Integer] The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. Use `-1` for infinity.
     # @param interim_results [Boolean] Send back non-final previews of each "sentence" as it is being processed. These results are ignored in text mode.
     # @param keywords [Array<String>] 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 hypothesis, not in interim results. If you specify any keywords, you must also specify a keywords threshold. Omit the parameter or specify an empty array if you do not need to spot keywords.
@@ -499,13 +499,13 @@ module IBMWatson
     # @param timestamps [Boolean] If `true`, time alignment for each word is returned.
     # @param profanity_filter [Boolean] If `true` (the default), 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 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).
+    # @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://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#speaker_labels).
     # @param grammar_name [String] The name of a grammar that is to be used with the recognition request. If you
     #   specify a grammar, you must also use the `language_customization_id` parameter to
     #   specify the name of the custom language model for which the grammar is defined.
     #   The service recognizes only strings that are recognized by the specified grammar;
     #   it does not recognize other custom words from the model's words resource. See
-    #   [Grammars](https://cloud.ibm.com/docs/services/speech-to-text/output.html).
+    #   [Grammars](https://cloud.ibm.com/docs/speech-to-text/output.html).
     # @param redaction [Boolean] If `true`, the service redacts, or masks, numeric data from final transcripts. The
     #   feature redacts any number that has three or more consecutive digits by replacing
     #   each digit with an `X` character. It is intended to redact sensitive numeric data,
@@ -520,7 +520,7 @@ module IBMWatson
     #   **Note:** Applies to US English, Japanese, and Korean transcription only.
     #
     #   See [Numeric
-    #   redaction](https://cloud.ibm.com/docs/services/speech-to-text/output.html#redaction).
+    #   redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#redaction).
     #
     # @param processing_metrics [Boolean] If `true`, requests processing metrics about the service's transcription of the
     #   input audio. The service returns processing metrics at the interval specified by
@@ -542,7 +542,7 @@ module IBMWatson
     # @return [WebSocketClient] Returns a new WebSocketClient object
     #
     #   See [Audio
-    #   metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-metrics#audio_metrics).
+    #   metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics#audio_metrics).
     # @param end_of_phrase_silence_time [Float] If `true`, specifies the duration of the pause interval at which the service
     #   splits a transcript into multiple final results. If the service detects pauses or
     #   extended silence before it reaches the end of the audio stream, its response can
@@ -559,7 +559,7 @@ module IBMWatson
     #   Chinese is 0.6 seconds.
     #
     #   See [End of phrase silence
-    #   time](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#silence_time).
+    #   time](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#silence_time).
     # @param split_transcript_at_phrase_end [Boolean] If `true`, directs the service to split the transcript into multiple final results
     #   based on semantic features of the input, for example, at the conclusion of
     #   meaningful phrases such as sentences. The service bases its understanding of
@@ -569,7 +569,7 @@ module IBMWatson
     #   interval.
     #
     #   See [Split transcript at phrase
-    #   end](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#split_transcript).
+    #   end](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#split_transcript).
     # @param speech_detector_sensitivity [Float] The sensitivity of speech activity detection that the service is to perform. Use
     #   the parameter to suppress word insertions from music, coughing, and other
     #   non-speech events. The service biases the audio it passes for speech recognition

data/lib/ibm_watson/text_to_speech_v1.rb

@@ -20,18 +20,18 @@
 # both, for each language. The audio is streamed back to the client with minimal delay.
 #
 # For speech synthesis, the service supports a synchronous HTTP Representational State
-# Transfer (REST) interface. It also supports a WebSocket interface that provides both
-# plain text and SSML input, including the SSML <mark> element and word timings.
-# SSML is an XML-based markup language that provides text annotation for speech-synthesis
-# applications.
+# Transfer (REST) interface and a WebSocket interface. Both interfaces support plain text
+# and SSML input. SSML is an XML-based markup language that provides text annotation for
+# speech-synthesis applications. The WebSocket interface also supports the SSML
+# <code>&lt;mark&gt;</code> element and word timings.
 #
-# The service also offers a customization interface. You can use the interface to define
-# sounds-like or phonetic translations for words. A sounds-like translation consists of
-# one or more words that, when combined, sound like the word. A phonetic translation is
-# based on the SSML phoneme format for representing a word. You can specify a phonetic
-# translation in standard International Phonetic Alphabet (IPA) representation or in the
-# proprietary IBM Symbolic Phonetic Representation (SPR). The Arabic, Chinese, Dutch, and
-# Korean languages support only IPA.
+# The service offers a customization interface that you can use to define sounds-like or
+# phonetic translations for words. A sounds-like translation consists of one or more words
+# that, when combined, sound like the word. A phonetic translation is based on the SSML
+# phoneme format for representing a word. You can specify a phonetic translation in
+# standard International Phonetic Alphabet (IPA) representation or in the proprietary IBM
+# Symbolic Phonetic Representation (SPR). The Arabic, Chinese, Dutch, and Korean languages
+# support only IPA.
 
 require "concurrent"
 require "erb"

data/lib/ibm_watson/version.rb

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

data/lib/ibm_watson/visual_recognition_v4.rb

@@ -325,6 +325,51 @@ module IBMWatson
       )
       nil
     end
+
+    ##
+    # @!method get_model_file(collection_id:, feature:, model_format:)
+    # Get a model.
+    # Download a model that you can deploy to detect objects in images. The collection
+    #   must include a generated model, which is indicated in the response for the
+    #   collection details as `"rscnn_ready": true`. If the value is `false`, train or
+    #   retrain the collection to generate the model.
+    #
+    #   Currently, the model format is specific to Android apps. For more information
+    #   about how to deploy the model to your app, see the [Watson Visual Recognition on
+    #   Android](https://github.com/matt-ny/rscnn) project in GitHub.
+    # @param collection_id [String] The identifier of the collection.
+    # @param feature [String] The feature for the model.
+    # @param model_format [String] The format of the returned model.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_model_file(collection_id:, feature:, model_format:)
+      raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
+
+      raise ArgumentError.new("feature must be provided") if feature.nil?
+
+      raise ArgumentError.new("model_format must be provided") if model_format.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V4", "get_model_file")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "feature" => feature,
+        "model_format" => model_format
+      }
+
+      method_url = "/v4/collections/%s/model" % [ERB::Util.url_encode(collection_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: false
+      )
+      response
+    end
     #########################
     # Images
     #########################

data/test/integration/test_assistant_v2.rb

@@ -52,6 +52,13 @@ if !ENV["ASSISTANT_APIKEY"].nil? && !ENV["ASSISTANT_URL"].nil?
       )
       assert((200..299).cover?(service_response.status))
 
+      service_response = service.message_stateless(
+        assistant_id: ENV["ASSISTANT_ASSISTANT_ID"],
+        input: { "text" => "Turn on the lights" },
+        context: nil
+      )
+      assert((200..299).cover?(service_response.status))
+
       service.delete_session(
         assistant_id: ENV["ASSISTANT_ASSISTANT_ID"],
         session_id: session_id

data/test/integration/test_visual_recognition_v4.rb

@@ -68,6 +68,15 @@ if !ENV["VISUAL_RECOGNITION_APIKEY"].nil? && !ENV["VISUAL_RECOGNITION_URL"].nil?
       ).result
       refute(result.nil?)
     end
+
+    def test_get_model_file
+      result = @service.get_model_file(
+        collection_id: @collection_id,
+        feature: "objects",
+        model_format: "rscnn"
+      ).result
+      refute(result.nil?)
+    end
   end
 else
   class VisualRecognitionV4Test < Minitest::Test

data/test/unit/test_assistant_v2.rb

@@ -128,4 +128,70 @@ class AssistantV2Test < Minitest::Test
     )
     assert_nil(service_response)
   end
+
+  def test_message_stateless
+    # service.set_default_headers("x-watson-learning-opt-out" => true)
+    assistant_id = "f8fdbc65-e0bd-4e43-b9f8-2975a366d4ec"
+    message_response = {
+      "context" => {
+        "conversation_id" => "1b7b67c0-90ed-45dc-8508-9488bc483d5b",
+        "system" => {
+          "dialog_stack" => ["root"],
+          "dialog_turn_counter" => 1,
+          "dialog_request_counter" => 1
+        }
+      },
+      "intents" => [],
+      "entities" => [],
+      "input" => {},
+      "output" => {
+        "text" => "okay",
+        "log_messages" => []
+      }
+    }
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v2/assistants/f8fdbc65-e0bd-4e43-b9f8-2975a366d4ec/message?version=2018-02-16")
+      .with(
+        body: "{\"input\":{\"text\":\"Turn on the lights\"}}",
+        headers: {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: message_response.to_json, headers: headers)
+    service_response = service.message_stateless(
+      assistant_id: assistant_id,
+      input: { "text" => "Turn on the lights" },
+      context: nil
+    )
+    assert_equal(message_response, service_response.result)
+
+    message_ctx = {
+      "context" => {
+        "conversation_id" => "1b7b67c0-90ed-45dc-8508-9488bc483d5b",
+        "system" => {
+          "dialog_stack" => ["root"],
+          "dialog_turn_counter" => 2,
+          "dialog_request_counter" => 1
+        }
+      }
+    }
+    stub_request(:post, "https://gateway.watsonplatform.net/assistant/api/v2/assistants/f8fdbc65-e0bd-4e43-b9f8-2975a366d4ec/message?version=2018-02-16")
+      .with(
+        body: "{\"input\":{\"text\":\"Turn on the lights\"},\"context\":\"{\\\"conversation_id\\\":\\\"1b7b67c0-90ed-45dc-8508-9488bc483d5b\\\",\\\"system\\\":{\\\"dialog_stack\\\":[\\\"root\\\"],\\\"dialog_turn_counter\\\":2,\\\"dialog_request_counter\\\":1}}\"}",
+        headers: {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: message_response.to_json, headers: headers)
+    service_response = service.message_stateless(
+      assistant_id: assistant_id,
+      input: { "text" => "Turn on the lights" },
+      context: message_ctx["context"].to_json
+    )
+    assert_equal(message_response, service_response.result)
+  end
 end

data/test/unit/test_visual_recognition_v4.rb

@@ -401,4 +401,22 @@ class VisualRecognitionV4Test < Minitest::Test
     )
     assert_nil(service_response)
   end
+
+  def test_get_model_file
+    response = {
+      "binary" => []
+    }
+    stub_request(:get, "https://gateway.watsonplatform.net/visual-recognition/api/v4/collections/collid/model?feature=objects&model_format=rscnn_ready&version=2018-03-19")
+      .with(
+        headers: {
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_model_file(
+      collection_id: "collid",
+      feature: "objects",
+      model_format: "rscnn_ready"
+    )
+    assert_equal(response, service_response.result)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_watson
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Max Nussbaum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -346,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Official client library to use the IBM Watson Services