retab 0.1.10 → 0.1.12

data/lib/retab/usage/usage_block_record.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsageBlockRecord < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      block_id: :block_id,
+      block_type: :block_type,
+      credits: :credits,
+      execution_count: :execution_count,
+      first_activity_at: :first_activity_at,
+      last_activity_at: :last_activity_at,
+      page_count: :page_count,
+      run_count: :run_count,
+      status_counts: :status_counts,
+      workflow_id: :workflow_id
+    }.freeze
+
+    attr_accessor(
+      :block_id,
+      :block_type,
+      :credits,
+      :execution_count,
+      :first_activity_at,
+      :last_activity_at,
+      :page_count,
+      :run_count,
+      :status_counts,
+      :workflow_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @block_id = hash[:block_id]
+      @block_type = hash[:block_type]
+      @credits = hash[:credits]
+      @execution_count = hash[:execution_count]
+      @first_activity_at = hash[:first_activity_at]
+      @last_activity_at = hash[:last_activity_at]
+      @page_count = hash[:page_count]
+      @run_count = hash[:run_count]
+      @status_counts = hash[:status_counts] || {}
+      @workflow_id = hash[:workflow_id]
+    end
+  end
+end

data/lib/retab/usage/usage_primitive_document.rb

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

data/lib/retab/usage/usage_primitive_record.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsagePrimitiveRecord < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      block_id: :block_id,
+      completed_at: :completed_at,
+      created_at: :created_at,
+      credits: :credits,
+      documents: :documents,
+      duration_ms: :duration_ms,
+      environment_id: :environment_id,
+      metadata: :metadata,
+      model: :model,
+      operation: :operation,
+      page_count: :page_count,
+      primitive_execution_id: :primitive_execution_id,
+      project_id: :project_id,
+      resource_kind: :resource_kind,
+      run_id: :run_id,
+      status: :status,
+      triggered_by: :triggered_by,
+      workflow_id: :workflow_id
+    }.freeze
+
+    attr_accessor(
+      :block_id,
+      :completed_at,
+      :created_at,
+      :credits,
+      :documents,
+      :duration_ms,
+      :environment_id,
+      :metadata,
+      :model,
+      :operation,
+      :page_count,
+      :primitive_execution_id,
+      :project_id,
+      :resource_kind,
+      :run_id,
+      :status,
+      :triggered_by,
+      :workflow_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @block_id = hash[:block_id]
+      @completed_at = hash[:completed_at]
+      @created_at = hash[:created_at]
+      @credits = hash[:credits]
+      @documents = (hash[:documents] || []).map { |item| item ? Retab::UsagePrimitiveDocument.new(item) : nil }
+      @duration_ms = hash[:duration_ms]
+      @environment_id = hash[:environment_id]
+      @metadata = hash[:metadata] || {}
+      @model = hash[:model]
+      @operation = hash[:operation]
+      @page_count = hash[:page_count]
+      @primitive_execution_id = hash[:primitive_execution_id]
+      @project_id = hash[:project_id]
+      @resource_kind = hash[:resource_kind]
+      @run_id = hash[:run_id]
+      @status = hash[:status]
+      @triggered_by = hash[:triggered_by] ? Retab::UsagePrimitiveTriggeredBy.new(hash[:triggered_by]) : nil
+      @workflow_id = hash[:workflow_id]
+    end
+  end
+end

data/lib/retab/usage/usage_primitive_triggered_by.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsagePrimitiveTriggeredBy < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      access_token_id: :access_token_id,
+      api_key_id: :api_key_id,
+      auth_method: :auth_method,
+      key_name: :key_name,
+      key_prefix: :key_prefix,
+      user_email: :user_email,
+      user_id: :user_id
+    }.freeze
+
+    attr_accessor(
+      :access_token_id,
+      :api_key_id,
+      :auth_method,
+      :key_name,
+      :key_prefix,
+      :user_email,
+      :user_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @access_token_id = hash[:access_token_id]
+      @api_key_id = hash[:api_key_id]
+      @auth_method = hash[:auth_method]
+      @key_name = hash[:key_name]
+      @key_prefix = hash[:key_prefix]
+      @user_email = hash[:user_email]
+      @user_id = hash[:user_id]
+    end
+  end
+end

data/lib/retab/usage/usage_run_record.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class UsageRunRecord < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      completed_at: :completed_at,
+      created_at: :created_at,
+      credits: :credits,
+      duration_ms: :duration_ms,
+      execution_duration_ms: :execution_duration_ms,
+      page_count: :page_count,
+      retry_count: :retry_count,
+      run_id: :run_id,
+      started_at: :started_at,
+      status: :status,
+      trigger_type: :trigger_type,
+      triggered_by: :triggered_by,
+      workflow_id: :workflow_id
+    }.freeze
+
+    attr_accessor(
+      :completed_at,
+      :created_at,
+      :credits,
+      :duration_ms,
+      :execution_duration_ms,
+      :page_count,
+      :retry_count,
+      :run_id,
+      :started_at,
+      :status,
+      :trigger_type,
+      :triggered_by,
+      :workflow_id
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @completed_at = hash[:completed_at]
+      @created_at = hash[:created_at]
+      @credits = hash[:credits]
+      @duration_ms = hash[:duration_ms]
+      @execution_duration_ms = hash[:execution_duration_ms]
+      @page_count = hash[:page_count]
+      @retry_count = hash[:retry_count]
+      @run_id = hash[:run_id]
+      @started_at = hash[:started_at]
+      @status = hash[:status]
+      @trigger_type = hash[:trigger_type]
+      @triggered_by = hash[:triggered_by] ? Retab::V1UsageUsageRunTriggeredBy.new(hash[:triggered_by]) : nil
+      @workflow_id = hash[:workflow_id]
+    end
+  end
+end

data/lib/retab/usage/v_1_usage_usage_run_triggered_by.rb

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

data/lib/retab/usage.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "json"
+
+module Retab
+  class Usage
+    def initialize(client)
+      @client = client
+    end
+
+    # List Usage Blocks
+    # @param limit [Integer, nil] Maximum number of block rows to return.
+    # @param order [Retab::Types::UsageOrder, nil] Sort direction on block id.
+    # @param before [String, nil] Return blocks before this cursor (opaque token from a prior page's list_metadata).
+    # @param after [String, nil] Return blocks after this cursor (opaque token from a prior page's list_metadata).
+    # @param workflow_id [String, nil] Filter to a single workflow id.
+    # @param block_type [String, nil] Filter by block type: extract, classify, split, parse, edit, or partition. These are the primitive-kind names recorded on the execution, which differ from the workflow block type enum (a classifier block records classify). An unknown value is rejected with 422.
+    # @param from_date [String, nil] Inclusive activity lower bound (YYYY-MM-DD, UTC).
+    # @param to_date [String, nil] Inclusive activity upper bound (YYYY-MM-DD, UTC).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::UsageBlockRecord>]
+    def list_blocks(
+      limit: 20,
+      order: "desc",
+      before: nil,
+      after: nil,
+      workflow_id: nil,
+      block_type: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        "limit" => limit,
+        "order" => order,
+        "before" => before,
+        "after" => after,
+        "workflow_id" => workflow_id,
+        "block_type" => block_type,
+        "from_date" => from_date,
+        "to_date" => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/usage/blocks",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_blocks(
+          limit: limit,
+          order: order,
+          before: before,
+          after: cursor,
+          workflow_id: workflow_id,
+          block_type: block_type,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::UsageBlockRecord,
+        filters: {
+          limit: limit,
+          order: order,
+          before: before,
+          workflow_id: workflow_id,
+          block_type: block_type,
+          from_date: from_date,
+          to_date: to_date
+        },
+        fetch_next: fetch_next
+      )
+    end
+
+    # List Usage Primitives
+    # @param limit [Integer, nil] Maximum number of execution rows to return.
+    # @param order [Retab::Types::UsageOrder, nil] Sort direction on execution created_at.
+    # @param before [String, nil] Return executions before this primitive-execution id (keyset cursor).
+    # @param after [String, nil] Return executions after this primitive-execution id (keyset cursor).
+    # @param environment_id [String, nil] Scope the export to this environment id within the caller's organization. Defaults to the authenticated identity's environment.
+    # @param workflow_id [String, nil] Filter to a single workflow id (origin workflow).
+    # @param project_id [String, nil] Filter to executions owned by a single project id.
+    # @param api_key_id [String, nil] Filter to executions triggered by a single API key id (the api_key_id returned under triggered_by).
+    # @param access_token_id [String, nil] Filter to executions triggered by a single access token id (the access_token_id returned under triggered_by).
+    # @param user_id [String, nil] Filter to executions triggered by a single user id (the user_id returned under triggered_by).
+    # @param run_id [String, nil] Filter to a single workflow run id (origin run).
+    # @param block_id [String, nil] Filter to a single workflow block id (origin block).
+    # @param operation [String, nil] Filter by operation: extraction, classify, split, parse, edit, partition, or schema_generation. The stored-kind aliases extract and classification are also accepted. An unknown value is rejected with 422.
+    # @param status [String, nil] Filter by execution lifecycle status: created, running, completed, failed, or canceled. Note the single-l spelling: a primitive execution is canceled, whereas a workflow run's status is cancelled. An unknown value is rejected with 422.
+    # @param metadata [String, nil] Filter by metadata equality: a JSON object of string key/value pairs (e.g. {"tenant":"acme"}). Pairs AND together.
+    # @param from_date [String, nil] Inclusive created_at lower bound (YYYY-MM-DD, UTC).
+    # @param to_date [String, nil] Inclusive created_at upper bound (YYYY-MM-DD, UTC).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::UsagePrimitiveRecord>]
+    def list_primitives(
+      limit: 20,
+      order: "desc",
+      before: nil,
+      after: nil,
+      environment_id: nil,
+      workflow_id: nil,
+      project_id: nil,
+      api_key_id: nil,
+      access_token_id: nil,
+      user_id: nil,
+      run_id: nil,
+      block_id: nil,
+      operation: nil,
+      status: nil,
+      metadata: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        "limit" => limit,
+        "order" => order,
+        "before" => before,
+        "after" => after,
+        "environment_id" => environment_id,
+        "workflow_id" => workflow_id,
+        "project_id" => project_id,
+        "api_key_id" => api_key_id,
+        "access_token_id" => access_token_id,
+        "user_id" => user_id,
+        "run_id" => run_id,
+        "block_id" => block_id,
+        "operation" => operation,
+        "status" => status,
+        "metadata" => metadata,
+        "from_date" => from_date,
+        "to_date" => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/usage/primitives",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_primitives(
+          limit: limit,
+          order: order,
+          before: before,
+          after: cursor,
+          environment_id: environment_id,
+          workflow_id: workflow_id,
+          project_id: project_id,
+          api_key_id: api_key_id,
+          access_token_id: access_token_id,
+          user_id: user_id,
+          run_id: run_id,
+          block_id: block_id,
+          operation: operation,
+          status: status,
+          metadata: metadata,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::UsagePrimitiveRecord,
+        filters: {
+          limit: limit,
+          order: order,
+          before: before,
+          environment_id: environment_id,
+          workflow_id: workflow_id,
+          project_id: project_id,
+          api_key_id: api_key_id,
+          access_token_id: access_token_id,
+          user_id: user_id,
+          run_id: run_id,
+          block_id: block_id,
+          operation: operation,
+          status: status,
+          metadata: metadata,
+          from_date: from_date,
+          to_date: to_date
+        },
+        fetch_next: fetch_next
+      )
+    end
+
+    # List Usage Runs
+    # @param limit [Integer, nil] Maximum number of run rows to return.
+    # @param order [Retab::Types::UsageOrder, nil] Sort direction on run created_at.
+    # @param before [String, nil] Return runs before this run id (keyset cursor).
+    # @param after [String, nil] Return runs after this run id (keyset cursor).
+    # @param workflow_id [String, nil] Filter to a single workflow id.
+    # @param status [String, nil] Filter by lifecycle status: pending, queued, running, completed, error, failed, awaiting_review, or cancelled.
+    # @param trigger_type [String, nil] Filter by trigger type: manual, api, schedule, webhook, email, or restart.
+    # @param from_date [String, nil] Inclusive created_at lower bound (YYYY-MM-DD, UTC).
+    # @param to_date [String, nil] Inclusive created_at upper bound (YYYY-MM-DD, UTC).
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::PaginatedList<Retab::UsageRunRecord>]
+    def list_runs(
+      limit: 20,
+      order: "desc",
+      before: nil,
+      after: nil,
+      workflow_id: nil,
+      status: nil,
+      trigger_type: nil,
+      from_date: nil,
+      to_date: nil,
+      request_options: {}
+    )
+      params = {
+        "limit" => limit,
+        "order" => order,
+        "before" => before,
+        "after" => after,
+        "workflow_id" => workflow_id,
+        "status" => status,
+        "trigger_type" => trigger_type,
+        "from_date" => from_date,
+        "to_date" => to_date
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/usage/runs",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = -> (cursor) {
+        list_runs(
+          limit: limit,
+          order: order,
+          before: before,
+          after: cursor,
+          workflow_id: workflow_id,
+          status: status,
+          trigger_type: trigger_type,
+          from_date: from_date,
+          to_date: to_date,
+          request_options: request_options
+        )
+      }
+      Retab::PaginatedList.from_response(
+        response,
+        model: Retab::UsageRunRecord,
+        filters: {
+          limit: limit,
+          order: order,
+          before: before,
+          workflow_id: workflow_id,
+          status: status,
+          trigger_type: trigger_type,
+          from_date: from_date,
+          to_date: to_date
+        },
+        fetch_next: fetch_next
+      )
+    end
+  end
+end

