deeprails 0.1.0

data/lib/deeprails/models/monitor_submit_event_params.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#submit_event
+    class MonitorSubmitEventParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!attribute guardrail_metrics
+      #   An array of guardrail metrics that the model input and output pair will be
+      #   evaluated on. For non-enterprise users, these will be limited to `correctness`,
+      #   `completeness`, `instruction_adherence`, `context_adherence`,
+      #   `ground_truth_adherence`, and/or `comprehensive_safety`.
+      #
+      #   @return [Array<Symbol, Deeprails::Models::MonitorSubmitEventParams::GuardrailMetric>]
+      required :guardrail_metrics,
+               -> { Deeprails::Internal::Type::ArrayOf[enum: Deeprails::MonitorSubmitEventParams::GuardrailMetric] }
+
+      # @!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::MonitorSubmitEventParams::ModelInput]
+      required :model_input, -> { Deeprails::MonitorSubmitEventParams::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, nil]
+      optional :model_used, String
+
+      # @!attribute nametag
+      #   An optional, user-defined tag for the event.
+      #
+      #   @return [String, nil]
+      optional :nametag, String
+
+      # @!attribute run_mode
+      #   Run mode for the monitor 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::MonitorSubmitEventParams::RunMode, nil]
+      optional :run_mode, enum: -> { Deeprails::MonitorSubmitEventParams::RunMode }
+
+      # @!method initialize(guardrail_metrics:, model_input:, model_output:, model_used: nil, nametag: nil, run_mode: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::MonitorSubmitEventParams} for more details.
+      #
+      #   @param guardrail_metrics [Array<Symbol, Deeprails::Models::MonitorSubmitEventParams::GuardrailMetric>] An array of guardrail metrics that the model input and output pair will be evalu
+      #
+      #   @param model_input [Deeprails::Models::MonitorSubmitEventParams::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::MonitorSubmitEventParams::RunMode] Run mode for the monitor event. The run mode allows the user to optimize for sp
+      #
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+
+      module GuardrailMetric
+        extend Deeprails::Internal::Type::Enum
+
+        CORRECTNESS = :correctness
+        COMPLETENESS = :completeness
+        INSTRUCTION_ADHERENCE = :instruction_adherence
+        CONTEXT_ADHERENCE = :context_adherence
+        GROUND_TRUTH_ADHERENCE = :ground_truth_adherence
+        COMPREHENSIVE_SAFETY = :comprehensive_safety
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      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 monitor 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/monitor_submit_event_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#submit_event
+    class MonitorSubmitEventResponse < 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 monitor event operations.
+      #
+      #   @return [Deeprails::Models::MonitorSubmitEventResponse::Data, nil]
+      optional :data, -> { Deeprails::Models::MonitorSubmitEventResponse::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::MonitorSubmitEventResponse} for more details.
+      #
+      #   Response wrapper for operations returning a MonitorEventResponse.
+      #
+      #   @param success [Boolean] Represents whether the request was completed successfully.
+      #
+      #   @param data [Deeprails::Models::MonitorSubmitEventResponse::Data] Response payload for monitor event operations.
+      #
+      #   @param message [String] The accompanying message for the request. Includes error details when applicabl
+
+      # @see Deeprails::Models::MonitorSubmitEventResponse#data
+      class Data < Deeprails::Internal::Type::BaseModel
+        # @!attribute evaluation_id
+        #   A unique evaluation ID associated with this event.
+        #
+        #   @return [String]
+        required :evaluation_id, String
+
+        # @!attribute event_id
+        #   A unique monitor event ID.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute monitor_id
+        #   Monitor ID associated with this event.
+        #
+        #   @return [String]
+        required :monitor_id, String
+
+        # @!attribute created_at
+        #   The time the monitor event was created in UTC.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!method initialize(evaluation_id:, event_id:, monitor_id:, created_at: nil)
+        #   Response payload for monitor event operations.
+        #
+        #   @param evaluation_id [String] A unique evaluation ID associated with this event.
+        #
+        #   @param event_id [String] A unique monitor event ID.
+        #
+        #   @param monitor_id [String] Monitor ID associated with this event.
+        #
+        #   @param created_at [Time] The time the monitor event was created in UTC.
+      end
+    end
+  end
+end

