ibm_watson 0.16.1 → 0.17.0

data/lib/ibm_watson/assistant_v2.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 # The IBM Watson™ Assistant service combines machine learning, natural language
-# understanding, and integrated dialog tools to create conversation flows between your
+# understanding, and an integrated dialog editor to create conversation flows between your
 # apps and your users.
 
 require "concurrent"
@@ -47,16 +47,16 @@ module IBMWatson
     #   ready for a later version.
     # @option args url [String] The base url to use when contacting the service (e.g.
     #   "https://gateway.watsonplatform.net/assistant/api").
-    #   The base url may differ between Bluemix regions.
+    #   The base url may differ between IBM Cloud regions.
     # @option args username [String] The username used to authenticate with the service.
     #   Username and password credentials are only required to run your
-    #   application locally or outside of Bluemix. When running on
-    #   Bluemix, the credentials will be automatically loaded from the
+    #   application locally or outside of IBM Cloud. When running on
+    #   IBM Cloud, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
     # @option args password [String] The password used to authenticate with the service.
     #   Username and password credentials are only required to run your
-    #   application locally or outside of Bluemix. When running on
-    #   Bluemix, the credentials will be automatically loaded from the
+    #   application locally or outside of IBM Cloud. When running on
+    #   IBM Cloud, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
     # @option args iam_apikey [String] An API key that can be used to request IAM tokens. If
     #   this API key is provided, the SDK will manage the token and handle the
@@ -66,7 +66,9 @@ module IBMWatson
     #   it expires or reactively upon receiving a 401 from the service as any requests
     #   made with an expired token will fail.
     # @option args iam_url [String] An optional URL for the IAM service API. Defaults to
-    #   'https://iam.ng.bluemix.net/identity/token'.
+    #   'https://iam.cloud.ibm.com/identity/token'.
+    # @option args iam_client_id [String] An optional client id for the IAM service API.
+    # @option args iam_client_secret [String] An optional client secret for the IAM service API.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
@@ -77,6 +79,8 @@ module IBMWatson
       defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
+      defaults[:iam_client_id] = nil
+      defaults[:iam_client_secret] = nil
       args = defaults.merge(args)
       args[:vcap_services_name] = "conversation"
       super
@@ -93,10 +97,10 @@ module IBMWatson
     # Create a session.
     # Create a new session. A session is used to send user input to a skill and receive
     #   responses. It also maintains the state of the conversation.
-    # @param assistant_id [String] Unique identifier of the assistant. You can find the assistant ID of an assistant
-    #   on the **Assistants** tab of the Watson Assistant tool. For information about
-    #   creating assistants, see the
-    #   [documentation](https://console.bluemix.net/docs/services/assistant/assistant-add.html#assistant-add-task).
+    # @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/services/assistant?topic=assistant-assistant-add#assistant-add-task).
     #
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -128,10 +132,10 @@ module IBMWatson
     # @!method delete_session(assistant_id:, session_id:)
     # Delete session.
     # Deletes a session explicitly before it times out.
-    # @param assistant_id [String] Unique identifier of the assistant. You can find the assistant ID of an assistant
-    #   on the **Assistants** tab of the Watson Assistant tool. For information about
-    #   creating assistants, see the
-    #   [documentation](https://console.bluemix.net/docs/services/assistant/assistant-add.html#assistant-add-task).
+    # @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/services/assistant?topic=assistant-assistant-add#assistant-add-task).
     #
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @param session_id [String] Unique identifier of the session.
@@ -171,10 +175,10 @@ module IBMWatson
     # Send user input to an assistant and receive a response.
     #
     #   There is no rate limit for this operation.
-    # @param assistant_id [String] Unique identifier of the assistant. You can find the assistant ID of an assistant
-    #   on the **Assistants** tab of the Watson Assistant tool. For information about
-    #   creating assistants, see the
-    #   [documentation](https://console.bluemix.net/docs/services/assistant/assistant-add.html#assistant-add-task).
+    # @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/services/assistant?topic=assistant-assistant-add#assistant-add-task).
     #
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @param session_id [String] Unique identifier of the session.

data/lib/ibm_watson/compare_comply_v1.rb

