feat: New features in VR4 and assistant2

feat: New features in VR4 and assistant2

Author: Mikemosca

lib/ibm_watson/assistant_v2.rb

@@ -160,8 +160,10 @@ def delete_session(assistant_id:, session_id:)
 
     ##
     # @!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 @@ def delete_session(assistant_id:, session_id:)
     #   **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 @@ def message(assistant_id:, session_id:, input: nil, context: nil)
       )
       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

lib/ibm_watson/discovery_v2.rb

@@ -467,6 +467,9 @@ def add_document(project_id:, collection_id:, file: nil, filename: nil, file_con
     #   **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 @@ def update_document(project_id:, collection_id:, document_id:, file: nil, filena
     #   **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.

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"

lib/ibm_watson/visual_recognition_v4.rb

@@ -325,6 +325,51 @@ def delete_collection(collection_id:)
       )
       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
     #########################