ibm_watson 1.4.0 → 2.0.1

data/lib/ibm_watson/assistant_v2.rb

@@ -13,7 +13,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# IBM OpenAPI SDK Code Generator Version: 3.19.0-be3b4618-20201113-200858
+#
 # The IBM Watson™ Assistant service combines machine learning, natural language
 # understanding, and an integrated dialog editor to create conversation flows between your
 # apps and your users.
@@ -34,22 +36,15 @@ module IBMWatson
   class AssistantV2 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
     DEFAULT_SERVICE_NAME = "assistant"
-    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/assistant/api"
+    DEFAULT_SERVICE_URL = "https://api.us-south.assistant.watson.cloud.ibm.com"
+    attr_accessor :version
     ##
     # @!method initialize(args)
     # Construct a new client for the Assistant service.
     #
     # @param args [Hash] The args to initialize with
-    # @option args version [String] The API version date to use with the service, in
-    #   "YYYY-MM-DD" format. Whenever the API is changed in a backwards
-    #   incompatible way, a new minor version of the API is released.
-    #   The service uses the API version for the date you specify, or
-    #   the most recent version before that date. Note that you should
-    #   not programmatically specify the current date at runtime, in
-    #   case the API has been updated since your application's release.
-    #   Instead, specify a version date that is compatible with your
-    #   application, and don't change it until your application is
-    #   ready for a later version.
+    # @option args version [String] Release date of the API version you want to use. Specify dates in YYYY-MM-DD
+    #   format. The current version is `2020-04-01`.
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
@@ -58,10 +53,10 @@ module IBMWatson
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
-      defaults[:version] = nil
       defaults[:service_url] = DEFAULT_SERVICE_URL
       defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      defaults[:version] = nil
       user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
