retab 0.1.0

data/lib/retab/experiment_run_metrics/experiment_metrics_missing_error.rb

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

data/lib/retab/experiment_run_metrics/experiment_metrics_stale_error.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentMetricsStaleError < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      kind: :kind,
+      error: :error,
+      experiment_id: :experiment_id,
+      stale_reasons: :stale_reasons,
+      last_run: :last_run,
+      current_config_fingerprint: :current_config_fingerprint,
+      message: :message
+    }.freeze
+
+    attr_accessor \
+      :kind,
+      :error,
+      :experiment_id,
+      :stale_reasons,
+      :last_run,
+      :current_config_fingerprint,
+      :message
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @kind = hash[:kind]
+      @error = hash[:error]
+      @experiment_id = hash[:experiment_id]
+      @stale_reasons = (hash[:stale_reasons] || [])
+      @last_run = hash[:last_run] ? Retab::MetricsStaleErrorLastRun.new(hash[:last_run]) : nil
+      @current_config_fingerprint = hash[:current_config_fingerprint]
+      @message = hash[:message]
+    end
+  end
+end

data/lib/retab/experiment_run_metrics/experiment_summary_metric_document.rb

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

data/lib/retab/experiment_run_metrics/experiment_summary_metrics_response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentSummaryMetricsResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      experiment_id: :experiment_id,
+      run_id: :run_id,
+      kind: :kind,
+      view: :view,
+      definition_fingerprint: :definition_fingerprint,
+      block_type: :block_type,
+      score: :score,
+      prior_score: :prior_score,
+      documents: :documents,
+      aggregate: :aggregate,
+      prior_run_id: :prior_run_id
+    }.freeze
+
+    attr_accessor \
+      :experiment_id,
+      :run_id,
+      :kind,
+      :view,
+      :definition_fingerprint,
+      :block_type,
+      :score,
+      :prior_score,
+      :documents,
+      :aggregate,
+      :prior_run_id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @experiment_id = hash[:experiment_id]
+      @run_id = hash[:run_id]
+      @kind = hash[:kind]
+      @view = hash[:view]
+      @definition_fingerprint = hash[:definition_fingerprint]
+      @block_type = hash[:block_type]
+      @score = hash[:score]
+      @prior_score = hash[:prior_score]
+      @documents = (hash[:documents] || []).map { |item| item ? Retab::ExperimentSummaryMetricDocument.new(item) : nil }
+      @aggregate = hash[:aggregate] ? Retab::ExperimentExtractSummaryAggregate.new(hash[:aggregate]) : nil
+      @prior_run_id = hash[:prior_run_id]
+    end
+  end
+end

data/lib/retab/experiment_run_metrics/experiment_target_confusion_metric.rb

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

data/lib/retab/experiment_run_metrics/experiment_vote_row.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentVoteRow < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      consensus: :consensus,
+      votes: :votes,
+      score: :score,
+      row_presence_score: :row_presence_score,
+      present_voter_count: :present_voter_count,
+      total_voter_count: :total_voter_count
+    }.freeze
+
+    attr_accessor \
+      :consensus,
+      :votes,
+      :score,
+      :row_presence_score,
+      :present_voter_count,
+      :total_voter_count
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @consensus = hash[:consensus]
+      @votes = (hash[:votes] || [])
+      @score = hash[:score]
+      @row_presence_score = hash[:row_presence_score]
+      @present_voter_count = hash[:present_voter_count]
+      @total_voter_count = hash[:total_voter_count]
+    end
+  end
+end

data/lib/retab/experiment_run_metrics/experiment_votes_metric_document.rb

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

data/lib/retab/experiment_run_metrics/experiment_votes_metrics_response.rb

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

data/lib/retab/experiment_run_metrics/metrics_stale_error_last_run.rb

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

