ibm_watson 0.9.2 → 0.10.0

data/lib/ibm_watson/assistant_v2.rb

@@ -101,14 +101,17 @@ module IBMWatson
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_session(assistant_id:)
-      raise ArgumentError("assistant_id must be provided") if assistant_id.nil?
+      raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v2/assistants/%s/sessions" % [ERB::Util.url_encode(assistant_id)]
+
       response = request(
         method: "POST",
         url: method_url,
@@ -132,16 +135,19 @@ module IBMWatson
     # @param session_id [String] Unique identifier of the session.
     # @return [nil]
     def delete_session(assistant_id:, session_id:)
-      raise ArgumentError("assistant_id must be provided") if assistant_id.nil?
+      raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
 
-      raise ArgumentError("session_id must be provided") if session_id.nil?
+      raise ArgumentError.new("session_id must be provided") if session_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v2/assistants/%s/sessions/%s" % [ERB::Util.url_encode(assistant_id), ERB::Util.url_encode(session_id)]
+
       request(
         method: "DELETE",
         url: method_url,
@@ -168,24 +174,28 @@ 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 input [MessageInput] The user input.
     # @param context [MessageContext] State information for the conversation.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def message(assistant_id:, session_id:, input: nil, context: nil)
-      raise ArgumentError("assistant_id must be provided") if assistant_id.nil?
+      raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
 
-      raise ArgumentError("session_id must be provided") if session_id.nil?
+      raise ArgumentError.new("session_id must be provided") if session_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       data = {
         "input" => input,
         "context" => context
       }
+
       method_url = "/v2/assistants/%s/sessions/%s/message" % [ERB::Util.url_encode(assistant_id), ERB::Util.url_encode(session_id)]
+
       response = request(
         method: "POST",
         url: method_url,

data/lib/ibm_watson/compare_comply_v1.rb

@@ -0,0 +1,653 @@
+# frozen_string_literal: true
+
+# Copyright 2018 IBM All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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 Watson™ Compare and Comply analyzes governing documents to provide details
+# about critical aspects of the documents.
+
+require "concurrent"
+require "erb"
+require "json"
+require_relative "./detailed_response"
+
+require_relative "./watson_service"
+
+# Module for the Watson APIs
+module IBMWatson
+  ##
+  # The Compare Comply V1 service.
+  class CompareComplyV1 < WatsonService
+    include Concurrent::Async
+    ##
+    # @!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 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.
+    # @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.
+    # @option args iam_access_token [String] An IAM access token is fully managed by the application.
+    #   Responsibility falls on the application to refresh the token, either before
+    #   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'.
+    def initialize(args = {})
+      @__async_initialized__ = false
+      defaults = {}
+      defaults[:version] = nil
+      defaults[:url] = "https://gateway.watsonplatform.net/compare-comply/api"
+      defaults[:iam_apikey] = nil
+      defaults[:iam_access_token] = nil
+      defaults[:iam_url] = nil
+      args = defaults.merge(args)
+      args[:vcap_services_name] = "compare-comply"
+      super
+      @version = args[:version]
+    end
+
+    #########################
+    # HTML conversion
+    #########################
+
+    ##
+    # @!method convert_to_html(file:, model_id: nil, file_content_type: nil, filename: nil)
+    # Convert file to HTML.
+    # Uploads an input file. The response includes an HTML version of the document.
+    # @param file [File] The file to convert.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/tables`
+    #   method, the default is `tables`. These defaults apply to the standalone methods as
+    #   well as to the methods' use in batch-processing requests.
+    # @param file_content_type [String] The content type of file.
+    # @param filename [String] The filename for file.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def convert_to_html(file:, model_id: nil, file_content_type: nil, filename: nil)
+      raise ArgumentError.new("file must be provided") if file.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "model_id" => model_id
+      }
+
+      form_data = {}
+
+      unless file.instance_of?(StringIO) || file.instance_of?(File)
+        file = file.respond_to?(:to_json) ? StringIO.new(file.to_json) : StringIO.new(file)
+      end
+      filename = file.path if filename.nil? && file.respond_to?(:path)
+      form_data[:file] = HTTP::FormData::File.new(file, content_type: file_content_type.nil? ? "application/octet-stream" : file_content_type, filename: filename)
+
+      method_url = "/v1/html_conversion"
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Element classification
+    #########################
+
+    ##
+    # @!method classify_elements(file:, model_id: nil, file_content_type: nil, filename: nil)
+    # Classify the elements of a document.
+    # Uploads a file. The response includes an analysis of the document's structural and
+    #   semantic elements.
+    # @param file [File] The file to classify.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/tables`
+    #   method, the default is `tables`. These defaults apply to the standalone methods as
+    #   well as to the methods' use in batch-processing requests.
+    # @param file_content_type [String] The content type of file.
+    # @param filename [String] The filename for file.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def classify_elements(file:, model_id: nil, file_content_type: nil, filename: nil)
+      raise ArgumentError.new("file must be provided") if file.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "model_id" => model_id
+      }
+
+      form_data = {}
+
+      unless file.instance_of?(StringIO) || file.instance_of?(File)
+        file = file.respond_to?(:to_json) ? StringIO.new(file.to_json) : StringIO.new(file)
+      end
+      filename = file.path if filename.nil? && file.respond_to?(:path)
+      form_data[:file] = HTTP::FormData::File.new(file, content_type: file_content_type.nil? ? "application/octet-stream" : file_content_type, filename: filename)
+
+      method_url = "/v1/element_classification"
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Tables
+    #########################
+
+    ##
+    # @!method extract_tables(file:, model_id: nil, file_content_type: nil, filename: nil)
+    # Extract a document's tables.
+    # Uploads a file. The response includes an analysis of the document's tables.
+    # @param file [File] The file on which to run table extraction.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/tables`
+    #   method, the default is `tables`. These defaults apply to the standalone methods as
+    #   well as to the methods' use in batch-processing requests.
+    # @param file_content_type [String] The content type of file.
+    # @param filename [String] The filename for file.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def extract_tables(file:, model_id: nil, file_content_type: nil, filename: nil)
+      raise ArgumentError.new("file must be provided") if file.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "model_id" => model_id
+      }
+
+      form_data = {}
+
+      unless file.instance_of?(StringIO) || file.instance_of?(File)
+        file = file.respond_to?(:to_json) ? StringIO.new(file.to_json) : StringIO.new(file)
+      end
+      filename = file.path if filename.nil? && file.respond_to?(:path)
+      form_data[:file] = HTTP::FormData::File.new(file, content_type: file_content_type.nil? ? "application/octet-stream" : file_content_type, filename: filename)
+
+      method_url = "/v1/tables"
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Comparison
+    #########################
+
+    ##
+    # @!method compare_documents(file_1:, file_2:, file_1_label: nil, file_2_label: nil, model_id: nil, file_1_content_type: nil, file_1_filename: nil, file_2_content_type: nil, file_2_filename: nil)
+    # Compare two documents.
+    # Uploads two input files. The response includes JSON comparing the two documents.
+    #   Uploaded files must be in the same file format.
+    # @param file_1 [File] The first file to compare.
+    # @param file_2 [File] The second file to compare.
+    # @param file_1_label [String] A text label for the first file.
+    # @param file_2_label [String] A text label for the second file.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/tables`
+    #   method, the default is `tables`. These defaults apply to the standalone methods as
+    #   well as to the methods' use in batch-processing requests.
+    # @param file_1_content_type [String] The content type of file_1.
+    # @param file_1_filename [String] The filename for file_1.
+    # @param file_2_content_type [String] The content type of file_2.
+    # @param file_2_filename [String] The filename for file_2.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def compare_documents(file_1:, file_2:, file_1_label: nil, file_2_label: nil, model_id: nil, file_1_content_type: nil, file_1_filename: nil, file_2_content_type: nil, file_2_filename: 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?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "file_1_label" => file_1_label,
+        "file_2_label" => file_2_label,
+        "model_id" => model_id
+      }
+
+      form_data = {}
+
+      unless file_1.instance_of?(StringIO) || file_1.instance_of?(File)
+        file_1 = file_1.respond_to?(:to_json) ? StringIO.new(file_1.to_json) : StringIO.new(file_1)
+      end
+      file_1_filename = file_1.path if file_1_filename.nil? && file_1.respond_to?(:path)
+      form_data[:file_1] = HTTP::FormData::File.new(file_1, content_type: file_1_content_type.nil? ? "application/octet-stream" : file_1_content_type, filename: file_1_filename)
+
+      unless file_2.instance_of?(StringIO) || file_2.instance_of?(File)
+        file_2 = file_2.respond_to?(:to_json) ? StringIO.new(file_2.to_json) : StringIO.new(file_2)
+      end
+      file_2_filename = file_2.path if file_2_filename.nil? && file_2.respond_to?(:path)
+      form_data[:file_2] = HTTP::FormData::File.new(file_2, content_type: file_2_content_type.nil? ? "application/octet-stream" : file_2_content_type, filename: file_2_filename)
+
+      method_url = "/v1/comparison"
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Feedback
+    #########################
+
+    ##
+    # @!method add_feedback(feedback_data:, user_id: nil, comment: nil)
+    # Add feedback.
+    # Adds feedback in the form of _labels_ from a subject-matter expert (SME) to a
+    #   governing document.
+    #   **Important:** Feedback is not immediately incorporated into the training model,
+    #   nor is it guaranteed to be incorporated at a later date. Instead, submitted
+    #   feedback is used to suggest future updates to the training model.
+    # @param feedback_data [FeedbackDataInput] Feedback data for submission.
+    # @param user_id [String] An optional string identifying the user.
+    # @param comment [String] An optional comment on or description of the feedback.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def add_feedback(feedback_data:, user_id: nil, comment: nil)
+      raise ArgumentError.new("feedback_data must be provided") if feedback_data.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "feedback_data" => feedback_data,
+        "user_id" => user_id,
+        "comment" => comment
+      }
+
+      method_url = "/v1/feedback"
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        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 documents.
+    # @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
+    #   specified `model_id`. The only permitted value is `contracts`.
+    # @param model_version [String] An optional string that filters the output to include only feedback with the
+    #   specified `model_version`.
+    # @param category_removed [String] An optional string in the form of a comma-separated list of categories. If this is
+    #   specified, the service filters the output to include only feedback that has at
+    #   least one category from the list removed.
+    # @param category_added [String] An optional string in the form of a comma-separated list of categories. If this is
+    #   specified, the service filters the output to include only feedback that has at
+    #   least one category from the list added.
+    # @param category_not_changed [String] An optional string in the form of a comma-separated list of categories. If this is
+    #   specified, the service filters the output to include only feedback that has at
+    #   least one category from the list unchanged.
+    # @param type_removed [String] An optional string of comma-separated `nature`:`party` pairs. If this is
+    #   specified, the service filters the output to include only feedback that has at
+    #   least one `nature`:`party` pair from the list removed.
+    # @param type_added [String] An optional string of comma-separated `nature`:`party` pairs. If this is
+    #   specified, the service filters the output to include only feedback that has at
+    #   least one `nature`:`party` pair from the list removed.
+    # @param type_not_changed [String] An optional string of comma-separated `nature`:`party` pairs. If this is
+    #   specified, the service filters the output to include only feedback that has at
+    #   least one `nature`:`party` pair from the list unchanged.
+    # @param page_limit [Fixnum] An optional integer specifying the number of documents that you want the service
+    #   to return.
+    # @param cursor [String] An optional string that returns the set of documents after the previous set. Use
+    #   this parameter with the `page_limit` parameter.
+    # @param sort [String] An optional comma-separated list of fields in the document to sort on. You can
+    #   optionally specify the sort direction by prefixing the value of the field with `-`
+    #   for descending order or `+` for ascending order (the default). Currently permitted
+    #   sorting fields are `created`, `user_id`, and `document_title`.
+    # @param include_total [Boolean] An optional boolean value. If specified as `true`, the `pagination` object in the
+    #   output includes a value called `total` that gives the total count of feedback
+    #   created.
+    # @return [DetailedResponse] A `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)
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "feedback_type" => feedback_type,
+        "before" => before,
+        "after" => after,
+        "document_title" => document_title,
+        "model_id" => model_id,
+        "model_version" => model_version,
+        "category_removed" => category_removed,
+        "category_added" => category_added,
+        "category_not_changed" => category_not_changed,
+        "type_removed" => type_removed,
+        "type_added" => type_added,
+        "type_not_changed" => type_not_changed,
+        "page_limit" => page_limit,
+        "cursor" => cursor,
+        "sort" => sort,
+        "include_total" => include_total
+      }
+
+      method_url = "/v1/feedback"
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method get_feedback(feedback_id:, model_id: nil)
+    # List a specified feedback entry.
+    # @param feedback_id [String] An string that specifies the feedback entry to be included in the output.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/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 [DetailedResponse] A `DetailedResponse` object representing the response.
+    def get_feedback(feedback_id:, model_id: nil)
+      raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "model_id" => model_id
+      }
+
+      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_id: nil)
+    # Deletes a specified feedback entry.
+    # @param feedback_id [String] An string that specifies the feedback entry to be deleted from the document.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/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 [DetailedResponse] A `DetailedResponse` object representing the response.
+    def delete_feedback(feedback_id:, model_id: nil)
+      raise ArgumentError.new("feedback_id must be provided") if feedback_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "model_id" => model_id
+      }
+
+      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
+    #########################
+
+    ##
+    # @!method create_batch(function:, input_credentials_file:, input_bucket_location:, input_bucket_name:, output_credentials_file:, output_bucket_location:, output_bucket_name:, model_id: nil, input_credentials_filename: nil, output_credentials_filename: 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://console.bluemix.net/docs/services/cloud-object-storage/about-cos.html#about-ibm-cloud-object-storage).
+    #   The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using
+    #   batch
+    #   processing](https://console.bluemix.net/docs/services/compare-comply/batching.html#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
+    #   `input_bucket_name` parameter.
+    # @param input_bucket_location [String] The geographical location of the Cloud Object Storage input bucket as listed on
+    #   the **Endpoint** tab of your Cloud Object Storage instance; for example, `us-geo`,
+    #   `eu-geo`, or `ap-geo`.
+    # @param input_bucket_name [String] The name of the Cloud Object Storage input bucket.
+    # @param output_credentials_file [File] A JSON file that lists the Cloud Object Storage output credentials. At a minimum,
+    #   the credentials must enable `READ` and `WRITE` permissions on the bucket defined
+    #   by the `output_bucket_name` parameter.
+    # @param output_bucket_location [String] The geographical location of the Cloud Object Storage output bucket as listed on
+    #   the **Endpoint** tab of your Cloud Object Storage instance; for example, `us-geo`,
+    #   `eu-geo`, or `ap-geo`.
+    # @param output_bucket_name [String] The name of the Cloud Object Storage output bucket.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/tables`
+    #   method, the default is `tables`. These defaults apply to the standalone methods as
+    #   well as to the methods' use in batch-processing requests.
+    # @param input_credentials_filename [String] The filename for input_credentials_file.
+    # @param output_credentials_filename [String] The filename for output_credentials_file.
+    # @return [DetailedResponse] A `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_id: nil, input_credentials_filename: nil, output_credentials_filename: 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?
+
+      raise ArgumentError.new("input_bucket_location must be provided") if input_bucket_location.nil?
+
+      raise ArgumentError.new("input_bucket_name must be provided") if input_bucket_name.nil?
+
+      raise ArgumentError.new("output_credentials_file must be provided") if output_credentials_file.nil?
+
+      raise ArgumentError.new("output_bucket_location must be provided") if output_bucket_location.nil?
+
+      raise ArgumentError.new("output_bucket_name must be provided") if output_bucket_name.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "function" => function,
+        "model_id" => model_id
+      }
+
+      form_data = {}
+
+      unless input_credentials_file.instance_of?(StringIO) || input_credentials_file.instance_of?(File)
+        input_credentials_file = input_credentials_file.respond_to?(:to_json) ? StringIO.new(input_credentials_file.to_json) : StringIO.new(input_credentials_file)
+      end
+      input_credentials_filename = input_credentials_file.path if input_credentials_filename.nil? && input_credentials_file.respond_to?(:path)
+      form_data[:input_credentials_file] = HTTP::FormData::File.new(input_credentials_file, content_type: "application/json", filename: input_credentials_filename)
+
+      form_data[:input_bucket_location] = HTTP::FormData::Part.new(input_bucket_location.to_s, content_type: "text/plain")
+
+      form_data[:input_bucket_name] = HTTP::FormData::Part.new(input_bucket_name.to_s, content_type: "text/plain")
+
+      unless output_credentials_file.instance_of?(StringIO) || output_credentials_file.instance_of?(File)
+        output_credentials_file = output_credentials_file.respond_to?(:to_json) ? StringIO.new(output_credentials_file.to_json) : StringIO.new(output_credentials_file)
+      end
+      output_credentials_filename = output_credentials_file.path if output_credentials_filename.nil? && output_credentials_file.respond_to?(:path)
+      form_data[:output_credentials_file] = HTTP::FormData::File.new(output_credentials_file, content_type: "application/json", filename: output_credentials_filename)
+
+      form_data[:output_bucket_location] = HTTP::FormData::Part.new(output_bucket_location.to_s, content_type: "text/plain")
+
+      form_data[:output_bucket_name] = HTTP::FormData::Part.new(output_bucket_name.to_s, content_type: "text/plain")
+
+      method_url = "/v1/batches"
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method list_batches
+    # Gets the list of submitted batch-processing jobs.
+    # Gets the list of batch-processing jobs submitted by users.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def list_batches
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v1/batches"
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method get_batch(batch_id:)
+    # Gets information about a specific batch-processing request.
+    # Gets information about a batch-processing request with a specified ID.
+    # @param batch_id [String] The ID of the batch-processing request whose information you want to retrieve.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def get_batch(batch_id:)
+      raise ArgumentError.new("batch_id must be provided") if batch_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v1/batches/%s" % [ERB::Util.url_encode(batch_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method update_batch(batch_id:, action:, model_id: nil)
+    # Updates a pending or active batch-processing request.
+    # Updates a pending or active batch-processing request. You can rescan the input
+    #   bucket to check for new documents or cancel a request.
+    # @param batch_id [String] The ID of the batch-processing request you want to update.
+    # @param action [String] The action you want to perform on the specified batch-processing request.
+    # @param model_id [String] The analysis model to be used by the service. For the `/v1/element_classification`
+    #   and `/v1/comparison` methods, the default is `contracts`. For the `/v1/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 [DetailedResponse] A `DetailedResponse` object representing the response.
+    def update_batch(batch_id:, action:, model_id: nil)
+      raise ArgumentError.new("batch_id must be provided") if batch_id.nil?
+
+      raise ArgumentError.new("action must be provided") if action.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version,
+        "action" => action,
+        "model_id" => model_id
+      }
+
+      method_url = "/v1/batches/%s" % [ERB::Util.url_encode(batch_id)]
+
+      response = request(
+        method: "PUT",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+  end
+end