retab 0.1.0

data/lib/retab/experiment_runs/experiment_run.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentRun < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      workflow: :workflow,
+      trigger: :trigger,
+      experiment_id: :experiment_id,
+      block_id: :block_id,
+      block_type: :block_type,
+      n_consensus: :n_consensus,
+      lifecycle: :lifecycle,
+      timing: :timing,
+      parent_run_id: :parent_run_id,
+      definition_fingerprint: :definition_fingerprint,
+      documents_fingerprint: :documents_fingerprint,
+      score: :score,
+      total_document_count: :total_document_count,
+      completed_document_count: :completed_document_count,
+      document_count: :document_count,
+      error_count: :error_count
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :workflow,
+      :trigger,
+      :experiment_id,
+      :block_id,
+      :block_type,
+      :n_consensus,
+      :lifecycle,
+      :timing,
+      :parent_run_id,
+      :definition_fingerprint,
+      :documents_fingerprint,
+      :score,
+      :total_document_count,
+      :completed_document_count,
+      :document_count,
+      :error_count
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @workflow = hash[:workflow] ? Retab::WorkflowSnapshotRef.new(hash[:workflow]) : nil
+      @trigger = hash[:trigger] ? Retab::ExperimentRunTrigger.new(hash[:trigger]) : nil
+      @experiment_id = hash[:experiment_id]
+      @block_id = hash[:block_id]
+      @block_type = hash[:block_type]
+      @n_consensus = hash[:n_consensus]
+      @lifecycle = hash[:lifecycle] ? (case hash[:lifecycle][:status] when "cancelled" then Retab::CancelledWorkflowExperimentRun.new(hash[:lifecycle]) when "completed" then Retab::CompletedWorkflowExperimentRun.new(hash[:lifecycle]) when "error" then Retab::ErrorWorkflowExperimentRun.new(hash[:lifecycle]) when "pending" then Retab::PendingWorkflowExperimentRun.new(hash[:lifecycle]) when "queued" then Retab::QueuedWorkflowExperimentRun.new(hash[:lifecycle]) when "running" then Retab::RunningWorkflowExperimentRun.new(hash[:lifecycle]) else hash[:lifecycle] end) : nil
+      @timing = hash[:timing] ? Retab::ExperimentRunTiming.new(hash[:timing]) : nil
+      @parent_run_id = hash[:parent_run_id]
+      @definition_fingerprint = hash[:definition_fingerprint]
+      @documents_fingerprint = hash[:documents_fingerprint]
+      @score = hash[:score]
+      @total_document_count = hash[:total_document_count]
+      @completed_document_count = hash[:completed_document_count]
+      @document_count = hash[:document_count]
+      @error_count = hash[:error_count]
+    end
+  end
+end

data/lib/retab/experiment_runs/experiment_run_timing.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentRunTiming < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      created_at: :created_at,
+      started_at: :started_at,
+      completed_at: :completed_at,
+      duration_ms: :duration_ms
+    }.freeze
+
+    attr_accessor \
+      :created_at,
+      :started_at,
+      :completed_at,
+      :duration_ms
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @created_at = hash[:created_at]
+      @started_at = hash[:started_at]
+      @completed_at = hash[:completed_at]
+      @duration_ms = hash[:duration_ms]
+    end
+  end
+end

data/lib/retab/experiment_runs/experiment_run_trigger.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentRunTrigger < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      type: :type
+    }.freeze
+
+    attr_accessor :type
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @type = hash[:type]
+    end
+  end
+end

data/lib/retab/experiment_runs/pending_workflow_experiment_run.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  PendingWorkflowExperimentRun = PendingRun
+end

data/lib/retab/experiment_runs/queued_workflow_experiment_run.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  QueuedWorkflowExperimentRun = QueuedStepLifecycle
+end

data/lib/retab/experiment_runs/running_workflow_experiment_run.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  RunningWorkflowExperimentRun = RunningRun
+end