data/lib/retab/experiment_run_metrics.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class ExperimentRunMetrics
+    def initialize(client)
+      @client = client
+    end
+
+    # Get Experiment Metrics For Run
+    # @param run_id [String]
+    # @param view [Retab::Types::ExperimentRunMetricsView, nil]
+    # @param document_id [String, nil]
+    # @param target_path [String, nil]
+    # @param include_prior [Boolean, nil]
+    # @param prior_run_id [String, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::ExperimentSummaryMetricsResponse, Retab::ExperimentByDocumentMetricsResponse, Retab::ExperimentByTargetMetricsResponse, Retab::ExperimentVotesMetricsResponse, Retab::ExperimentMetricsStaleError, Retab::ExperimentMetricsMissingError]
+    def get(
+      run_id:,
+      view: 'summary',
+      document_id: nil,
+      target_path: nil,
+      include_prior: true,
+      prior_run_id: nil,
+      request_options: {}
+    )
+      params = {
+        'run_id' => run_id,
+        'view' => view,
+        'document_id' => document_id,
+        'target_path' => target_path,
+        'include_prior' => include_prior,
+        'prior_run_id' => prior_run_id
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/workflows/experiments/metrics',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/retab/experiment_run_results/cancelled_workflow_experiment_result.rb

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

data/lib/retab/experiment_run_results/completed_workflow_experiment_result.rb

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

data/lib/retab/experiment_run_results/error_workflow_experiment_result.rb

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

data/lib/retab/experiment_run_results/experiment_result.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class ExperimentResult < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      run_id: :run_id,
+      experiment_id: :experiment_id,
+      document_id: :document_id,
+      lifecycle: :lifecycle,
+      timing: :timing,
+      block_type: :block_type,
+      handle_inputs: :handle_inputs,
+      artifact: :artifact,
+      attempt: :attempt,
+      is_placeholder: :is_placeholder
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :run_id,
+      :experiment_id,
+      :document_id,
+      :lifecycle,
+      :timing,
+      :block_type,
+      :handle_inputs,
+      :artifact,
+      :attempt,
+      :is_placeholder
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @run_id = hash[:run_id]
+      @experiment_id = hash[:experiment_id]
+      @document_id = hash[:document_id]
+      @lifecycle = hash[:lifecycle] ? (case hash[:lifecycle][:status] when "cancelled" then Retab::CancelledWorkflowExperimentResult.new(hash[:lifecycle]) when "completed" then Retab::CompletedWorkflowExperimentResult.new(hash[:lifecycle]) when "error" then Retab::ErrorWorkflowExperimentResult.new(hash[:lifecycle]) when "pending" then Retab::PendingWorkflowExperimentResult.new(hash[:lifecycle]) when "queued" then Retab::QueuedWorkflowExperimentResult.new(hash[:lifecycle]) when "running" then Retab::RunningWorkflowExperimentResult.new(hash[:lifecycle]) else hash[:lifecycle] end) : nil
+      @timing = hash[:timing] ? Retab::ExperimentResultTiming.new(hash[:timing]) : nil
+      @block_type = hash[:block_type]
+      @handle_inputs = hash[:handle_inputs] || {}
+      @artifact = hash[:artifact] ? Retab::StepArtifactRef.new(hash[:artifact]) : nil
+      @attempt = hash[:attempt]
+      @is_placeholder = hash[:is_placeholder]
+    end
+  end
+end

data/lib/retab/experiment_run_results/experiment_result_timing.rb

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

data/lib/retab/experiment_run_results/pending_workflow_experiment_result.rb

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

data/lib/retab/experiment_run_results/queued_workflow_experiment_result.rb

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

data/lib/retab/experiment_run_results/running_workflow_experiment_result.rb

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

data/lib/retab/experiment_run_results.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require 'json'
+
+module Retab
+  class ExperimentRunResults
+    def initialize(client)
+      @client = client
+    end
+
+    # List Experiment Results
+    # @param run_id [String]
+    # @param limit [Integer, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Types::ListStruct<Retab::ExperimentResult>]
+    def list(
+      run_id:,
+      limit: 100,
+      request_options: {}
+    )
+      params = {
+        'run_id' => run_id,
+        'limit' => limit
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: '/v1/workflows/experiments/results',
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      Retab::Types::ListStruct.from_response(
+        response,
+        model: Retab::ExperimentResult,
+        filters: { run_id: run_id, limit: limit }
+      )
+    end
+
+    # Get Experiment Result
+    # @param result_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::ExperimentResult]
+    def get(
+      result_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/v1/workflows/experiments/results/#{Retab::Util.encode_path(result_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::ExperimentResult.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/experiment_runs/cancel_workflow_experiment_run_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class CancelWorkflowExperimentRunResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      id: :id,
+      lifecycle: :lifecycle
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :lifecycle
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @lifecycle = hash[:lifecycle] ? (case hash[:lifecycle][:status] when "cancelled" then Retab::CancelledWorkflowExperimentRun.new(hash[:lifecycle]) when "completed" then Retab::CompletedWorkflowExperimentRun.new(hash[:lifecycle]) when "error" then Retab::ErrorWorkflowExperimentRun.new(hash[:lifecycle]) when "pending" then Retab::PendingWorkflowExperimentRun.new(hash[:lifecycle]) when "queued" then Retab::QueuedWorkflowExperimentRun.new(hash[:lifecycle]) when "running" then Retab::RunningWorkflowExperimentRun.new(hash[:lifecycle]) else hash[:lifecycle] end) : nil
+    end
+  end
+end

data/lib/retab/experiment_runs/cancelled_workflow_experiment_run.rb

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

data/lib/retab/experiment_runs/completed_workflow_experiment_run.rb

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

data/lib/retab/experiment_runs/create_experiment_run_request.rb

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

data/lib/retab/experiment_runs/error_workflow_experiment_run.rb

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