@@ -46,7 +46,7 @@ module IBMWatson
     #   ready for a later version.
     # @option args url [String] The base url to use when contacting the service (e.g.
     #   "https://gateway.watsonplatform.net/compare-comply/api").
-    #   The base url may differ between Bluemix regions.
+    #   The base url may differ between IBM Cloud regions.
     # @option args iam_apikey [String] An API key that can be used to request IAM tokens. If
     #   this API key is provided, the SDK will manage the token and handle the
     #   refreshing.
@@ -55,7 +55,9 @@ module IBMWatson
     #   it expires or reactively upon receiving a 401 from the service as any requests
     #   made with an expired token will fail.
     # @option args iam_url [String] An optional URL for the IAM service API. Defaults to
-    #   'https://iam.ng.bluemix.net/identity/token'.
+    #   'https://iam.cloud.ibm.com/identity/token'.
+    # @option args iam_client_id [String] An optional client id for the IAM service API.
+    # @option args iam_client_secret [String] An optional client secret for the IAM service API.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
@@ -64,6 +66,8 @@ module IBMWatson
       defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
+      defaults[:iam_client_id] = nil
+      defaults[:iam_client_secret] = nil
       args = defaults.merge(args)
       args[:vcap_services_name] = "compare-comply"
       super
@@ -321,76 +325,6 @@ module IBMWatson
       response
     end
 
-    ##
-    # @!method delete_feedback(feedback_id:, model: nil)
-    # Delete a specified feedback entry.
-    # Deletes a feedback entry with a specified `feedback_id`.
-    # @param feedback_id [String] A string that specifies the feedback entry to be deleted from the document.
-    # @param model [String] The analysis model to be used by the service. For the **Element classification**
-    #   and **Compare two documents** methods, the default is `contracts`. For the
-    #   **Extract tables** method, the default is `tables`. These defaults apply to the
-    #   standalone methods as well as to the methods' use in batch-processing requests.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def delete_feedback(feedback_id:, model: nil)
-      raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
-
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "delete_feedback")
-      headers.merge!(sdk_headers)
-
-      params = {
-        "version" => @version,
-        "model" => model
-      }
-
-      method_url = "/v1/feedback/%s" % [ERB::Util.url_encode(feedback_id)]
-
-      response = request(
-        method: "DELETE",
-        url: method_url,
-        headers: headers,
-        params: params,
-        accept_json: true
-      )
-      response
-    end
-
-    ##
-    # @!method get_feedback(feedback_id:, model: nil)
-    # List a specified feedback entry.
-    # Lists a feedback entry with a specified `feedback_id`.
-    # @param feedback_id [String] A string that specifies the feedback entry to be included in the output.
-    # @param model [String] The analysis model to be used by the service. For the **Element classification**
-    #   and **Compare two documents** methods, the default is `contracts`. For the
-    #   **Extract tables** method, the default is `tables`. These defaults apply to the
-    #   standalone methods as well as to the methods' use in batch-processing requests.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def get_feedback(feedback_id:, model: nil)
-      raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
-
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "get_feedback")
-      headers.merge!(sdk_headers)
-
-      params = {
-        "version" => @version,
-        "model" => model
-      }
-
-      method_url = "/v1/feedback/%s" % [ERB::Util.url_encode(feedback_id)]
-
-      response = request(
-        method: "GET",
-        url: method_url,
-        headers: headers,
-        params: params,
-        accept_json: true
-      )
-      response
-    end
-
     ##
     # @!method list_feedback(feedback_type: nil, before: nil, after: nil, document_title: nil, model_id: nil, model_version: nil, category_removed: nil, category_added: nil, category_not_changed: nil, type_removed: nil, type_added: nil, type_not_changed: nil, page_limit: nil, cursor: nil, sort: nil, include_total: nil)
     # List the feedback in a document.
@@ -474,6 +408,76 @@ module IBMWatson
       )
       response
     end
