deeprails 0.11.0 → 0.12.0

data/rbi/deeprails/models/workflow_event_response.rbi

@@ -8,77 +8,84 @@ module Deeprails
           T.any(Deeprails::WorkflowEventResponse, Deeprails::Internal::AnyHash)
         end
 
+      # The time the event was created in UTC.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
       # A unique workflow event ID.
       sig { returns(String) }
       attr_accessor :event_id
 
+      # Status of the event.
+      sig { returns(Deeprails::WorkflowEventResponse::Status::TaggedSymbol) }
+      attr_accessor :status
+
       # Workflow ID associated with the event.
       sig { returns(String) }
       attr_accessor :workflow_id
 
-      # Count of improvement attempts for the event. If greater than one then all
-      # previous improvement attempts failed.
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :attempt_number
-
-      sig { params(attempt_number: Integer).void }
-      attr_writer :attempt_number
-
-      # A unique evaluation ID associated with this event. Every event has one or more
-      # evaluation attempts.
-      sig { returns(T.nilable(String)) }
-      attr_reader :evaluation_id
-
-      sig { params(evaluation_id: String).void }
-      attr_writer :evaluation_id
-
-      # `False` if evaluation passed all of the guardrail metrics, `True` if evaluation
-      # failed any of the guardrail metrics.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :filtered
-
-      sig { params(filtered: T::Boolean).void }
-      attr_writer :filtered
-
       sig do
         params(
+          created_at: Time,
           event_id: String,
-          workflow_id: String,
-          attempt_number: Integer,
-          evaluation_id: String,
-          filtered: T::Boolean
+          status: Deeprails::WorkflowEventResponse::Status::OrSymbol,
+          workflow_id: String
         ).returns(T.attached_class)
       end
       def self.new(
+        # The time the event was created in UTC.
+        created_at:,
         # A unique workflow event ID.
         event_id:,
+        # Status of the event.
+        status:,
         # Workflow ID associated with the event.
-        workflow_id:,
-        # Count of improvement attempts for the event. If greater than one then all
-        # previous improvement attempts failed.
-        attempt_number: nil,
-        # A unique evaluation ID associated with this event. Every event has one or more
-        # evaluation attempts.
-        evaluation_id: nil,
-        # `False` if evaluation passed all of the guardrail metrics, `True` if evaluation
-        # failed any of the guardrail metrics.
-        filtered: nil
+        workflow_id:
       )
       end
 
       sig do
         override.returns(
           {
+            created_at: Time,
             event_id: String,
-            workflow_id: String,
-            attempt_number: Integer,
-            evaluation_id: String,
-            filtered: T::Boolean
+            status: Deeprails::WorkflowEventResponse::Status::TaggedSymbol,
+            workflow_id: String
           }
         )
       end
       def to_hash
       end
