retab 0.1.0

data/lib/retab/partitions/partition_chunk.rb

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

data/lib/retab/partitions/partition_chunk_likelihood.rb

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

data/lib/retab/partitions/partition_consensus.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class PartitionConsensus < 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 || []).map { |item| item ? Retab::PartitionChunk.new(item) : nil } }
+      @likelihoods = (hash[:likelihoods] || []).map { |item| item ? Retab::PartitionChunkLikelihood.new(item) : nil }
+    end
+  end
+end

data/lib/retab/partitions/partition_request.rb

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

data/lib/retab/partitions.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class Partitions
+    def initialize(client)
+      @client = client
+    end
+
+    # List Partitions
+    # @param before [String, nil]
+    # @param after [String, nil]
+    # @param limit [Integer, nil]
+    # @param order [Retab::Types::PartitionsOrder, nil]
+    # @param filename [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::Partition>]
+    def list(
+      before: nil,
+      after: nil,
+      limit: 10,
+      order: 'desc',
+      filename: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        'before' => before,
+        'after' => after,
+        'limit' => limit,
+        'order' => order,
+        'filename' => filename,
+        'from_date' => from_date,
+        'to_date' => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/partitions',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          filename: filename,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::Partition,
+        filters: { before: before, limit: limit, order: order, filename: filename, from_date: from_date, to_date: to_date },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Create Partitions
+    # @param document [Retab::MimeData, Pathname, IO, String, Hash] The document to partition
+    # @param key [String] The key to partition the document by
+    # @param instructions [String] Instructions describing how the document should be partitioned
+    # @param model [String, nil] The model to use for partitioning
+    # @param n_consensus [Integer, nil] Number of partitioning runs to use for consensus voting. Uses deterministic single-pass when set to 1.
+    # @param allow_overlap [Boolean, nil] If true, allow a page to appear in more than one partition chunk
+    # @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::Partition]
+    def create(
+      document:,
+      key:,
+      instructions:,
+      model: nil,
+      n_consensus: nil,
+      allow_overlap: nil,
+      bust_cache: nil,
+      request_options: {}
+    )
+      document = Retab::MimeData.coerce(document) unless document.nil?
+      body = {
+        'document' => document,
+        'key' => key,
+        'instructions' => instructions,
+        'model' => model,
+        'n_consensus' => n_consensus,
+        'allow_overlap' => allow_overlap,
+        'bust_cache' => bust_cache
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/partitions',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::Partition.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 Partition
+    # @param partition_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Partition]
+    def get(
+      partition_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/partitions/#{Retab::Util.encode_path(partition_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::Partition.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 Partition
+    # @param partition_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete(
+      partition_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :delete,
+        path: "/v1/partitions/#{Retab::Util.encode_path(partition_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+  end
+end

data/lib/retab/schemas/generate_schema_request.rb

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

data/lib/retab/schemas/partial_schema.rb

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

data/lib/retab/schemas.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class Schemas
+    def initialize(client)
+      @client = client
+    end
+
+    # Generate Schema From Examples
+    # @param documents [Array<Retab::MimeData, Pathname, IO, String, Hash>]
+    # @param model [String, nil]
+    # @param reasoning_effort [Retab::Types::GenerateSchemaRequestReasoningEffort, nil]
+    # @param instructions [String, nil]
+    # @param image_resolution_dpi [Integer, nil] Resolution of the image sent to the LLM
+    # @param stream [Boolean, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PartialSchema]
+    def generate(
+      documents:,
+      model: nil,
+      reasoning_effort: nil,
+      instructions: nil,
+      image_resolution_dpi: nil,
+      stream: nil,
+      request_options: {}
+    )
+      documents = documents.map { |d| Retab::MimeData.coerce(d) } unless documents.nil?
+      body = {
+        'documents' => documents,
+        'model' => model,
+        'reasoning_effort' => reasoning_effort,
+        'instructions' => instructions,
+        'image_resolution_dpi' => image_resolution_dpi,
+        'stream' => stream
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/schemas/generate',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::PartialSchema.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/shared/http_validation_error.rb

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

data/lib/retab/shared/validation_error.rb

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

data/lib/retab/splits/split.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class Split < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      file: :file,
+      model: :model,
+      subdocuments: :subdocuments,
+      n_consensus: :n_consensus,
+      instructions: :instructions,
+      output: :output,
+      consensus: :consensus,
+      usage: :usage,
+      created_at: :created_at
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :file,
+      :model,
+      :subdocuments,
+      :n_consensus,
+      :instructions,
+      :output,
+      :consensus,
+      :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]
+      @subdocuments = (hash[:subdocuments] || []).map { |item| item ? Retab::Subdocument.new(item) : nil }
+      @n_consensus = hash[:n_consensus]
+      @instructions = hash[:instructions]
+      @output = (hash[:output] || []).map { |item| item ? Retab::SplitResult.new(item) : nil }
+      @consensus = hash[:consensus] ? Retab::SplitConsensus.new(hash[:consensus]) : nil
+      @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
+      @created_at = hash[:created_at]
+    end
+  end
+end

data/lib/retab/splits/split_consensus.rb

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

data/lib/retab/splits/split_request.rb

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

data/lib/retab/splits/split_result.rb

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

data/lib/retab/splits/split_subdocument_likelihood.rb

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

data/lib/retab/splits/subdocument.rb

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