+
+    ##
+    # @!method get_feedback(feedback_id:, model: nil)
+    # Get a specified feedback entry.
+    # Gets a feedback entry with a specified `feedback_id`.
+    # @param feedback_id [String] A string that specifies the feedback entry to be included in the output.
+    # @param model [String] The analysis model to be used by the service. For the **Element classification**
+    #   and **Compare two documents** methods, the default is `contracts`. For the
+    #   **Extract tables** method, the default is `tables`. These defaults apply to the
+    #   standalone methods as well as to the methods' use in batch-processing requests.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_feedback(feedback_id:, model: nil)
+      raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "get_feedback")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "model" => model
+      }
+
+      method_url = "/v1/feedback/%s" % [ERB::Util.url_encode(feedback_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method delete_feedback(feedback_id:, model: nil)
+    # Delete a specified feedback entry.
+    # Deletes a feedback entry with a specified `feedback_id`.
+    # @param feedback_id [String] A string that specifies the feedback entry to be deleted from the document.
+    # @param model [String] The analysis model to be used by the service. For the **Element classification**
+    #   and **Compare two documents** methods, the default is `contracts`. For the
+    #   **Extract tables** method, the default is `tables`. These defaults apply to the
+    #   standalone methods as well as to the methods' use in batch-processing requests.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def delete_feedback(feedback_id:, model: nil)
+      raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "delete_feedback")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "model" => model
+      }
+
+      method_url = "/v1/feedback/%s" % [ERB::Util.url_encode(feedback_id)]
+
+      response = request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
     #########################
     # Batches
     #########################
@@ -482,11 +486,12 @@ module IBMWatson
     # @!method create_batch(function:, input_credentials_file:, input_bucket_location:, input_bucket_name:, output_credentials_file:, output_bucket_location:, output_bucket_name:, model: nil)
     # Submit a batch-processing request.
     # Run Compare and Comply methods over a collection of input documents.
+    #
     #   **Important:** Batch processing requires the use of the [IBM Cloud Object Storage
-    #   service](https://cloud.ibm.com/docs/services/cloud-object-storage/about-cos.html#about-ibm-cloud-object-storage).
+    #   service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
     #   The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using
     #   batch
-    #   processing](https://cloud.ibm.com/docs/services/compare-comply/batching.html#before-you-batch).
+    #   processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-comply-batching#before-you-batch).
     # @param function [String] The Compare and Comply method to run across the submitted input documents.
     # @param input_credentials_file [File] A JSON file containing the input Cloud Object Storage credentials. At a minimum,
     #   the credentials must enable `READ` permissions on the bucket defined by the
@@ -567,24 +572,21 @@ module IBMWatson
     end
 
     ##
-    # @!method get_batch(batch_id:)
-    # Get information about a specific batch-processing job.
-    # Gets information about a batch-processing job with a specified ID.
-    # @param batch_id [String] The ID of the batch-processing job whose information you want to retrieve.
+    # @!method list_batches
+    # List submitted batch-processing jobs.
+    # Lists batch-processing jobs submitted by users.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def get_batch(batch_id:)
-      raise ArgumentError.new("batch_id must be provided") if batch_id.nil?
-
+    def list_batches
       headers = {
       }
-      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "get_batch")
+      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "list_batches")
       headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
       }
 
-      method_url = "/v1/batches/%s" % [ERB::Util.url_encode(batch_id)]
+      method_url = "/v1/batches"
 
       response = request(
         method: "GET",
@@ -597,21 +599,24 @@ module IBMWatson
     end
 
     ##
-    # @!method list_batches
-    # List submitted batch-processing jobs.
-    # Lists batch-processing jobs submitted by users.
+    # @!method get_batch(batch_id:)
+    # Get information about a specific batch-processing job.
+    # Gets information about a batch-processing job with a specified ID.
+    # @param batch_id [String] The ID of the batch-processing job whose information you want to retrieve.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def list_batches
+    def get_batch(batch_id:)
+      raise ArgumentError.new("batch_id must be provided") if batch_id.nil?
+
       headers = {
       }
-      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "list_batches")
+      sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "get_batch")
       headers.merge!(sdk_headers)
 
       params = {
         "version" => @version
       }
 
-      method_url = "/v1/batches"
+      method_url = "/v1/batches/%s" % [ERB::Util.url_encode(batch_id)]
 
       response = request(
         method: "GET",