deeprails 0.7.0 → 0.9.0

data/lib/deeprails/models/monitor_submit_event_response.rb

@@ -1,74 +0,0 @@
-# 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
-      #
-      #   @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]
-      #
-      #   @param message [String] The accompanying message for the request. Includes error details when applicable
-
-      # @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)
-        #   @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/resources/evaluate.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module Deeprails
-  module Resources
-    class Evaluate
-      # Some parameter documentations has been truncated, see
-      # {Deeprails::Models::EvaluateCreateParams} for more details.
-      #
-      # Use this endpoint to evaluate a model's input and output pair against selected
-      # guardrail metrics
-      #
-      # @overload create(model_input:, model_output:, run_mode:, guardrail_metrics: nil, model_used: nil, nametag: nil, request_options: {})
-      #
-      # @param model_input [Deeprails::Models::EvaluateCreateParams::ModelInput] A dictionary of inputs sent to the LLM to generate output. The dictionary must c
-      #
-      # @param model_output [String] Output generated by the LLM to be evaluated.
-      #
-      # @param run_mode [Symbol, Deeprails::Models::EvaluateCreateParams::RunMode] Run mode for the evaluation. The run mode allows the user to optimize for speed
-      #
-      # @param guardrail_metrics [Array<Symbol, Deeprails::Models::EvaluateCreateParams::GuardrailMetric>] An array of guardrail metrics that the model input and output pair will be evalu
-      #
-      # @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 evaluation.
-      #
-      # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Deeprails::Models::Evaluation]
-      #
-      # @see Deeprails::Models::EvaluateCreateParams
-      def create(params)
-        parsed, options = Deeprails::EvaluateCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "evaluate",
-          body: parsed,
-          model: Deeprails::Evaluation,
-          options: options
-        )
-      end
-
-      # Use this endpoint to retrieve the evaluation record for a given evaluation ID
-      #
-      # @overload retrieve(eval_id, request_options: {})
-      #
-      # @param eval_id [String] The ID of the evaluation to retrieve.
-      #
-      # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Deeprails::Models::Evaluation]
-      #
-      # @see Deeprails::Models::EvaluateRetrieveParams
-      def retrieve(eval_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["evaluate/%1$s", eval_id],
-          model: Deeprails::Evaluation,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Deeprails::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/deeprails/models/api_response.rbi

@@ -1,201 +0,0 @@
-# typed: strong
-
-module Deeprails
-  module Models
-    class APIResponse < Deeprails::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Deeprails::APIResponse, Deeprails::Internal::AnyHash)
-        end
-
-      # Represents whether the request was completed successfully.
-      sig { returns(T::Boolean) }
-      attr_accessor :success
-
-      sig { returns(T.nilable(Deeprails::APIResponse::Data)) }
-      attr_reader :data
-
-      sig { params(data: Deeprails::APIResponse::Data::OrHash).void }
-      attr_writer :data
-
-      # The accompanying message for the request. Includes error details when
-      # applicable.
-      sig { returns(T.nilable(String)) }
-      attr_reader :message
-
-      sig { params(message: String).void }
-      attr_writer :message
-
-      # Response wrapper for operations returning a MonitorResponse.
-      sig do
-        params(
-          success: T::Boolean,
-          data: Deeprails::APIResponse::Data::OrHash,
-          message: String
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Represents whether the request was completed successfully.
-        success:,
-        data: nil,
-        # The accompanying message for the request. Includes error details when
-        # applicable.
-        message: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            success: T::Boolean,
-            data: Deeprails::APIResponse::Data,
-            message: String
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Data < Deeprails::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Deeprails::APIResponse::Data, Deeprails::Internal::AnyHash)
-          end
-
-        # A unique monitor ID.
-        sig { returns(String) }
-        attr_accessor :monitor_id
-
-        # Name of the monitor.
-        sig { returns(String) }
-        attr_accessor :name
-
-        # The time the monitor was created in UTC.
-        sig { returns(T.nilable(Time)) }
-        attr_reader :created_at
-
-        sig { params(created_at: Time).void }
-        attr_writer :created_at
-
-        # Description of the monitor.
-        sig { returns(T.nilable(String)) }
-        attr_reader :description
-
-        sig { params(description: String).void }
-        attr_writer :description
-
-        # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
-        # longer record and evaluate events.
-        sig do
-          returns(
-            T.nilable(Deeprails::APIResponse::Data::MonitorStatus::TaggedSymbol)
-          )
-        end
-        attr_reader :monitor_status
-
-        sig do
-          params(
-            monitor_status:
-              Deeprails::APIResponse::Data::MonitorStatus::OrSymbol
-          ).void
-        end
-        attr_writer :monitor_status
-
-        # The most recent time the monitor was modified in UTC.
-        sig { returns(T.nilable(Time)) }
-        attr_reader :updated_at
-
-        sig { params(updated_at: Time).void }
-        attr_writer :updated_at
-
-        # User ID of the user who created the monitor.
-        sig { returns(T.nilable(String)) }
-        attr_reader :user_id
-
-        sig { params(user_id: String).void }
-        attr_writer :user_id
-
-        sig do
-          params(
-            monitor_id: String,
-            name: String,
-            created_at: Time,
-            description: String,
-            monitor_status:
-              Deeprails::APIResponse::Data::MonitorStatus::OrSymbol,
-            updated_at: Time,
-            user_id: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # A unique monitor ID.
-          monitor_id:,
-          # Name of the monitor.
-          name:,
-          # The time the monitor was created in UTC.
-          created_at: nil,
-          # Description of the monitor.
-          description: nil,
-          # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
-          # longer record and evaluate events.
-          monitor_status: nil,
-          # The most recent time the monitor was modified in UTC.
-          updated_at: nil,
-          # User ID of the user who created the monitor.
-          user_id: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              monitor_id: String,
-              name: String,
-              created_at: Time,
-              description: String,
-              monitor_status:
-                Deeprails::APIResponse::Data::MonitorStatus::TaggedSymbol,
-              updated_at: Time,
-              user_id: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
-        # longer record and evaluate events.
-        module MonitorStatus
-          extend Deeprails::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, Deeprails::APIResponse::Data::MonitorStatus)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          ACTIVE =
-            T.let(
-              :active,
-              Deeprails::APIResponse::Data::MonitorStatus::TaggedSymbol
-            )
-          INACTIVE =
-            T.let(
-              :inactive,
-              Deeprails::APIResponse::Data::MonitorStatus::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Deeprails::APIResponse::Data::MonitorStatus::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/deeprails/models/evaluate_create_params.rbi

@@ -1,280 +0,0 @@
-# typed: strong
-
-module Deeprails
-  module Models
-    class EvaluateCreateParams < Deeprails::Internal::Type::BaseModel
-      extend Deeprails::Internal::Type::RequestParameters::Converter
-      include Deeprails::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Deeprails::EvaluateCreateParams, Deeprails::Internal::AnyHash)
-        end
-
-      # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      # contain at least `user_prompt` or `system_prompt` field. For
-      # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
-      sig { returns(Deeprails::EvaluateCreateParams::ModelInput) }
-      attr_reader :model_input
-
-      sig do
-        params(
-          model_input: Deeprails::EvaluateCreateParams::ModelInput::OrHash
-        ).void
-      end
-      attr_writer :model_input
-
-      # Output generated by the LLM to be evaluated.
-      sig { returns(String) }
-      attr_accessor :model_output
-
-      # Run mode for the evaluation. 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`.
-      sig { returns(Deeprails::EvaluateCreateParams::RunMode::OrSymbol) }
-      attr_accessor :run_mode
-
-      # 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 the allowed
-      # guardrail metrics.
-      sig do
-        returns(
-          T.nilable(
-            T::Array[Deeprails::EvaluateCreateParams::GuardrailMetric::OrSymbol]
-          )
-        )
-      end
-      attr_reader :guardrail_metrics
-
-      sig do
-        params(
-          guardrail_metrics:
-            T::Array[Deeprails::EvaluateCreateParams::GuardrailMetric::OrSymbol]
-        ).void
-      end
-      attr_writer :guardrail_metrics
-
-      # Model ID used to generate the output, like `gpt-4o` or `o3`.
-      sig { returns(T.nilable(String)) }
-      attr_reader :model_used
-
-      sig { params(model_used: String).void }
-      attr_writer :model_used
-
-      # An optional, user-defined tag for the evaluation.
-      sig { returns(T.nilable(String)) }
-      attr_reader :nametag
-
-      sig { params(nametag: String).void }
-      attr_writer :nametag
-
-      sig do
-        params(
-          model_input: Deeprails::EvaluateCreateParams::ModelInput::OrHash,
-          model_output: String,
-          run_mode: Deeprails::EvaluateCreateParams::RunMode::OrSymbol,
-          guardrail_metrics:
-            T::Array[
-              Deeprails::EvaluateCreateParams::GuardrailMetric::OrSymbol
-            ],
-          model_used: String,
-          nametag: String,
-          request_options: Deeprails::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least `user_prompt` or `system_prompt` field. For
-        # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
-        model_input:,
-        # Output generated by the LLM to be evaluated.
-        model_output:,
-        # Run mode for the evaluation. 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`.
-        run_mode:,
-        # 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 the allowed
-        # guardrail metrics.
-        guardrail_metrics: nil,
-        # Model ID used to generate the output, like `gpt-4o` or `o3`.
-        model_used: nil,
-        # An optional, user-defined tag for the evaluation.
-        nametag: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            model_input: Deeprails::EvaluateCreateParams::ModelInput,
-            model_output: String,
-            run_mode: Deeprails::EvaluateCreateParams::RunMode::OrSymbol,
-            guardrail_metrics:
-              T::Array[
-                Deeprails::EvaluateCreateParams::GuardrailMetric::OrSymbol
-              ],
-            model_used: String,
-            nametag: String,
-            request_options: Deeprails::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class ModelInput < Deeprails::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Deeprails::EvaluateCreateParams::ModelInput,
-              Deeprails::Internal::AnyHash
-            )
-          end
-
-        # The ground truth for evaluating Ground Truth Adherence guardrail.
-        sig { returns(T.nilable(String)) }
-        attr_reader :ground_truth
-
-        sig { params(ground_truth: String).void }
-        attr_writer :ground_truth
-
-        # The system prompt used to generate the output.
-        sig { returns(T.nilable(String)) }
-        attr_reader :system_prompt
-
-        sig { params(system_prompt: String).void }
-        attr_writer :system_prompt
-
-        # The user prompt used to generate the output.
-        sig { returns(T.nilable(String)) }
-        attr_reader :user_prompt
-
-        sig { params(user_prompt: String).void }
-        attr_writer :user_prompt
-
-        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least `user_prompt` or `system_prompt` field. For
-        # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
-        sig do
-          params(
-            ground_truth: String,
-            system_prompt: String,
-            user_prompt: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The ground truth for evaluating Ground Truth Adherence guardrail.
-          ground_truth: nil,
-          # The system prompt used to generate the output.
-          system_prompt: nil,
-          # The user prompt used to generate the output.
-          user_prompt: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            { ground_truth: String, system_prompt: String, user_prompt: String }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      # Run mode for the evaluation. 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
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Deeprails::EvaluateCreateParams::RunMode)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        PRECISION_PLUS =
-          T.let(
-            :precision_plus,
-            Deeprails::EvaluateCreateParams::RunMode::TaggedSymbol
-          )
-        PRECISION =
-          T.let(
-            :precision,
-            Deeprails::EvaluateCreateParams::RunMode::TaggedSymbol
-          )
-        SMART =
-          T.let(:smart, Deeprails::EvaluateCreateParams::RunMode::TaggedSymbol)
-        ECONOMY =
-          T.let(
-            :economy,
-            Deeprails::EvaluateCreateParams::RunMode::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Deeprails::EvaluateCreateParams::RunMode::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      module GuardrailMetric
-        extend Deeprails::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Deeprails::EvaluateCreateParams::GuardrailMetric)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        CORRECTNESS =
-          T.let(
-            :correctness,
-            Deeprails::EvaluateCreateParams::GuardrailMetric::TaggedSymbol
-          )
-        COMPLETENESS =
-          T.let(
-            :completeness,
-            Deeprails::EvaluateCreateParams::GuardrailMetric::TaggedSymbol
-          )
-        INSTRUCTION_ADHERENCE =
-          T.let(
-            :instruction_adherence,
-            Deeprails::EvaluateCreateParams::GuardrailMetric::TaggedSymbol
-          )
-        CONTEXT_ADHERENCE =
-          T.let(
-            :context_adherence,
-            Deeprails::EvaluateCreateParams::GuardrailMetric::TaggedSymbol
-          )
-        GROUND_TRUTH_ADHERENCE =
-          T.let(
-            :ground_truth_adherence,
-            Deeprails::EvaluateCreateParams::GuardrailMetric::TaggedSymbol
-          )
-        COMPREHENSIVE_SAFETY =
-          T.let(
-            :comprehensive_safety,
-            Deeprails::EvaluateCreateParams::GuardrailMetric::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Deeprails::EvaluateCreateParams::GuardrailMetric::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/deeprails/models/evaluate_retrieve_params.rbi

@@ -1,27 +0,0 @@
-# typed: strong
-
-module Deeprails
-  module Models
-    class EvaluateRetrieveParams < Deeprails::Internal::Type::BaseModel
-      extend Deeprails::Internal::Type::RequestParameters::Converter
-      include Deeprails::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Deeprails::EvaluateRetrieveParams, Deeprails::Internal::AnyHash)
-        end
-
-      sig do
-        params(request_options: Deeprails::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(request_options: {})
-      end
-
-      sig { override.returns({ request_options: Deeprails::RequestOptions }) }
-      def to_hash
-      end
-    end
-  end
-end