retab 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 892cc7d33cd77ee2992206da231970259f4f0cf3668c762671b114b78116d1ee
-  data.tar.gz: 17e6a78b1858ab551518b0b379b92b4d54980e25565ce0d567504b17c2f0294c
+  metadata.gz: 567e2e76bac62e208e33807bd9106e8e2b03973a06a1d1f9bffb7c794efd4474
+  data.tar.gz: 94eb206cd48778a4f64be7ce9ac52c4f78e4c69a5b2277f6ba66dec5938726af
 SHA512:
-  metadata.gz: 653dc2782eee8ec927931b08da074dff4bceb322e7605a74ba14f2629cc6c9a8dca82c66de8748bc13e72a5cfc38c256b2b147844298b0c82000ccfa84c8d33e
-  data.tar.gz: 04d599b812516886ac4b0a2f3336af22d96418a40340da1412b45ed43e2b98733d2cbdbee41e35d70af30b7b4ea38df5c7651ef40ece0fba3a1a065b12d74237
+  metadata.gz: 2bdfce3ca56f7d285a347649e6c085b31ca780c43cd4a120f5d818cd47e3c114098b6264a0f3ca7edb9aa8625f460a0773b6dba7a3062b68a20c33521f18ebf9
+  data.tar.gz: '0169629387665c14a306b6f0869281c8531ccf9ea590629b381e8a2cdce9ed79f8d1a555f076c23b127d3c5c6115fb43bb0c348fe38c3a1365a3b0dacdcf4489'

data/lib/retab/client.rb

@@ -33,10 +33,18 @@ module Retab
       @schemas ||= Retab::Schemas.new(self)
     end
 
+    def secrets
+      @secrets ||= Retab::Secrets.new(self)
+    end
+
     def splits
       @splits ||= Retab::Splits.new(self)
     end
 
+    def tables
+      @tables ||= Retab::Tables.new(self)
+    end
+
     def workflows
       @workflows ||= Retab::Workflows.new(self)
     end

data/lib/retab/files/create_file_blueprint_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class CreateFileBlueprintRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      file_id: :file_id,
+      mode: :mode,
+      intent: :intent,
+      background: :background
+    }.freeze
+
+    attr_accessor(
+      :file_id,
+      :mode,
+      :intent,
+      :background
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @file_id = hash[:file_id]
+      @mode = hash[:mode]
+      @intent = hash[:intent]
+      @background = hash[:background].nil? ? false : hash[:background]
+    end
+  end
+end

data/lib/retab/files/file_blueprint.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class FileBlueprint < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      file: :file,
+      mode: :mode,
+      intent: :intent,
+      output: :output,
+      status: :status,
+      error: :error,
+      created_at: :created_at,
+      started_at: :started_at,
+      completed_at: :completed_at
+    }.freeze
+
+    attr_accessor(
+      :object,
+      :id,
+      :file,
+      :mode,
+      :intent,
+      :output,
+      :status,
+      :error,
+      :created_at,
+      :started_at,
+      :completed_at
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @object = hash[:object].nil? ? "file.blueprint" : hash[:object]
+      @id = hash[:id]
+      @file = hash[:file] ? Retab::FileRef.new(hash[:file]) : nil
+      @mode = hash[:mode]
+      @intent = hash[:intent]
+      @output = hash[:output] || {}
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
+      @created_at = hash[:created_at]
+      @started_at = hash[:started_at]
+      @completed_at = hash[:completed_at]
+    end
+  end
+end

data/lib/retab/files.rb

@@ -88,6 +88,94 @@ module Retab
       )
     end
 
