retab 0.1.0

data/lib/retab/edit_templates.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class EditTemplates
+    def initialize(client)
+      @client = client
+    end
+
+    # List Templates
+    # @param before [String, nil]
+    # @param after [String, nil]
+    # @param limit [Integer, nil]
+    # @param order [Retab::Types::EditTemplatesOrder, nil]
+    # @param name [String, nil]
+    # @param sort_by [String, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::EditTemplate>]
+    def list(
+      before: nil,
+      after: nil,
+      limit: 10,
+      order: 'desc',
+      name: nil,
+      sort_by: 'created_at',
+      request_options: {}
+    )
+      params = {
+        'before' => before,
+        'after' => after,
+        'limit' => limit,
+        'order' => order,
+        'name' => name,
+        'sort_by' => sort_by
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/edits/templates',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          name: name,
+          sort_by: sort_by,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::EditTemplate,
+        filters: { before: before, limit: limit, order: order, name: name, sort_by: sort_by },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Create Template
+    # @param name [String] Name of the template.
+    # @param document [Retab::MimeData, Pathname, IO, String, Hash] The PDF document to use as the empty template.
+    # @param form_fields [Array<Retab::FormField>] Form fields to attach to the template.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::EditTemplate]
+    def create(
+      name:,
+      document:,
+      form_fields:,
+      request_options: {}
+    )
+      document = Retab::MimeData.coerce(document) unless document.nil?
+      body = {
+        'name' => name,
+        'document' => document,
+        'form_fields' => form_fields
+      }
+      response = @client.request(
+        method: :post,
+        path: '/v1/edits/templates',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::EditTemplate.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 Template
+    # @param template_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::EditTemplate]
+    def get(
+      template_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/edits/templates/#{Retab::Util.encode_path(template_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::EditTemplate.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
+
+    # Update Template
+    # @param template_id [String]
+    # @param name [String, nil] New name for the template.
+    # @param form_fields [Array<Retab::FormField>, nil] Replacement list of form fields.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::EditTemplate]
+    def update(
+      template_id:,
+      name: nil,
+      form_fields: nil,
+      request_options: {}
+    )
+      body = {
+        'name' => name,
+        'form_fields' => form_fields
+      }.compact
+      response = @client.request(
+        method: :patch,
+        path: "/v1/edits/templates/#{Retab::Util.encode_path(template_id)}",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::EditTemplate.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
+
+    # Delete Template
+    # @param template_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete(
+      template_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :delete,
+        path: "/v1/edits/templates/#{Retab::Util.encode_path(template_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+  end
+end

data/lib/retab/edits/edit.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class Edit < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      file: :file,
+      model: :model,
+      instructions: :instructions,
+      config: :config,
+      template_id: :template_id,
+      output: :output,
+      usage: :usage,
+      created_at: :created_at
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :file,
+      :model,
+      :instructions,
+      :config,
+      :template_id,
+      :output,
+      :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]
+      @instructions = hash[:instructions]
+      @config = hash[:config] ? Retab::EditConfig.new(hash[:config]) : nil
+      @template_id = hash[:template_id]
+      @output = hash[:output] ? Retab::EditResult.new(hash[:output]) : nil
+      @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
+      @created_at = hash[:created_at]
+    end
+  end
+end

data/lib/retab/edits/edit_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class EditRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      instructions: :instructions,
+      document: :document,
+      template_id: :template_id,
+      model: :model,
+      config: :config,
+      bust_cache: :bust_cache
+    }.freeze
+
+    attr_accessor \
+      :instructions,
+      :document,
+      :template_id,
+      :model,
+      :config,
+      :bust_cache
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @instructions = hash[:instructions]
+      @document = hash[:document] ? Retab::MimeData.new(hash[:document]) : nil
+      @template_id = hash[:template_id]
+      @model = hash[:model]
+      @config = hash[:config] ? Retab::EditConfig.new(hash[:config]) : nil
+      @bust_cache = hash[:bust_cache]
+    end
+  end
+end

data/lib/retab/edits.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class Edits
+    def initialize(client)
+      @client = client
+    end
+
+    # List Edits
+    # @param before [String, nil]
+    # @param after [String, nil]
+    # @param limit [Integer, nil]
+    # @param order [Retab::Types::EditsOrder, nil]
+    # @param filename [String, nil]
+    # @param template_id [String, nil]
+    # @param from_date [String, nil]
+    # @param to_date [String, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::Edit>]
+    def list(
+      before: nil,
+      after: nil,
+      limit: 10,
+      order: 'desc',
+      filename: nil,
+      template_id: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        'before' => before,
+        'after' => after,
+        'limit' => limit,
+        'order' => order,
+        'filename' => filename,
+        'template_id' => template_id,
+        'from_date' => from_date,
+        'to_date' => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/edits',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          filename: filename,
+          template_id: template_id,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::Edit,
+        filters: { before: before, limit: limit, order: order, filename: filename, template_id: template_id, from_date: from_date, to_date: to_date },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Create Edit
+    # @param instructions [String] Instructions describing how to fill the form fields.
+    # @param document [Retab::MimeData, Pathname, IO, String, Hash, nil] Input document (PDF, DOCX, XLSX, or PPTX). Mutually exclusive with template_id.
+    # @param template_id [String, nil] EditTemplate id to fill. When provided, uses the template's pre-defined form fields and empty PDF. Mutually exclusive with document.
+    # @param model [String, nil] The model to use for edit inference.
+    # @param config [Retab::EditConfig, nil] Edit configuration (rendering options).
+    # @param bust_cache [Boolean, nil] If true, skip the LLM cache and force a fresh completion.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Edit]
+    def create(
+      instructions:,
+      document: nil,
+      template_id: nil,
+      model: nil,
+      config: nil,
+      bust_cache: nil,
+      request_options: {}
+    )
+      document = Retab::MimeData.coerce(document) unless document.nil?
+      body = {
+        'instructions' => instructions,
+        'document' => document,
+        'template_id' => template_id,
+        'model' => model,
+        'config' => config,
+        'bust_cache' => bust_cache
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/edits',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::Edit.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 Edit
+    # @param edit_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Edit]
+    def get(
+      edit_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/edits/#{Retab::Util.encode_path(edit_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::Edit.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
+
+    # Delete Edit
+    # @param edit_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete(
+      edit_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :delete,
+        path: "/v1/edits/#{Retab::Util.encode_path(edit_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+  end
+end

data/lib/retab/errors.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# @oagen-ignore-file
+#
+# Hand-maintained error hierarchy. Mirrors what the WorkOS Ruby SDK ships;
+# the spec-driven resources reference these class names directly.
+
+module Retab
+  class Error < StandardError
+    attr_reader :http_status, :request_id, :code, :message_body
+
+    def initialize(message: nil, http_status: nil, request_id: nil, code: nil, body: nil)
+      super(message)
+      @http_status = http_status
+      @request_id = request_id
+      @code = code
+      @message_body = body
+    end
+  end
+
+  # Raised when a 4xx/5xx response cannot be mapped to a more specific error.
+  class APIError < Error
+  end
+
+  class AuthenticationError < APIError
+  end
+
+  class AuthorizationError < APIError
+  end
+
+  class NotFoundError < APIError
+  end
+
+  class BadRequestError < APIError
+  end
+
+  class ConflictError < APIError
+  end
+
+  class UnprocessableEntityError < APIError
+  end
+
+  class RateLimitExceededError < APIError
+  end
+
+  class InternalServerError < APIError
+  end
+
+  class TimeoutError < Error
+  end
+
+  class ConfigurationError < Error
+  end
+end

data/lib/retab/experiment_run_metrics/experiment_by_document_metrics_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentByDocumentMetricsResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      run_id: :run_id,
+      kind: :kind,
+      view: :view,
+      document: :document,
+      score: :score,
+      prior_score: :prior_score,
+      confusion: :confusion,
+      targets: :targets
+    }.freeze
+
+    attr_accessor \
+      :run_id,
+      :kind,
+      :view,
+      :document,
+      :score,
+      :prior_score,
+      :confusion,
+      :targets
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @run_id = hash[:run_id]
+      @kind = hash[:kind]
+      @view = hash[:view]
+      @document = hash[:document] ? Retab::ExperimentMetricDocumentRef.new(hash[:document]) : nil
+      @score = hash[:score]
+      @prior_score = hash[:prior_score]
+      @confusion = hash[:confusion] ? Retab::ExperimentDocumentConfusionMetric.new(hash[:confusion]) : nil
+      @targets = (hash[:targets] || []).map { |item| item ? Retab::ExperimentByDocumentTargetMetric.new(item) : nil }
+    end
+  end
+end

data/lib/retab/experiment_run_metrics/experiment_by_document_target_metric.rb

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

data/lib/retab/experiment_run_metrics/experiment_by_target_document_metric.rb

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

data/lib/retab/experiment_run_metrics/experiment_by_target_metrics_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentByTargetMetricsResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      run_id: :run_id,
+      kind: :kind,
+      view: :view,
+      target: :target,
+      score: :score,
+      prior_score: :prior_score,
+      confusion: :confusion,
+      documents: :documents
+    }.freeze
+
+    attr_accessor \
+      :run_id,
+      :kind,
+      :view,
+      :target,
+      :score,
+      :prior_score,
+      :confusion,
+      :documents
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @run_id = hash[:run_id]
+      @kind = hash[:kind]
+      @view = hash[:view]
+      @target = hash[:target]
+      @score = hash[:score]
+      @prior_score = hash[:prior_score]
+      @confusion = hash[:confusion] ? Retab::ExperimentTargetConfusionMetric.new(hash[:confusion]) : nil
+      @documents = (hash[:documents] || []).map { |item| item ? Retab::ExperimentByTargetDocumentMetric.new(item) : nil }
+    end
+  end
+end

data/lib/retab/experiment_run_metrics/experiment_confusion_flow_metric.rb

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

data/lib/retab/experiment_run_metrics/experiment_confusion_summary_aggregate.rb

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

data/lib/retab/experiment_run_metrics/experiment_document_confusion_metric.rb

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

data/lib/retab/experiment_run_metrics/experiment_extract_summary_aggregate.rb

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

data/lib/retab/experiment_run_metrics/experiment_metric_document_ref.rb

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