+
+      # Status of the event.
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Deeprails::WorkflowEventResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IN_PROGRESS =
+          T.let(
+            :"In Progress",
+            Deeprails::WorkflowEventResponse::Status::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(
+            :Completed,
+            Deeprails::WorkflowEventResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Deeprails::WorkflowEventResponse::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/deeprails/models.rbi

@@ -1,6 +1,8 @@
 # typed: strong
 
 module Deeprails
+  DefendCreateResponse = Deeprails::Models::DefendCreateResponse
+
   DefendCreateWorkflowParams = Deeprails::Models::DefendCreateWorkflowParams
 
   DefendResponse = Deeprails::Models::DefendResponse
@@ -11,6 +13,8 @@ module Deeprails
 
   DefendSubmitEventParams = Deeprails::Models::DefendSubmitEventParams
 
+  DefendUpdateResponse = Deeprails::Models::DefendUpdateResponse
+
   DefendUpdateWorkflowParams = Deeprails::Models::DefendUpdateWorkflowParams
 
   FileResponse = Deeprails::Models::FileResponse
@@ -19,11 +23,13 @@ module Deeprails
 
   MonitorCreateParams = Deeprails::Models::MonitorCreateParams
 
+  MonitorCreateResponse = Deeprails::Models::MonitorCreateResponse
+
   MonitorDetailResponse = Deeprails::Models::MonitorDetailResponse
 
-  MonitorEventResponse = Deeprails::Models::MonitorEventResponse
+  MonitorEventDetailResponse = Deeprails::Models::MonitorEventDetailResponse
 
-  MonitorResponse = Deeprails::Models::MonitorResponse
+  MonitorEventResponse = Deeprails::Models::MonitorEventResponse
 
   MonitorRetrieveParams = Deeprails::Models::MonitorRetrieveParams
 
@@ -31,5 +37,9 @@ module Deeprails
 
   MonitorUpdateParams = Deeprails::Models::MonitorUpdateParams
 
+  MonitorUpdateResponse = Deeprails::Models::MonitorUpdateResponse
+
+  WorkflowEventDetailResponse = Deeprails::Models::WorkflowEventDetailResponse
+
   WorkflowEventResponse = Deeprails::Models::WorkflowEventResponse
 end

data/rbi/deeprails/resources/defend.rbi

@@ -10,7 +10,8 @@ module Deeprails
           improvement_action:
             Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol,
           name: String,
-          type: Deeprails::DefendCreateWorkflowParams::Type::OrSymbol,
+          threshold_type:
+            Deeprails::DefendCreateWorkflowParams::ThresholdType::OrSymbol,
           automatic_hallucination_tolerance_levels:
             T::Hash[
               Symbol,
@@ -22,14 +23,14 @@ module Deeprails
           max_improvement_attempts: Integer,
           web_search: T::Boolean,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::DefendResponse)
+        ).returns(Deeprails::DefendCreateResponse)
       end
       def create_workflow(
-        # The action used to improve outputs that fail one or guardrail metrics for the
-        # workflow events. May be `regen`, `fixit`, or `do_nothing`. ReGen runs the user's
-        # 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.
+        # The action used to improve outputs that fail one or more guardrail metrics for
+        # the workflow events. May be `regen`, `fixit`, or `do_nothing`. ReGen runs the
+        # user's 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.
         improvement_action:,
         # Name of the workflow.
         name:,
@@ -38,7 +39,7 @@ module Deeprails
         # 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.
-        type:,
+        threshold_type:,
         # Mapping of guardrail metrics to hallucination tolerance levels (either `low`,
         # `medium`, or `high`). Possible metrics are `completeness`,
         # `instruction_adherence`, `context_adherence`, `ground_truth_adherence`, or
@@ -53,7 +54,7 @@ module Deeprails
         # An array of file IDs to search in the workflow's evaluations. Files must be
         # uploaded via the DeepRails API first.
         file_search: nil,
-        # Max. number of improvement action retries until a given event passes the
+        # Max. number of improvement action attempts until a given event passes the
         # guardrails. Defaults to 10.
         max_improvement_attempts: nil,
         # Whether to enable web search for this workflow's evaluations. Defaults to false.
@@ -68,7 +69,7 @@ module Deeprails
           event_id: String,
           workflow_id: String,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::WorkflowEventResponse)
+        ).returns(Deeprails::WorkflowEventDetailResponse)
       end
       def retrieve_event(
         # The ID of the requested workflow event.
@@ -83,12 +84,16 @@ module Deeprails
       sig do
         params(
           workflow_id: String,
+          limit: Integer,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::DefendResponse)
       end
       def retrieve_workflow(
         # The ID of the workflow to retrieve.
         workflow_id,
+        # Limit the number of returned events associated with this workflow. Defaults
+        # to 10.
+        limit: nil,
         request_options: {}
       )
       end
@@ -128,14 +133,14 @@ module Deeprails
       )
       end
 
-      # Use this endpoint to update an existing guardrail workflow
+      # Use this endpoint to update an existing defend workflow
       sig do
         params(
           workflow_id: String,
           description: String,
           name: String,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::DefendResponse)
+        ).returns(Deeprails::DefendUpdateResponse)
       end
       def update_workflow(
         # The ID of the workflow to edit.

data/rbi/deeprails/resources/files.rbi

@@ -6,7 +6,7 @@ module Deeprails
       # Use this endpoint to upload a file to the DeepRails API
       sig do
         params(
-          file: Deeprails::Internal::FileInput,
+          file: T::Array[String],
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::FileResponse)
       end

data/rbi/deeprails/resources/monitor.rbi

@@ -14,7 +14,7 @@ module Deeprails
           file_search: T::Array[String],
           web_search: T::Boolean,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::MonitorResponse)
+        ).returns(Deeprails::MonitorCreateResponse)
       end
       def create(
         # An array of guardrail metrics that the model input and output pair will be
@@ -47,7 +47,8 @@ module Deeprails
       def retrieve(
         # The ID of the monitor to retrieve.
         monitor_id,
-        # Limit the returned events associated with this monitor. Defaults to 10.
+        # Limit the number of returned evaluations associated with this monitor. Defaults
+        # to 10.
         limit: nil,
         request_options: {}
       )
@@ -59,22 +60,21 @@ module Deeprails
         params(
           monitor_id: String,
           description: String,
-          monitor_status:
-            Deeprails::MonitorUpdateParams::MonitorStatus::OrSymbol,
           name: String,
+          status: Deeprails::MonitorUpdateParams::Status::OrSymbol,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::MonitorResponse)
+        ).returns(Deeprails::MonitorUpdateResponse)
       end
       def update(
         # The ID of the monitor to edit.
         monitor_id,
         # 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,
         # Name of the monitor.
         name: nil,
+        # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+        # longer record and evaluate events.
+        status: nil,
         request_options: {}
       )
       end

