deeprails 0.1.0

data/lib/deeprails/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Internal
+    extend Deeprails::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Deeprails::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Deeprails::FilePart) }
+    end
+  end
+end

data/lib/deeprails/models/api_response.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#create
+    class APIResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute success
+      #   Represents whether the request was completed successfully.
+      #
+      #   @return [Boolean]
+      required :success, Deeprails::Internal::Type::Boolean
+
+      # @!attribute data
+      #   Response payload for creating or updating a monitor.
+      #
+      #   @return [Deeprails::Models::APIResponse::Data, nil]
+      optional :data, -> { Deeprails::APIResponse::Data }
+
+      # @!attribute message
+      #   The accompanying message for the request. Includes error details when
+      #   applicable.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!method initialize(success:, data: nil, message: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::APIResponse} for more details.
+      #
+      #   Response wrapper for operations returning a MonitorResponse.
+      #
+      #   @param success [Boolean] Represents whether the request was completed successfully.
+      #
+      #   @param data [Deeprails::Models::APIResponse::Data] Response payload for creating or updating a monitor.
+      #
+      #   @param message [String] The accompanying message for the request. Includes error details when applicable
+
+      # @see Deeprails::Models::APIResponse#data
+      class Data < Deeprails::Internal::Type::BaseModel
+        # @!attribute monitor_id
+        #   A unique monitor ID.
+        #
+        #   @return [String]
+        required :monitor_id, String
+
+        # @!attribute name
+        #   Name of the monitor.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute created_at
+        #   The time the monitor was created in UTC.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute description
+        #   Description of the monitor.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute monitor_status
+        #   Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+        #   longer record and evaluate events.
+        #
+        #   @return [Symbol, Deeprails::Models::APIResponse::Data::MonitorStatus, nil]
+        optional :monitor_status, enum: -> { Deeprails::APIResponse::Data::MonitorStatus }
+
+        # @!attribute updated_at
+        #   The most recent time the monitor was modified in UTC.
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!attribute user_id
+        #   User ID of the user who created the monitor.
+        #
+        #   @return [String, nil]
+        optional :user_id, String
+
+        # @!method initialize(monitor_id:, name:, created_at: nil, description: nil, monitor_status: nil, updated_at: nil, user_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Deeprails::Models::APIResponse::Data} for more details.
+        #
+        #   Response payload for creating or updating a monitor.
+        #
+        #   @param monitor_id [String] A unique monitor ID.
+        #
+        #   @param name [String] Name of the monitor.
+        #
+        #   @param created_at [Time] The time the monitor was created in UTC.
+        #
+        #   @param description [String] Description of the monitor.
+        #
+        #   @param monitor_status [Symbol, Deeprails::Models::APIResponse::Data::MonitorStatus] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+        #
+        #   @param updated_at [Time] The most recent time the monitor was modified in UTC.
+        #
+        #   @param user_id [String] User ID of the user who created the monitor.
+
+        # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+        # longer record and evaluate events.
+        #
+        # @see Deeprails::Models::APIResponse::Data#monitor_status
+        module MonitorStatus
+          extend Deeprails::Internal::Type::Enum
+
+          ACTIVE = :active
+          INACTIVE = :inactive
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/deeprails/models/defend_create_workflow_params.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#create_workflow
+    class DefendCreateWorkflowParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!attribute improvement_action
+      #   The action used to improve outputs that fail one or guardrail metrics for the
+      #   workflow events. May be `regenerate`, `fixit`, or null which represents “do
+      #   nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      #   Fixit attempts to directly address the shortcomings of the output using the
+      #   guardrail failure rationale. Do nothing does not attempt any improvement.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction, nil]
+      required :improvement_action,
+               enum: -> { Deeprails::DefendCreateWorkflowParams::ImprovementAction },
+               nil?: true
+
+      # @!attribute metrics
+      #   Mapping of guardrail metrics to floating point threshold values. If the workflow
+      #   type is automatic, only the metric names are used (`automatic_tolerance`
+      #   determines thresholds). Possible metrics are `correctness`, `completeness`,
+      #   `instruction_adherence`, `context_adherence`, `ground_truth_adherence`, or
+      #   `comprehensive_safety`.
+      #
+      #   @return [Hash{Symbol=>Float}]
+      required :metrics, Deeprails::Internal::Type::HashOf[Float]
+
+      # @!attribute name
+      #   Name of the workflow.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #   Type of thresholds to use for the workflow, either `automatic` or `custom`.
+      #   Automatic thresholds are assigned internally after the user specifies a
+      #   qualitative tolerance for the metrics, whereas custom metrics allow the user to
+      #   set the threshold for each metric as a floating point number between 0.0 and
+      #   1.0.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::Type]
+      required :type, enum: -> { Deeprails::DefendCreateWorkflowParams::Type }
+
+      # @!attribute automatic_tolerance
+      #   Hallucination tolerance for automatic workflows; may be `low`, `medium`, or
+      #   `high`. Ignored if `type` is `custom`.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticTolerance, nil]
+      optional :automatic_tolerance, enum: -> { Deeprails::DefendCreateWorkflowParams::AutomaticTolerance }
+
+      # @!attribute description
+      #   Description for the workflow.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute max_retries
+      #   Max. number of improvement action retries until a given event passes the
+      #   guardrails. Defaults to 10.
+      #
+      #   @return [Integer, nil]
+      optional :max_retries, Integer
+
+      # @!method initialize(improvement_action:, metrics:, name:, type:, automatic_tolerance: nil, description: nil, max_retries: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::DefendCreateWorkflowParams} for more details.
+      #
+      #   @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction, nil] The action used to improve outputs that fail one or guardrail metrics for the wo
+      #
+      #   @param metrics [Hash{Symbol=>Float}] Mapping of guardrail metrics to floating point threshold values. If the workflo
+      #
+      #   @param name [String] Name of the workflow.
+      #
+      #   @param type [Symbol, Deeprails::Models::DefendCreateWorkflowParams::Type] Type of thresholds to use for the workflow, either `automatic` or `custom`. Aut
+      #
+      #   @param automatic_tolerance [Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticTolerance] Hallucination tolerance for automatic workflows; may be `low`, `medium`, or `hig
+      #
+      #   @param description [String] Description for the workflow.
+      #
+      #   @param max_retries [Integer] Max. number of improvement action retries until a given event passes the guardra
+      #
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+
+      # The action used to improve outputs that fail one or guardrail metrics for the
+      # workflow events. May be `regenerate`, `fixit`, or null which represents “do
+      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # Fixit attempts to directly address the shortcomings of the output using the
+      # guardrail failure rationale. Do nothing does not attempt any improvement.
+      module ImprovementAction
+        extend Deeprails::Internal::Type::Enum
+
+        REGENERATE = :regenerate
+        FIXIT = :fixit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Type of thresholds to use for the workflow, either `automatic` or `custom`.
+      # Automatic thresholds are assigned internally after the user specifies a
+      # qualitative tolerance for the metrics, whereas custom metrics allow the user to
+      # set the threshold for each metric as a floating point number between 0.0 and
+      # 1.0.
+      module Type
+        extend Deeprails::Internal::Type::Enum
+
+        AUTOMATIC = :automatic
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Hallucination tolerance for automatic workflows; may be `low`, `medium`, or
+      # `high`. Ignored if `type` is `custom`.
+      module AutomaticTolerance
+        extend Deeprails::Internal::Type::Enum
+
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/defend_response.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#create_workflow
+    class DefendResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute name
+      #   Name of the workflow.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute workflow_id
+      #   A unique workflow ID.
+      #
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!attribute created_at
+      #   The time the workflow was created in UTC.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute description
+      #   Description for the workflow.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute improvement_action
+      #   The action used to improve outputs that fail one or more guardrail metrics for
+      #   the workflow events. May be `regenerate`, `fixit`, or null which represents “do
+      #   nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      #   Fixit attempts to directly address the shortcomings of the output using the
+      #   guardrail failure rationale. Do nothing does not attempt any improvement.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendResponse::ImprovementAction, nil]
+      optional :improvement_action, enum: -> { Deeprails::DefendResponse::ImprovementAction }, nil?: true
+
+      # @!attribute max_retries
+      #   Max. number of improvement action retries until a given event passes the
+      #   guardrails.
+      #
+      #   @return [Integer, nil]
+      optional :max_retries, Integer
+
+      # @!attribute modified_at
+      #   The most recent time the workflow was modified in UTC.
+      #
+      #   @return [Time, nil]
+      optional :modified_at, Time
+
+      # @!attribute status
+      #   Status of the selected workflow. May be `archived` or `active`. Archived
+      #   workflows will not accept events.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendResponse::Status, nil]
+      optional :status, enum: -> { Deeprails::DefendResponse::Status }
+
+      # @!attribute success_rate
+      #   Rate of events associated with this workflow that passed evaluation.
+      #
+      #   @return [Float, nil]
+      optional :success_rate, Float
+
+      # @!method initialize(name:, workflow_id:, created_at: nil, description: nil, improvement_action: nil, max_retries: nil, modified_at: nil, status: nil, success_rate: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::DefendResponse} for more details.
+      #
+      #   Response payload for guardrail workflow operations.
+      #
+      #   @param name [String] Name of the workflow.
+      #
+      #   @param workflow_id [String] A unique workflow ID.
+      #
+      #   @param created_at [Time] The time the workflow was created in UTC.
+      #
+      #   @param description [String] Description for the workflow.
+      #
+      #   @param improvement_action [Symbol, Deeprails::Models::DefendResponse::ImprovementAction, nil] The action used to improve outputs that fail one or more guardrail metrics for t
+      #
+      #   @param max_retries [Integer] Max. number of improvement action retries until a given event passes the guardra
+      #
+      #   @param modified_at [Time] The most recent time the workflow was modified in UTC.
+      #
+      #   @param status [Symbol, Deeprails::Models::DefendResponse::Status] Status of the selected workflow. May be `archived` or `active`. Archived workf
+      #
+      #   @param success_rate [Float] Rate of events associated with this workflow that passed evaluation.
+
+      # The action used to improve outputs that fail one or more guardrail metrics for
+      # the workflow events. May be `regenerate`, `fixit`, or null which represents “do
+      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # Fixit attempts to directly address the shortcomings of the output using the
+      # guardrail failure rationale. Do nothing does not attempt any improvement.
+      #
+      # @see Deeprails::Models::DefendResponse#improvement_action
+      module ImprovementAction
+        extend Deeprails::Internal::Type::Enum
+
+        REGENERATE = :regenerate
+        FIXIT = :fixit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of the selected workflow. May be `archived` or `active`. Archived
+      # workflows will not accept events.
+      #
+      # @see Deeprails::Models::DefendResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        ARCHIVED = :archived
+        ACTIVE = :active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/defend_retrieve_event_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#retrieve_event
+    class DefendRetrieveEventParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!attribute workflow_id
+      #
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!method initialize(workflow_id:, request_options: {})
+      #   @param workflow_id [String]
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/deeprails/models/defend_retrieve_workflow_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#retrieve_workflow
+    class DefendRetrieveWorkflowParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/deeprails/models/defend_submit_event_params.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#submit_event
+    class DefendSubmitEventParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!attribute model_input
+      #   A dictionary of inputs sent to the LLM to generate output. This must contain a
+      #   `user_prompt` field and an optional `context` field. Additional properties are
+      #   allowed.
+      #
+      #   @return [Deeprails::Models::DefendSubmitEventParams::ModelInput]
+      required :model_input, -> { Deeprails::DefendSubmitEventParams::ModelInput }
+
+      # @!attribute model_output
+      #   Output generated by the LLM to be evaluated.
+      #
+      #   @return [String]
+      required :model_output, String
+
+      # @!attribute model_used
+      #   Model ID used to generate the output, like `gpt-4o` or `o3`.
+      #
+      #   @return [String]
+      required :model_used, String
+
+      # @!attribute nametag
+      #   An optional, user-defined tag for the event.
+      #
+      #   @return [String]
+      required :nametag, String
+
+      # @!attribute run_mode
+      #   Run mode for the workflow event. The run mode allows the user to optimize for
+      #   speed, accuracy, and cost by determining which models are used to evaluate the
+      #   event. Available run modes include `precision_plus`, `precision`, `smart`, and
+      #   `economy`. Defaults to `smart`.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendSubmitEventParams::RunMode]
+      required :run_mode, enum: -> { Deeprails::DefendSubmitEventParams::RunMode }
+
+      # @!method initialize(model_input:, model_output:, model_used:, nametag:, run_mode:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::DefendSubmitEventParams} for more details.
+      #
+      #   @param model_input [Deeprails::Models::DefendSubmitEventParams::ModelInput] A dictionary of inputs sent to the LLM to generate output. This must contain a
+      #
+      #   @param model_output [String] Output generated by the LLM to be evaluated.
+      #
+      #   @param model_used [String] Model ID used to generate the output, like `gpt-4o` or `o3`.
+      #
+      #   @param nametag [String] An optional, user-defined tag for the event.
+      #
+      #   @param run_mode [Symbol, Deeprails::Models::DefendSubmitEventParams::RunMode] Run mode for the workflow event. The run mode allows the user to optimize for s
+      #
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+
+      class ModelInput < Deeprails::Internal::Type::BaseModel
+        # @!attribute user_prompt
+        #
+        #   @return [String]
+        required :user_prompt, String
+
+        # @!attribute context
+        #
+        #   @return [String, nil]
+        optional :context, String
+
+        # @!method initialize(user_prompt:, context: nil)
+        #   A dictionary of inputs sent to the LLM to generate output. This must contain a
+        #   `user_prompt` field and an optional `context` field. Additional properties are
+        #   allowed.
+        #
+        #   @param user_prompt [String]
+        #   @param context [String]
+      end
+
+      # Run mode for the workflow event. The run mode allows the user to optimize for
+      # speed, accuracy, and cost by determining which models are used to evaluate the
+      # event. Available run modes include `precision_plus`, `precision`, `smart`, and
+      # `economy`. Defaults to `smart`.
+      module RunMode
+        extend Deeprails::Internal::Type::Enum
+
+        PRECISION_PLUS = :precision_plus
+        PRECISION = :precision
+        SMART = :smart
+        ECONOMY = :economy
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/defend_update_workflow_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#update_workflow
+    class DefendUpdateWorkflowParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!attribute description
+      #   Description for the workflow.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute name
+      #   Name of the workflow.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute type
+      #   Type of thresholds to use for the workflow, either `automatic` or `custom`.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendUpdateWorkflowParams::Type, nil]
+      optional :type, enum: -> { Deeprails::DefendUpdateWorkflowParams::Type }
+
+      # @!method initialize(description: nil, name: nil, type: nil, request_options: {})
+      #   @param description [String] Description for the workflow.
+      #
+      #   @param name [String] Name of the workflow.
+      #
+      #   @param type [Symbol, Deeprails::Models::DefendUpdateWorkflowParams::Type] Type of thresholds to use for the workflow, either `automatic` or `custom`.
+      #
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+
+      # Type of thresholds to use for the workflow, either `automatic` or `custom`.
+      module Type
+        extend Deeprails::Internal::Type::Enum
+
+        AUTOMATIC = :automatic
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end