data/lib/retab/experiment_runs.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class ExperimentRuns
+    def initialize(client)
+      @client = client
+    end
+
+    # List Experiment Runs
+    # @param workflow_id [String, nil]
+    # @param experiment_id [String, nil]
+    # @param block_id [String, nil]
+    # @param status [Retab::Types::WorkflowExperimentsStatus, nil]
+    # @param statuses [String, nil]
+    # @param exclude_status [Retab::Types::WorkflowExperimentsExcludeStatus, nil]
+    # @param trigger_type [String, nil]
+    # @param trigger_types [String, nil]
+    # @param from_date [String, nil]
+    # @param to_date [String, nil]
+    # @param sort_by [String, nil]
+    # @param fields [String, nil]
+    # @param before [String, nil]
+    # @param after [String, nil]
+    # @param limit [Integer, nil]
+    # @param order [Retab::Types::ExperimentRunsOrder, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::ExperimentRun>]
+    def list(
+      workflow_id: nil,
+      experiment_id: nil,
+      block_id: nil,
+      status: nil,
+      statuses: nil,
+      exclude_status: nil,
+      trigger_type: nil,
+      trigger_types: nil,
+      from_date: nil,
+      to_date: nil,
+      sort_by: 'created_at',
+      fields: nil,
+      before: nil,
+      after: nil,
+      limit: 20,
+      order: 'desc',
+      request_options: {}
+    )
+      params = {
+        'workflow_id' => workflow_id,
+        'experiment_id' => experiment_id,
+        'block_id' => block_id,
+        'status' => status,
+        'statuses' => statuses,
+        'exclude_status' => exclude_status,
+        'trigger_type' => trigger_type,
+        'trigger_types' => trigger_types,
+        'from_date' => from_date,
+        'to_date' => to_date,
+        'sort_by' => sort_by,
+        'fields' => fields,
+        'before' => before,
+        'after' => after,
+        'limit' => limit,
+        'order' => order
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/workflows/experiments/runs',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          workflow_id: workflow_id,
+          experiment_id: experiment_id,
+          block_id: block_id,
+          status: status,
+          statuses: statuses,
+          exclude_status: exclude_status,
+          trigger_type: trigger_type,
+          trigger_types: trigger_types,
+          from_date: from_date,
+          to_date: to_date,
+          sort_by: sort_by,
+          fields: fields,
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::ExperimentRun,
+        filters: { workflow_id: workflow_id, experiment_id: experiment_id, block_id: block_id, status: status, statuses: statuses, exclude_status: exclude_status, trigger_type: trigger_type, trigger_types: trigger_types, from_date: from_date, to_date: to_date, sort_by: sort_by, fields: fields, before: before, limit: limit, order: order },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Create Experiment Run Flat
+    # @param experiment_id [String] The experiment to create a run for.
+    # @param workflow_id [String, nil] Optional. When omitted, the workflow is derived from the experiment record. When supplied, must match the experiment's workflow_id (404 otherwise).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::ExperimentRun]
+    def create(
+      experiment_id:,
+      workflow_id: nil,
+      request_options: {}
+    )
+      body = {
+        'experiment_id' => experiment_id,
+        'workflow_id' => workflow_id
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/workflows/experiments/runs',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::ExperimentRun.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
+      result
+    end
+
+    # Get Experiment Run
+    # @param run_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::ExperimentRun]
+    def get(
+      run_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/experiments/runs/#{Retab::Util.encode_path(run_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::ExperimentRun.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
+      result
+    end
+
+    # Cancel Experiment Run
+    # @param run_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::CancelWorkflowExperimentRunResponse]
+    def cancel(
+      run_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/workflows/experiments/runs/#{Retab::Util.encode_path(run_id)}/cancel",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::CancelWorkflowExperimentRunResponse.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
+      result
+    end
+  end
+end

data/lib/retab/extractions/extraction.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class Extraction < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      file: :file,
+      model: :model,
+      json_schema: :json_schema,
+      n_consensus: :n_consensus,
+      image_resolution_dpi: :image_resolution_dpi,
+      instructions: :instructions,
+      output: :output,
+      consensus: :consensus,
+      metadata: :metadata,
+      usage: :usage,
+      created_at: :created_at
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :file,
+      :model,
+      :json_schema,
+      :n_consensus,
+      :image_resolution_dpi,
+      :instructions,
+      :output,
+      :consensus,
+      :metadata,
+      :usage,
+      :created_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @file = hash[:file] ? Retab::FileRef.new(hash[:file]) : nil
+      @model = hash[:model]
+      @json_schema = hash[:json_schema] || {}
+      @n_consensus = hash[:n_consensus]
+      @image_resolution_dpi = hash[:image_resolution_dpi]
+      @instructions = hash[:instructions]
+      @output = hash[:output] || {}
+      @consensus = hash[:consensus] ? Retab::ExtractionConsensus.new(hash[:consensus]) : nil
+      @metadata = hash[:metadata] || {}
+      @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
+      @created_at = hash[:created_at]
+    end
+  end
+end

data/lib/retab/extractions/extraction_consensus.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExtractionConsensus < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      choices: :choices,
+      likelihoods: :likelihoods
+    }.freeze
+
+    attr_accessor \
+      :choices,
+      :likelihoods
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @choices = (hash[:choices] || []).map { |item| item || {} }
+      @likelihoods = hash[:likelihoods] || {}
+    end
+  end
+end

data/lib/retab/extractions/extraction_request.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExtractionRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      document: :document,
+      json_schema: :json_schema,
+      model: :model,
+      image_resolution_dpi: :image_resolution_dpi,
+      instructions: :instructions,
+      n_consensus: :n_consensus,
+      metadata: :metadata,
+      additional_messages: :additional_messages,
+      bust_cache: :bust_cache,
+      stream: :stream
+    }.freeze
+
+    attr_accessor \
+      :document,
+      :json_schema,
+      :model,
+      :image_resolution_dpi,
+      :instructions,
+      :n_consensus,
+      :metadata,
+      :additional_messages,
+      :bust_cache,
+      :stream
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @document = hash[:document] ? Retab::MimeData.new(hash[:document]) : nil
+      @json_schema = hash[:json_schema] || {}
+      @model = hash[:model]
+      @image_resolution_dpi = hash[:image_resolution_dpi]
+      @instructions = hash[:instructions]
+      @n_consensus = hash[:n_consensus]
+      @metadata = hash[:metadata] || {}
+      @additional_messages = (hash[:additional_messages] || []).map { |item| item || {} }
+      @bust_cache = hash[:bust_cache]
+      @stream = hash[:stream]
+    end
+  end
+end

data/lib/retab/extractions/file_ref.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class FileRef < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      filename: :filename,
+      mime_type: :mime_type
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :filename,
+      :mime_type
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @filename = hash[:filename]
+      @mime_type = hash[:mime_type]
+    end
+  end
+end

data/lib/retab/extractions/retab_usage.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class RetabUsage < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      credits: :credits
+    }.freeze
+
+    attr_accessor :credits
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @credits = hash[:credits]
+    end
+  end
+end

data/lib/retab/extractions/sources_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class SourcesResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      object: :object,
+      extraction_id: :extraction_id,
+      document_type: :document_type,
+      file: :file,
+      extraction: :extraction,
+      sources: :sources
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :extraction_id,
+      :document_type,
+      :file,
+      :extraction,
+      :sources
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @extraction_id = hash[:extraction_id]
+      @document_type = hash[:document_type]
+      @file = hash[:file] ? Retab::FileRef.new(hash[:file]) : nil
+      @extraction = hash[:extraction] || {}
+      @sources = hash[:sources] || {}
+    end
+  end
+end