@@ -94,6 +89,8 @@ module IBMWatson
     def create_session(assistant_id:)
       raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
 
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("conversation", "V2", "create_session")
@@ -132,6 +129,8 @@ module IBMWatson
     def delete_session(assistant_id:, session_id:)
       raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
 
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("session_id must be provided") if session_id.nil?
 
       headers = {
@@ -160,10 +159,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.
-    #
-    #   There is no rate limit for this operation.
+    # 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.
     # @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
@@ -172,15 +171,20 @@ 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?
 
       raise ArgumentError.new("session_id must be provided") if session_id.nil?
 
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("conversation", "V2", "message")
@@ -207,5 +211,202 @@ 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.
+    # @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?
+
+      raise ArgumentError.new("version must be provided") if version.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
+    #########################
+    # Logs
+    #########################
+
+    ##
+    # @!method list_logs(assistant_id:, sort: nil, filter: nil, page_limit: nil, cursor: nil)
+    # List log events for an assistant.
+    # List the events from the log of an assistant.
+    #
+    #   This method is available only with Premium plans.
+    # @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 sort [String] How to sort the returned log events. You can sort by **request_timestamp**. To
+    #   reverse the sort order, prefix the parameter value with a minus sign (`-`).
+    # @param filter [String] A cacheable parameter that limits the results to those matching the specified
+    #   filter. For more information, see the
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
+    # @param page_limit [Fixnum] The number of records to return in each page of results.
+    # @param cursor [String] A token identifying the page of results to retrieve.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_logs(assistant_id:, sort: nil, filter: nil, page_limit: nil, cursor: nil)
+      raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
+
+      raise ArgumentError.new("version must be provided") if version.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("conversation", "V2", "list_logs")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "sort" => sort,
+        "filter" => filter,
+        "page_limit" => page_limit,
+        "cursor" => cursor
+      }
+
+      method_url = "/v2/assistants/%s/logs" % [ERB::Util.url_encode(assistant_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # User data
+    #########################
+
+    ##
+    # @!method delete_user_data(customer_id:)
+    # Delete labeled data.
+    # Deletes all data associated with a specified customer ID. The method has no effect
+    #   if no data is associated with the customer ID.
+    #
+    #   You associate a customer ID with data by passing the `X-Watson-Metadata` header
+    #   with a request that passes data. For more information about personal data and
+    #   customer IDs, see [Information
+    #   security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security).
+    #
+    #   This operation is limited to 4 requests per minute. For more information, see
+    #   **Rate limiting**.
+    # @param customer_id [String] The customer ID for which all data is to be deleted.
+    # @return [nil]
+    def delete_user_data(customer_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
+      raise ArgumentError.new("customer_id must be provided") if customer_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("conversation", "V2", "delete_user_data")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "customer_id" => customer_id
+      }
+
+      method_url = "/v2/user_data"
+
+      request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      nil
+    end
+    #########################
+    # bulkClassify
+    #########################
+
+    ##
+    # @!method bulk_classify(skill_id:, input: nil)
+    # Identify intents and entities in multiple user utterances.
+    # Send multiple user inputs to a dialog skill in a single request and receive
+    #   information about the intents and entities recognized in each input. This method
+    #   is useful for testing and comparing the performance of different skills or skill
+    #   versions.
+    #
+    #   This method is available only with Premium plans.
+    # @param skill_id [String] Unique identifier of the skill. To find the skill ID in the Watson Assistant user
+    #   interface, open the skill settings and click **API Details**.
+    # @param input [Array[BulkClassifyUtterance]] An array of input utterances to classify.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def bulk_classify(skill_id:, input: nil)
+      raise ArgumentError.new("skill_id must be provided") if skill_id.nil?
+
+      raise ArgumentError.new("version must be provided") if version.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("conversation", "V2", "bulk_classify")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "input" => input
+      }
+
+      method_url = "/v2/skills/%s/workspace/bulk_classify" % [ERB::Util.url_encode(skill_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/compare_comply_v1.rb

@@ -13,7 +13,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+#
+# IBM OpenAPI SDK Code Generator Version: 3.19.0-be3b4618-20201113-200858
+#
 # IBM Watson™ Compare and Comply analyzes governing documents to provide details
 # about critical aspects of the documents.
 
@@ -30,34 +32,28 @@ module IBMWatson
   class CompareComplyV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
     DEFAULT_SERVICE_NAME = "compare_comply"
-    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/compare-comply/api"
+    DEFAULT_SERVICE_URL = "https://api.us-south.compare-comply.watson.cloud.ibm.com"
+    attr_accessor :version
     ##
     # @!method initialize(args)
     # Construct a new client for the Compare Comply service.
     #
     # @param args [Hash] The args to initialize with
-    # @option args version [String] The API version date to use with the service, in
-    #   "YYYY-MM-DD" format. Whenever the API is changed in a backwards
-    #   incompatible way, a new minor version of the API is released.
-    #   The service uses the API version for the date you specify, or
-    #   the most recent version before that date. Note that you should
-    #   not programmatically specify the current date at runtime, in
-    #   case the API has been updated since your application's release.
-    #   Instead, specify a version date that is compatible with your
-    #   application, and don't change it until your application is
-    #   ready for a later version.
+    # @option args version [String] Release date of the version of the API you want to use. Specify dates in
+    #   YYYY-MM-DD format. The current version is `2018-10-15`.
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
     # @option args service_name [String] The name of the service to configure. Will be used as the key to load
     #   any external configuration, if applicable.
     def initialize(args = {})
+      warn "On 30 November 2021, Compare and Comply will no longer be available. For more information, see https://github.com/watson-developer-cloud/ruby-sdk#compare-and-comply-deprecation."
       @__async_initialized__ = false
       defaults = {}
-      defaults[:version] = nil
       defaults[:service_url] = DEFAULT_SERVICE_URL
       defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      defaults[:version] = nil
       user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
@@ -84,6 +80,8 @@ module IBMWatson
     #   standalone methods as well as to the methods' use in batch-processing requests.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def convert_to_html(file:, file_content_type: nil, model: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("file must be provided") if file.nil?
 
       headers = {
@@ -131,6 +129,8 @@ module IBMWatson
     #   standalone methods as well as to the methods' use in batch-processing requests.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def classify_elements(file:, file_content_type: nil, model: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("file must be provided") if file.nil?
 
       headers = {
@@ -178,6 +178,8 @@ module IBMWatson
     #   standalone methods as well as to the methods' use in batch-processing requests.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def extract_tables(file:, file_content_type: nil, model: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("file must be provided") if file.nil?
 
       headers = {
@@ -229,6 +231,8 @@ module IBMWatson
     #   standalone methods as well as to the methods' use in batch-processing requests.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def compare_documents(file_1:, file_2:, file_1_content_type: nil, file_2_content_type: nil, file_1_label: nil, file_2_label: nil, model: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("file_1 must be provided") if file_1.nil?
 
       raise ArgumentError.new("file_2 must be provided") if file_2.nil?
@@ -286,6 +290,8 @@ module IBMWatson
     # @param comment [String] An optional comment on or description of the feedback.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def add_feedback(feedback_data:, user_id: nil, comment: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("feedback_data must be provided") if feedback_data.nil?
 
       headers = {
@@ -317,15 +323,11 @@ module IBMWatson
     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)
+    # @!method list_feedback(feedback_type: 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.
     # Lists the feedback in a document.
     # @param feedback_type [String] An optional string that filters the output to include only feedback with the
     #   specified feedback type. The only permitted value is `element_classification`.
-    # @param before [Time] An optional string in the format `YYYY-MM-DD` that filters the output to include
-    #   only feedback that was added before the specified date.
-    # @param after [Time] An optional string in the format `YYYY-MM-DD` that filters the output to include
-    #   only feedback that was added after the specified date.
     # @param document_title [String] An optional string that filters the output to include only feedback from the
     #   document with the specified `document_title`.
     # @param model_id [String] An optional string that filters the output to include only feedback with the
@@ -362,7 +364,9 @@ module IBMWatson
     #   output includes a value called `total` that gives the total count of feedback
     #   created.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def 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)
+    def list_feedback(feedback_type: 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)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "list_feedback")
@@ -371,8 +375,6 @@ module IBMWatson
       params = {
         "version" => @version,
         "feedback_type" => feedback_type,
-        "before" => before,
-        "after" => after,
         "document_title" => document_title,
         "model_id" => model_id,
         "model_version" => model_version,
@@ -411,6 +413,8 @@ module IBMWatson
     #   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("version must be provided") if version.nil?
+
       raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
 
       headers = {
@@ -446,6 +450,8 @@ module IBMWatson
     #   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("version must be provided") if version.nil?
+
       raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
 
       headers = {
@@ -504,6 +510,8 @@ module IBMWatson
     #   standalone methods as well as to the methods' use in batch-processing requests.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def create_batch(function:, input_credentials_file:, input_bucket_location:, input_bucket_name:, output_credentials_file:, output_bucket_location:, output_bucket_name:, model: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("function must be provided") if function.nil?
 
       raise ArgumentError.new("input_credentials_file must be provided") if input_credentials_file.nil?
@@ -568,6 +576,8 @@ module IBMWatson
     # Lists batch-processing jobs submitted by users.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def list_batches
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("compare-comply", "V1", "list_batches")
@@ -596,6 +606,8 @@ module IBMWatson
     # @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 get_batch(batch_id:)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("batch_id must be provided") if batch_id.nil?
 
       headers = {
@@ -632,6 +644,8 @@ module IBMWatson
     #   standalone methods as well as to the methods' use in batch-processing requests.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def update_batch(batch_id:, action:, model: nil)
+      raise ArgumentError.new("version must be provided") if version.nil?
+
       raise ArgumentError.new("batch_id must be provided") if batch_id.nil?
 
       raise ArgumentError.new("action must be provided") if action.nil?