data/lib/retab/version.rb

@@ -5,5 +5,5 @@
 # @oagen-ignore-file
 
 module Retab
-  VERSION = "0.1.10"
+  VERSION = "0.1.12"
 end

data/lib/retab/workflow_experiments.rb

@@ -24,6 +24,7 @@ module Retab
 
     # List Experiments
     # @param workflow_id [String]
+    # @param block_id [String, nil]
     # @param before [String, nil]
     # @param after [String, nil]
     # @param limit [Integer, nil]
@@ -32,6 +33,7 @@ module Retab
     # @return [Retab::PaginatedList<Retab::WorkflowExperiment>]
     def list(
       workflow_id:,
+      block_id: nil,
       before: nil,
       after: nil,
       limit: 50,
@@ -40,6 +42,7 @@ module Retab
     )
       params = {
         "workflow_id" => workflow_id,
+        "block_id" => block_id,
         "before" => before,
         "after" => after,
         "limit" => limit,
@@ -55,6 +58,7 @@ module Retab
       fetch_next = -> (cursor) {
         list(
           workflow_id: workflow_id,
+          block_id: block_id,
           before: before,
           after: cursor,
           limit: limit,
@@ -65,7 +69,7 @@ module Retab
       Retab::PaginatedList.from_response(
         response,
         model: Retab::WorkflowExperiment,
-        filters: {workflow_id: workflow_id, before: before, limit: limit, order: order},
+        filters: {workflow_id: workflow_id, block_id: block_id, before: before, limit: limit, order: order},
         fetch_next: fetch_next
       )
     end

data/lib/retab/workflow_reviews/review.rb

@@ -67,8 +67,6 @@ module Retab
           Retab::ReviewCategoryIn.new(hash[:triggered_by])
         when "confidence_lt"
           Retab::ReviewConfidenceLt.new(hash[:triggered_by])
-        when "field_confidence_lt"
-          Retab::ReviewFieldConfidenceLt.new(hash[:triggered_by])
         when "json_condition"
           Retab::ReviewJsonCondition.new(hash[:triggered_by])
         when "split_count_neq"

data/lib/retab/workflow_reviews/review_all_of.rb

@@ -40,8 +40,6 @@ module Retab
             Retab::ReviewCategoryIn.new(item)
           when "confidence_lt"
             Retab::ReviewConfidenceLt.new(item)
-          when "field_confidence_lt"
-            Retab::ReviewFieldConfidenceLt.new(item)
           when "json_condition"
             Retab::ReviewJsonCondition.new(item)
           when "split_count_neq"

data/lib/retab/workflow_reviews/review_any_of.rb

@@ -40,8 +40,6 @@ module Retab
             Retab::ReviewCategoryIn.new(item)
           when "confidence_lt"
             Retab::ReviewConfidenceLt.new(item)
-          when "field_confidence_lt"
-            Retab::ReviewFieldConfidenceLt.new(item)
           when "json_condition"
             Retab::ReviewJsonCondition.new(item)
           when "split_count_neq"

data/lib/retab/workflow_runs/create_workflow_run_request.rb

@@ -9,14 +9,16 @@ module Retab
       workflow_id: :workflow_id,
       documents: :documents,
       json_inputs: :json_inputs,
-      version: :version
+      version: :version,
+      metadata: :metadata
     }.freeze
 
     attr_accessor(
       :workflow_id,
       :documents,
       :json_inputs,
-      :version
+      :version,
+      :metadata
     )
 
     def initialize(json)
@@ -26,6 +28,7 @@ module Retab
       @documents = hash[:documents] || {}
       @json_inputs = hash[:json_inputs] || {}
       @version = hash[:version].nil? ? "production" : hash[:version]
+      @metadata = hash[:metadata] || {}
     end
   end
 end

data/lib/retab/workflow_runs/workflow_run.rb

@@ -12,7 +12,8 @@ module Retab
       trigger: :trigger,
       lifecycle: :lifecycle,
       timing: :timing,
-      inputs: :inputs
+      inputs: :inputs,
+      metadata: :metadata
     }.freeze
 
     attr_accessor(
@@ -22,7 +23,8 @@ module Retab
       :trigger,
       :lifecycle,
       :timing,
-      :inputs
+      :inputs,
+      :metadata
     )
 
     def initialize(json)
@@ -52,6 +54,7 @@ module Retab
       ) : nil
       @timing = hash[:timing] ? Retab::RunTiming.new(hash[:timing]) : nil
       @inputs = hash[:inputs] ? Retab::RunInputs.new(hash[:inputs]) : nil
+      @metadata = hash[:metadata] || {}
     end
   end
 end