data/lib/deeprails/models/monitor_update_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#update
+    class MonitorUpdateParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!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::MonitorUpdateParams::MonitorStatus, nil]
+      optional :monitor_status, enum: -> { Deeprails::MonitorUpdateParams::MonitorStatus }
+
+      # @!attribute name
+      #   Name of the monitor.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(description: nil, monitor_status: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::MonitorUpdateParams} for more details.
+      #
+      #   @param description [String] Description of the monitor.
+      #
+      #   @param monitor_status [Symbol, Deeprails::Models::MonitorUpdateParams::MonitorStatus] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+      #
+      #   @param name [String] Name of the monitor.
+      #
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      module MonitorStatus
+        extend Deeprails::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/workflow_event_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#retrieve_event
+    class WorkflowEventResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute event_id
+      #   A unique workflow event ID.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute workflow_id
+      #   Workflow ID associated with the event.
+      #
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!attribute attempt_number
+      #   Count of improvement attempts for the event. If greater than one then all
+      #   previous improvement attempts failed.
+      #
+      #   @return [Integer, nil]
+      optional :attempt_number, Integer
+
+      # @!attribute evaluation_id
+      #   A unique evaluation ID associated with this event. Every event has one or more
+      #   evaluation attempts.
+      #
+      #   @return [String, nil]
+      optional :evaluation_id, String
+
+      # @!attribute filtered
+      #   `False` if evaluation passed all of the guardrail metrics, `True` if evaluation
+      #   failed any of the guardrail metrics.
+      #
+      #   @return [Boolean, nil]
+      optional :filtered, Deeprails::Internal::Type::Boolean
+
+      # @!method initialize(event_id:, workflow_id:, attempt_number: nil, evaluation_id: nil, filtered: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::WorkflowEventResponse} for more details.
+      #
+      #   Response payload for workflow event operations.
+      #
+      #   @param event_id [String] A unique workflow event ID.
+      #
+      #   @param workflow_id [String] Workflow ID associated with the event.
+      #
+      #   @param attempt_number [Integer] Count of improvement attempts for the event. If greater than one then all previ
+      #
+      #   @param evaluation_id [String] A unique evaluation ID associated with this event. Every event has one or more
+      #
+      #   @param filtered [Boolean] `False` if evaluation passed all of the guardrail metrics, `True` if evaluation
+    end
+  end
+end

data/lib/deeprails/models.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Deeprails
+  [Deeprails::Internal::Type::BaseModel, *Deeprails::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Deeprails::Internal::AnyHash) } }
+  end
+
+  Deeprails::Internal::Util.walk_namespaces(Deeprails::Models).each do |mod|
+    case mod
+    in Deeprails::Internal::Type::Enum | Deeprails::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Deeprails::Internal::Util.walk_namespaces(Deeprails::Models)
+                           .lazy
+                           .grep(Deeprails::Internal::Type::Union)
+                           .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  APIResponse = Deeprails::Models::APIResponse
+
+  DefendCreateWorkflowParams = Deeprails::Models::DefendCreateWorkflowParams
+
+  DefendResponse = Deeprails::Models::DefendResponse
+
+  DefendRetrieveEventParams = Deeprails::Models::DefendRetrieveEventParams
+
+  DefendRetrieveWorkflowParams = Deeprails::Models::DefendRetrieveWorkflowParams
+
+  DefendSubmitEventParams = Deeprails::Models::DefendSubmitEventParams
+
+  DefendUpdateWorkflowParams = Deeprails::Models::DefendUpdateWorkflowParams
+
+  EvaluateCreateParams = Deeprails::Models::EvaluateCreateParams
+
+  EvaluateRetrieveParams = Deeprails::Models::EvaluateRetrieveParams
+
+  Evaluation = Deeprails::Models::Evaluation
+
+  MonitorCreateParams = Deeprails::Models::MonitorCreateParams
+
+  MonitorRetrieveParams = Deeprails::Models::MonitorRetrieveParams
+
+  MonitorSubmitEventParams = Deeprails::Models::MonitorSubmitEventParams
+
+  MonitorUpdateParams = Deeprails::Models::MonitorUpdateParams
+
+  WorkflowEventResponse = Deeprails::Models::WorkflowEventResponse
+end