+    # Create File Blueprint
+    # @param file_id [String] File id to analyze.
+    # @param mode [Retab::Types::CreateFileBlueprintRequestMode, nil] Optional analysis depth override. Omit to let Retab choose.
+    # @param intent [String, nil] Optional user intent used to guide the blueprint analysis.
+    # @param background [Boolean, nil] If true, run asynchronously: returns immediately with status 'queued' and an empty output. Poll GET /v1/<primitive>/{id} until status is terminal. Mutually exclusive with stream.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::FileBlueprint]
+    def create_blueprint(
+      file_id:,
+      mode: nil,
+      intent: nil,
+      background: nil,
+      request_options: {}
+    )
+      body = {
+        "file_id" => file_id,
+        "mode" => mode,
+        "intent" => intent,
+        "background" => background
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/v1/files/blueprints",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::FileBlueprint.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 File Blueprint
+    # @param blueprint_id [String]
+    # @param include_output [Boolean, nil] When false, returns a cheap status-only projection (no output), served from cache for in-flight background runs.
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::FileBlueprint]
+    def get_blueprint(
+      blueprint_id:,
+      include_output: true,
+      request_options: {}
+    )
+      params = {
+        "include_output" => include_output
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/files/blueprints/#{Retab::Util.encode_path(blueprint_id)}",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::FileBlueprint.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 File Blueprint
+    # @param blueprint_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::FileBlueprint]
+    def create_blueprint_cancel(
+      blueprint_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/files/blueprints/#{Retab::Util.encode_path(blueprint_id)}/cancel",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::FileBlueprint.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
+
     # Upload File
     # @param filename [String] Filename to store
     # @param content_type [String, nil] MIME type the client will upload

data/lib/retab/schemas/generate_schema_request.rb

@@ -10,7 +10,7 @@ module Retab
       model: :model,
       instructions: :instructions,
       image_resolution_dpi: :image_resolution_dpi,
-      stream: :stream
+      background: :background
     }.freeze
 
     attr_accessor(
@@ -18,7 +18,7 @@ module Retab
       :model,
       :instructions,
       :image_resolution_dpi,
-      :stream
+      :background
     )
 
     def initialize(json)
@@ -28,7 +28,7 @@ module Retab
       @model = hash[:model].nil? ? "retab-small" : hash[:model]
       @instructions = hash[:instructions]
       @image_resolution_dpi = hash[:image_resolution_dpi]
-      @stream = hash[:stream].nil? ? false : hash[:stream]
+      @background = hash[:background].nil? ? false : hash[:background]
     end
   end
 end

data/lib/retab/schemas/{partial_schema.rb → schema_generation.rb}

@@ -3,20 +3,26 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  class PartialSchema < Retab::Types::BaseModel
+  class SchemaGeneration < Retab::Types::BaseModel
 
     HASH_ATTRS = {
       object: :object,
       created_at: :created_at,
       json_schema: :json_schema,
-      strict: :strict
+      strict: :strict,
+      id: :id,
+      status: :status,
+      error: :error
     }.freeze
 
     attr_accessor(
       :object,
       :created_at,
       :json_schema,
-      :strict
+      :strict,
+      :id,
+      :status,
+      :error
     )
 
     def initialize(json)
@@ -26,6 +32,9 @@ module Retab
       @created_at = hash[:created_at]
       @json_schema = hash[:json_schema] || {}
       @strict = hash[:strict].nil? ? true : hash[:strict]
+      @id = hash[:id]
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
     end
   end
 end

data/lib/retab/schemas.rb

@@ -15,15 +15,15 @@ module Retab
     # @param model [String, nil]
     # @param instructions [String, nil]
     # @param image_resolution_dpi [Integer, nil] Resolution of the image sent to the LLM
-    # @param stream [Boolean, nil]
+    # @param background [Boolean, nil] If true, run asynchronously: returns immediately with status 'queued'. Poll GET /v1/schemas/generate/{schema_generation_id} until status is terminal.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
-    # @return [Retab::PartialSchema]
+    # @return [Retab::SchemaGeneration]
     def generate(
       documents:,
       model: nil,
       instructions: nil,
       image_resolution_dpi: nil,
-      stream: nil,
+      background: nil,
       request_options: {}
     )
       documents = documents.map { |d| Retab::MimeData.coerce(d) } unless documents.nil?
@@ -32,7 +32,7 @@ module Retab
         "model" => model,
         "instructions" => instructions,
         "image_resolution_dpi" => image_resolution_dpi,
-        "stream" => stream
+        "background" => background
       }.compact
       response = @client.request(
         method: :post,
@@ -41,7 +41,7 @@ module Retab
         body: body,
         request_options: request_options
       )
-      result = Retab::PartialSchema.new(response.body)
+      result = Retab::SchemaGeneration.new(response.body)
       result.last_response = Retab::Types::ApiResponse.new(
         http_status: response.code.to_i,
         http_headers: response.each_header.to_h,

data/lib/retab/secrets/create_secret_request.rb

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

data/lib/retab/secrets/secret.rb

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

data/lib/retab/secrets/secret_list_response.rb

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

data/lib/retab/secrets/secret_response.rb

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

data/lib/retab/secrets/secret_value.rb

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

data/lib/retab/secrets/secret_value_response.rb

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

data/lib/retab/secrets/set_secret_request.rb

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

data/lib/retab/secrets.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "json"
+
+module Retab
+  class Secrets
+    def initialize(client)
+      @client = client
+    end
+
+    # List Secrets
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::SecretListResponse]
+    def list_secrets(request_options: {})
+      response = @client.request(
+        method: :get,
+        path: "/v1/secrets",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::SecretListResponse.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
+
+    # Create Secret
+    # @param name [String]
+    # @param value [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::SecretResponse]
+    def create_secret(
+      name:,
+      value:,
+      request_options: {}
+    )
+      body = {
+        "name" => name,
+        "value" => value
+      }
+      response = @client.request(
+        method: :post,
+        path: "/v1/secrets",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::SecretResponse.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 Secret
+    # @param name [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::SecretResponse]
+    def get_secret(
+      name:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/secrets/#{Retab::Util.encode_path(name)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::SecretResponse.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
+
+    # Set Secret
+    # @param name [String]
+    # @param value [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::SecretResponse]
+    def update_secret(
+      name:,
+      value:,
+      request_options: {}
+    )
+      body = {
+        "value" => value
+      }
+      response = @client.request(
+        method: :put,
+        path: "/v1/secrets/#{Retab::Util.encode_path(name)}",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::SecretResponse.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 Secret
+    # @param name [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def delete_secret(
+      name:,
+      request_options: {}
+    )
+      @client.request(
+        method: :delete,
+        path: "/v1/secrets/#{Retab::Util.encode_path(name)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+
+    # Get Secret Value
+    # @param name [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::SecretValueResponse]
+    def list_secret_value(
+      name:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/secrets/#{Retab::Util.encode_path(name)}/value",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::SecretValueResponse.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/tables/body_create_table_v_1_tables_post.rb

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