data/sig/deeprails/internal/transport/base_client.rbs

@@ -87,6 +87,8 @@ module Deeprails
 
         private def auth_headers: -> ::Hash[String, String]
 
+        private def user_agent: -> String
+
         private def generate_idempotency_key: -> String
 
         private def build_request: (

data/sig/deeprails/internal/transport/pooled_net_requester.rbs

@@ -17,7 +17,10 @@ module Deeprails
 
         DEFAULT_MAX_CONNECTIONS: Integer
 
-        def self.connect: (URI::Generic url) -> top
+        def self.connect: (
+          cert_store: OpenSSL::X509::Store,
+          url: URI::Generic
+        ) -> top
 
         def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
 

data/sig/deeprails/models/defend_create_response.rbs

@@ -0,0 +1,41 @@
+module Deeprails
+  module Models
+    type defend_create_response =
+      {
+        created_at: Time,
+        status: Deeprails::Models::DefendCreateResponse::status,
+        workflow_id: String
+      }
+
+    class DefendCreateResponse < Deeprails::Internal::Type::BaseModel
+      attr_accessor created_at: Time
+
+      attr_accessor status: Deeprails::Models::DefendCreateResponse::status
+
+      attr_accessor workflow_id: String
+
+      def initialize: (
+        created_at: Time,
+        status: Deeprails::Models::DefendCreateResponse::status,
+        workflow_id: String
+      ) -> void
+
+      def to_hash: -> {
+        created_at: Time,
+        status: Deeprails::Models::DefendCreateResponse::status,
+        workflow_id: String
+      }
+
+      type status = :inactive | :active
+
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        INACTIVE: :inactive
+        ACTIVE: :active
+
+        def self?.values: -> ::Array[Deeprails::Models::DefendCreateResponse::status]
+      end
+    end
+  end
+end

data/sig/deeprails/models/defend_create_workflow_params.rbs

@@ -4,7 +4,7 @@ module Deeprails
       {
         improvement_action: Deeprails::Models::DefendCreateWorkflowParams::improvement_action,
         name: String,
-        type: Deeprails::Models::DefendCreateWorkflowParams::type_,
+        threshold_type: Deeprails::Models::DefendCreateWorkflowParams::threshold_type,
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendCreateWorkflowParams::automatic_hallucination_tolerance_level],
         custom_hallucination_threshold_values: ::Hash[Symbol, Float],
         description: String,
@@ -22,7 +22,7 @@ module Deeprails
 
       attr_accessor name: String
 
-      attr_accessor type: Deeprails::Models::DefendCreateWorkflowParams::type_
+      attr_accessor threshold_type: Deeprails::Models::DefendCreateWorkflowParams::threshold_type
 
       attr_reader automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendCreateWorkflowParams::automatic_hallucination_tolerance_level]?
 
@@ -55,7 +55,7 @@ module Deeprails
       def initialize: (
         improvement_action: Deeprails::Models::DefendCreateWorkflowParams::improvement_action,
         name: String,
-        type: Deeprails::Models::DefendCreateWorkflowParams::type_,
+        threshold_type: Deeprails::Models::DefendCreateWorkflowParams::threshold_type,
         ?automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendCreateWorkflowParams::automatic_hallucination_tolerance_level],
         ?custom_hallucination_threshold_values: ::Hash[Symbol, Float],
         ?description: String,
@@ -68,7 +68,7 @@ module Deeprails
       def to_hash: -> {
         improvement_action: Deeprails::Models::DefendCreateWorkflowParams::improvement_action,
         name: String,
-        type: Deeprails::Models::DefendCreateWorkflowParams::type_,
+        threshold_type: Deeprails::Models::DefendCreateWorkflowParams::threshold_type,
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendCreateWorkflowParams::automatic_hallucination_tolerance_level],
         custom_hallucination_threshold_values: ::Hash[Symbol, Float],
         description: String,
@@ -90,15 +90,15 @@ module Deeprails
         def self?.values: -> ::Array[Deeprails::Models::DefendCreateWorkflowParams::improvement_action]
       end
 
-      type type_ = :automatic | :custom
+      type threshold_type = :automatic | :custom
 
-      module Type
+      module ThresholdType
         extend Deeprails::Internal::Type::Enum
 
         AUTOMATIC: :automatic
         CUSTOM: :custom
 
-        def self?.values: -> ::Array[Deeprails::Models::DefendCreateWorkflowParams::type_]
+        def self?.values: -> ::Array[Deeprails::Models::DefendCreateWorkflowParams::threshold_type]
       end
 
       type automatic_hallucination_tolerance_level = :low | :medium | :high