data/lib/deeprails/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Deeprails
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Deeprails::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Deeprails::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Deeprails::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Deeprails::RequestOptions, Deeprails::Internal::AnyHash) }
+    end
+  end
+end

data/lib/deeprails/resources/defend.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Resources
+    class Defend
+      # Some parameter documentations has been truncated, see
+      # {Deeprails::Models::DefendCreateWorkflowParams} for more details.
+      #
+      # Create a new guardrail workflow with optional guardrail thresholds and
+      # improvement actions.
+      #
+      # @overload create_workflow(improvement_action:, metrics:, name:, type:, automatic_tolerance: nil, description: nil, max_retries: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Deeprails::Models::DefendResponse]
+      #
+      # @see Deeprails::Models::DefendCreateWorkflowParams
+      def create_workflow(params)
+        parsed, options = Deeprails::DefendCreateWorkflowParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "defend",
+          body: parsed,
+          model: Deeprails::DefendResponse,
+          options: options
+        )
+      end
+
+      # Retrieve a specific event of a guardrail workflow.
+      #
+      # @overload retrieve_event(event_id, workflow_id:, request_options: {})
+      #
+      # @param event_id [String] The ID of the requested workflow event.
+      #
+      # @param workflow_id [String] The ID of the workflow associated with the event.
+      #
+      # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Deeprails::Models::WorkflowEventResponse]
+      #
+      # @see Deeprails::Models::DefendRetrieveEventParams
+      def retrieve_event(event_id, params)
+        parsed, options = Deeprails::DefendRetrieveEventParams.dump_request(params)
+        workflow_id =
+          parsed.delete(:workflow_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["defend/%1$s/events/%2$s", workflow_id, event_id],
+          model: Deeprails::WorkflowEventResponse,
+          options: options
+        )
+      end
+
+      # Retrieve the details for a specific guardrail workflow.
+      #
+      # @overload retrieve_workflow(workflow_id, request_options: {})
+      #
+      # @param workflow_id [String] The ID of the workflow to retrieve.
+      #
+      # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Deeprails::Models::DefendResponse]
+      #
+      # @see Deeprails::Models::DefendRetrieveWorkflowParams
+      def retrieve_workflow(workflow_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["defend/%1$s", workflow_id],
+          model: Deeprails::DefendResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Deeprails::Models::DefendSubmitEventParams} for more details.
+      #
+      # Submit a model input and output pair to a workflow for evaluation.
+      #
+      # @overload submit_event(workflow_id, model_input:, model_output:, model_used:, nametag:, run_mode:, request_options: {})
+      #
+      # @param workflow_id [String] Workflow ID associated with this event.
+      #
+      # @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}, nil]
+      #
+      # @return [Deeprails::Models::WorkflowEventResponse]
+      #
+      # @see Deeprails::Models::DefendSubmitEventParams
+      def submit_event(workflow_id, params)
+        parsed, options = Deeprails::DefendSubmitEventParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["defend/%1$s/events", workflow_id],
+          body: parsed,
+          model: Deeprails::WorkflowEventResponse,
+          options: options
+        )
+      end
+
+      # Update an existing guardrail workflow.
+      #
+      # @overload update_workflow(workflow_id, description: nil, name: nil, type: nil, request_options: {})
+      #
+      # @param workflow_id [String] The ID of the workflow to edit.
+      #
+      # @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}, nil]
+      #
+      # @return [Deeprails::Models::DefendResponse]
+      #
+      # @see Deeprails::Models::DefendUpdateWorkflowParams
+      def update_workflow(workflow_id, params = {})
+        parsed, options = Deeprails::DefendUpdateWorkflowParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["defend/%1$s", workflow_id],
+          body: parsed,
+          model: Deeprails::DefendResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Deeprails::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end