retab 0.1.0

data/lib/retab/extractions.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class Extractions
+    def initialize(client)
+      @client = client
+    end
+
+    # List Extractions
+    # @param before [String, nil]
+    # @param after [String, nil]
+    # @param limit [Integer, nil]
+    # @param order [Retab::Types::ExtractionsOrder, nil]
+    # @param filename [String, nil]
+    # @param filename_regex [String, nil] Deprecated alias for prefix filename filtering. Regex patterns are rejected.
+    # @param filename_contains [String, nil] Plain text filename text search powered by Atlas Search when available.
+    # @param document_type [Array<String>, nil] Filter by document type. Can be repeated. Accepted values: bmp, csv, doc, docm, docx, dotm, dotx, eml, gif, heic, heif, htm, html, jpeg, jpg, json, md, mhtml, msg, odp, ods, odt, ots, ott, pdf, png, ppt, pptx, rtf, svg, tif, tiff, tsv, txt, webp, xlam, xls, xlsb, xlsm, xlsx, xltm, xltx, xml, yaml, yml.
+    # @param from_date [String, nil]
+    # @param to_date [String, nil]
+    # @param metadata [String, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::Extraction>]
+    def list(
+      before: nil,
+      after: nil,
+      limit: 10,
+      order: 'desc',
+      filename: nil,
+      filename_regex: nil,
+      filename_contains: nil,
+      document_type: nil,
+      from_date: nil,
+      to_date: nil,
+      metadata: nil,
+      request_options: {}
+    )
+      params = {
+        'before' => before,
+        'after' => after,
+        'limit' => limit,
+        'order' => order,
+        'filename' => filename,
+        'filename_regex' => filename_regex,
+        'filename_contains' => filename_contains,
+        'document_type' => document_type,
+        'from_date' => from_date,
+        'to_date' => to_date,
+        'metadata' => metadata
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/extractions',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          filename: filename,
+          filename_regex: filename_regex,
+          filename_contains: filename_contains,
+          document_type: document_type,
+          from_date: from_date,
+          to_date: to_date,
+          metadata: metadata,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::Extraction,
+        filters: { before: before, limit: limit, order: order, filename: filename, filename_regex: filename_regex, filename_contains: filename_contains, document_type: document_type, from_date: from_date, to_date: to_date, metadata: metadata },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Create Extraction
+    # @param document [Retab::MimeData, Pathname, IO, String, Hash]
+    # @param json_schema [Hash{String => Object}] JSON schema describing the structured output
+    # @param model [String, nil] The model to use for the extraction
+    # @param image_resolution_dpi [Integer, nil] Resolution of the image sent to the LLM
+    # @param instructions [String, nil] Free-form instructions appended to the system prompt to steer the extraction.
+    # @param n_consensus [Integer, nil] Number of consensus extraction runs to perform. Uses deterministic single-pass when set to 1.
+    # @param metadata [Hash{String => String}, nil] User-defined metadata to associate with this extraction
+    # @param additional_messages [Array<Hash{String => Object}>, nil] Additional chat messages forwarded to the extraction model.
+    # @param bust_cache [Boolean, nil] If true, skip the LLM cache and force a fresh completion
+    # @param stream [Boolean, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Extraction]
+    def create(
+      document:,
+      json_schema:,
+      model: nil,
+      image_resolution_dpi: nil,
+      instructions: nil,
+      n_consensus: nil,
+      metadata: nil,
+      additional_messages: nil,
+      bust_cache: nil,
+      stream: nil,
+      request_options: {}
+    )
+      document = Retab::MimeData.coerce(document) unless document.nil?
+      body = {
+        '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
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/extractions',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::Extraction.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 Extraction
+    # @param extraction_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Extraction]
+    def get(
+      extraction_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/extractions/#{Retab::Util.encode_path(extraction_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::Extraction.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 Extraction
+    # @param extraction_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete(
+      extraction_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :delete,
+        path: "/v1/extractions/#{Retab::Util.encode_path(extraction_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+
+    # Get Extraction Sources
+    # @param extraction_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::SourcesResponse]
+    def sources(
+      extraction_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/extractions/#{Retab::Util.encode_path(extraction_id)}/sources",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::SourcesResponse.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/files/complete_file_upload_request.rb

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

data/lib/retab/files/create_upload_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class CreateUploadResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      fileId: :file_id,
+      uploadUrl: :upload_url,
+      uploadMethod: :upload_method,
+      uploadHeaders: :upload_headers,
+      mimeData: :mime_data,
+      expiresAt: :expires_at
+    }.freeze
+
+    attr_accessor \
+      :file_id,
+      :upload_url,
+      :upload_method,
+      :upload_headers,
+      :mime_data,
+      :expires_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @file_id = hash[:fileId]
+      @upload_url = hash[:uploadUrl]
+      @upload_method = hash[:uploadMethod]
+      @upload_headers = hash[:uploadHeaders] || {}
+      @mime_data = hash[:mimeData] ? Retab::MimeData.new(hash[:mimeData]) : nil
+      @expires_at = hash[:expiresAt]
+    end
+  end
+end

data/lib/retab/files/file.rb

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

data/lib/retab/files/file_link.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class FileLink < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      download_url: :download_url,
+      expires_in: :expires_in,
+      filename: :filename,
+      mime_data: :mime_data
+    }.freeze
+
+    attr_accessor \
+      :download_url,
+      :expires_in,
+      :filename,
+      :mime_data
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @download_url = hash[:download_url]
+      @expires_in = hash[:expires_in]
+      @filename = hash[:filename]
+      @mime_data = hash[:mime_data] ? Retab::MimeData.new(hash[:mime_data]) : nil
+    end
+  end
+end

data/lib/retab/files/upload_file_request.rb

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

data/lib/retab/files.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class Files
+    def initialize(client)
+      @client = client
+    end
+
+    # Upload File
+    # @param filename [String] Filename to store
+    # @param content_type [String, nil] MIME type the client will upload
+    # @param size_bytes [Integer] Expected upload size in bytes
+    # @param sha_256 [String, nil] Optional SHA-256 checksum
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::CreateUploadResponse]
+    def upload(
+      filename:,
+      size_bytes:,
+      content_type: nil,
+      sha_256: nil,
+      request_options: {}
+    )
+      body = {
+        'filename' => filename,
+        'content_type' => content_type,
+        'size_bytes' => size_bytes,
+        'sha256' => sha_256
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: '/v1/files/upload',
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::CreateUploadResponse.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
+
+    # Complete Upload File
+    # @param file_id [String]
+    # @param sha_256 [String, nil] Optional SHA-256 checksum
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::MimeData]
+    def complete_upload(
+      file_id:,
+      sha_256: nil,
+      request_options: {}
+    )
+      body = {
+        'sha256' => sha_256
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/v1/files/upload/#{Retab::Util.encode_path(file_id)}/complete",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::MimeData.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
+
+    # List Files
+    # @param before [String, nil]
+    # @param after [String, nil]
+    # @param limit [Integer, nil] Items per page
+    # @param order [Retab::Types::FilesOrder, nil]
+    # @param filename [String, nil]
+    # @param mime_type [String, nil]
+    # @param from_date [String, nil]
+    # @param to_date [String, nil]
+    # @param include_embeddings [Boolean, nil] Include embeddings in the response
+    # @param sort_by [String, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::FileModel>]
+    def list(
+      before: nil,
+      after: nil,
+      limit: 10,
+      order: 'desc',
+      filename: nil,
+      mime_type: nil,
+      from_date: nil,
+      to_date: nil,
+      include_embeddings: false,
+      sort_by: 'created_at',
+      request_options: {}
+    )
+      params = {
+        'before' => before,
+        'after' => after,
+        'limit' => limit,
+        'order' => order,
+        'filename' => filename,
+        'mime_type' => mime_type,
+        'from_date' => from_date,
+        'to_date' => to_date,
+        'include_embeddings' => include_embeddings,
+        'sort_by' => sort_by
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/files',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list(
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          filename: filename,
+          mime_type: mime_type,
+          from_date: from_date,
+          to_date: to_date,
+          include_embeddings: include_embeddings,
+          sort_by: sort_by,
+          request_options: request_options
+        )
+      }
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::FileModel,
+        filters: { before: before, limit: limit, order: order, filename: filename, mime_type: mime_type, from_date: from_date, to_date: to_date, include_embeddings: include_embeddings, sort_by: sort_by },
+        fetch_next: fetch_next
+      )
+    end
+
+    # Get File
+    # @param file_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::FileModel]
+    def get(
+      file_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/files/#{Retab::Util.encode_path(file_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::FileModel.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
+
+    # Download Link
+    # @param file_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::FileLink]
+    def get_download_link(
+      file_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/files/#{Retab::Util.encode_path(file_id)}/download-link",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::FileLink.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/inflections.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# Zeitwerk inflection overrides for the Retab gem.
+# Maps file basenames to class/module names where the default
+# CamelCase inference disagrees with the canonical class name.
+RETAB_INFLECTIONS = {
+  "file" => "FileModel",
+  "mime" => "MimeData",
+  "retab" => "Retab"
+}.freeze

data/lib/retab/jobs/create_job_request.rb

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

data/lib/retab/jobs/job.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class Job < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      object: :object,
+      status: :status,
+      endpoint: :endpoint,
+      error: :error,
+      warnings: :warnings,
+      created_at: :created_at,
+      started_at: :started_at,
+      completed_at: :completed_at,
+      expires_at: :expires_at,
+      metadata: :metadata,
+      cancelled: :cancelled,
+      attempt_count: :attempt_count,
+      last_attempt_at: :last_attempt_at,
+      last_failure_code: :last_failure_code,
+      request: :request,
+      response: :response
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :object,
+      :status,
+      :endpoint,
+      :error,
+      :warnings,
+      :created_at,
+      :started_at,
+      :completed_at,
+      :expires_at,
+      :metadata,
+      :cancelled,
+      :attempt_count,
+      :last_attempt_at,
+      :last_failure_code,
+      :request,
+      :response
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @object = hash[:object]
+      @status = hash[:status]
+      @endpoint = hash[:endpoint]
+      @error = hash[:error] ? Retab::JobError.new(hash[:error]) : nil
+      @warnings = (hash[:warnings] || []).map { |item| item ? Retab::JobWarning.new(item) : nil }
+      @created_at = hash[:created_at]
+      @started_at = hash[:started_at]
+      @completed_at = hash[:completed_at]
+      @expires_at = hash[:expires_at]
+      @metadata = hash[:metadata] || {}
+      @cancelled = hash[:cancelled]
+      @attempt_count = hash[:attempt_count]
+      @last_attempt_at = hash[:last_attempt_at]
+      @last_failure_code = hash[:last_failure_code]
+      @request = hash[:request] || {}
+      @response = hash[:response] ? Retab::JobResponse.new(hash[:response]) : nil
+    end
+  end
+end

data/lib/retab/jobs/job_error.rb

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

data/lib/retab/jobs/job_response.rb

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

data/lib/retab/jobs/job_warning.rb

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