deeprails 0.11.0 → 0.13.0

data/lib/deeprails/models/defend_response.rb

@@ -2,108 +2,307 @@
 
 module Deeprails
   module Models
-    # @see Deeprails::Resources::Defend#create_workflow
+    # @see Deeprails::Resources::Defend#retrieve_workflow
     class DefendResponse < Deeprails::Internal::Type::BaseModel
-      # @!attribute name
-      #   Name of the workflow.
+      # @!attribute automatic_hallucination_tolerance_levels
+      #   Mapping of guardrail metric names to tolerance values. Values can be strings
+      #   (`low`, `medium`, `high`) for automatic tolerance levels.
       #
-      #   @return [String]
-      required :name, String
+      #   @return [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}]
+      required :automatic_hallucination_tolerance_levels,
+               -> { Deeprails::Internal::Type::HashOf[enum: Deeprails::DefendResponse::AutomaticHallucinationToleranceLevel] }
 
-      # @!attribute workflow_id
-      #   A unique workflow ID.
+      # @!attribute capabilities
+      #   Extended AI capabilities available to the event, if any. Can be `web_search`
+      #   and/or `file_search`.
       #
-      #   @return [String]
-      required :workflow_id, String
+      #   @return [Array<Deeprails::Models::DefendResponse::Capability>]
+      required :capabilities, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Capability] }
 
       # @!attribute created_at
       #   The time the workflow was created in UTC.
       #
-      #   @return [Time, nil]
-      optional :created_at, Time
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute custom_hallucination_threshold_values
+      #   Mapping of guardrail metric names to threshold values. Values can be floating
+      #   point numbers (0.0-1.0) for custom thresholds.
+      #
+      #   @return [Hash{Symbol=>Float}]
+      required :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
 
       # @!attribute description
       #   Description for the workflow.
       #
-      #   @return [String, nil]
-      optional :description, String
+      #   @return [String]
+      required :description, String
 
-      # @!attribute improvement_action
-      #   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.
+      # @!attribute events
+      #   An array of events associated with this workflow.
       #
-      #   @return [Symbol, Deeprails::Models::DefendResponse::ImprovementAction, nil]
-      optional :improvement_action, enum: -> { Deeprails::DefendResponse::ImprovementAction }
+      #   @return [Array<Deeprails::Models::DefendResponse::Event>]
+      required :events, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Event] }
 
-      # @!attribute max_improvement_attempts
-      #   Max. number of improvement action retries until a given event passes the
-      #   guardrails.
+      # @!attribute files
+      #   List of files associated with the workflow. If this is not empty, models can
+      #   search these files when performing evaluations or remediations
       #
-      #   @return [Integer, nil]
-      optional :max_improvement_attempts, Integer
+      #   @return [Array<Deeprails::Models::DefendResponse::File>]
+      required :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::File] }
 
-      # @!attribute modified_at
-      #   The most recent time the workflow was modified in UTC.
+      # @!attribute name
+      #   Name of the workflow.
       #
-      #   @return [Time, nil]
-      optional :modified_at, Time
+      #   @return [String]
+      required :name, String
 
       # @!attribute status
       #   Status of the selected workflow. May be `inactive` or `active`. Inactive
       #   workflows will not accept events.
       #
-      #   @return [Symbol, Deeprails::Models::DefendResponse::Status, nil]
-      optional :status, enum: -> { Deeprails::DefendResponse::Status }
+      #   @return [Symbol, Deeprails::Models::DefendResponse::Status]
+      required :status, enum: -> { Deeprails::DefendResponse::Status }
+
+      # @!attribute threshold_type
+      #   Type of thresholds used to evaluate the event.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendResponse::ThresholdType]
+      required :threshold_type, enum: -> { Deeprails::DefendResponse::ThresholdType }
+
+      # @!attribute updated_at
+      #   The most recent time the workflow was updated in UTC.
+      #
+      #   @return [Time]
+      required :updated_at, Time
 
-      # @!attribute success_rate
-      #   Rate of events associated with this workflow that passed evaluation.
+      # @!attribute workflow_id
+      #   A unique workflow ID.
+      #
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!attribute stats
       #
-      #   @return [Float, nil]
-      optional :success_rate, Float
+      #   @return [Deeprails::Models::DefendResponse::Stats, nil]
+      optional :stats, -> { Deeprails::DefendResponse::Stats }
 
-      # @!method initialize(name:, workflow_id:, created_at: nil, description: nil, improvement_action: nil, max_improvement_attempts: nil, modified_at: nil, status: nil, success_rate: nil)
+      # @!method initialize(automatic_hallucination_tolerance_levels:, capabilities:, created_at:, custom_hallucination_threshold_values:, description:, events:, files:, name:, status:, threshold_type:, updated_at:, workflow_id:, stats: nil)
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendResponse} for more details.
       #
-      #   @param name [String] Name of the workflow.
+      #   @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metric names to tolerance values. Values can be strings (`l
       #
-      #   @param workflow_id [String] A unique workflow ID.
+      #   @param capabilities [Array<Deeprails::Models::DefendResponse::Capability>] Extended AI capabilities available to the event, if any. Can be `web_search` and
       #
       #   @param created_at [Time] The time the workflow was created in UTC.
       #
+      #   @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metric names to threshold values. Values can be floating po
+      #
       #   @param description [String] Description for the workflow.
       #
-      #   @param improvement_action [Symbol, Deeprails::Models::DefendResponse::ImprovementAction] The action used to improve outputs that fail one or more guardrail metrics for t
+      #   @param events [Array<Deeprails::Models::DefendResponse::Event>] An array of events associated with this workflow.
       #
-      #   @param max_improvement_attempts [Integer] Max. number of improvement action retries until a given event passes the guardra
+      #   @param files [Array<Deeprails::Models::DefendResponse::File>] List of files associated with the workflow. If this is not empty, models can sea
       #
-      #   @param modified_at [Time] The most recent time the workflow was modified in UTC.
+      #   @param name [String] Name of the workflow.
       #
       #   @param status [Symbol, Deeprails::Models::DefendResponse::Status] Status of the selected workflow. May be `inactive` or `active`. Inactive 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 `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.
+      #   @param threshold_type [Symbol, Deeprails::Models::DefendResponse::ThresholdType] Type of thresholds used to evaluate the event.
+      #
+      #   @param updated_at [Time] The most recent time the workflow was updated in UTC.
       #
-      # @see Deeprails::Models::DefendResponse#improvement_action
-      module ImprovementAction
+      #   @param workflow_id [String] A unique workflow ID.
+      #
+      #   @param stats [Deeprails::Models::DefendResponse::Stats]
+
+      module AutomaticHallucinationToleranceLevel
         extend Deeprails::Internal::Type::Enum
 
-        REGEN = :regen
-        FIXIT = :fixit
-        DO_NOTHING = :do_nothing
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
 
         # @!method self.values
         #   @return [Array<Symbol>]
       end
 
+      class Capability < Deeprails::Internal::Type::BaseModel
+        # @!attribute capability
+        #
+        #   @return [String, nil]
+        optional :capability, String
+
+        # @!method initialize(capability: nil)
+        #   @param capability [String]
+      end
+
+      class Event < Deeprails::Internal::Type::BaseModel
+        # @!attribute evaluations
+        #   An array of evaluations for this event.
+        #
+        #   @return [Array<Deeprails::Models::DefendResponse::Event::Evaluation>, nil]
+        optional :evaluations,
+                 -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Event::Evaluation] }
+
+        # @!attribute event_id
+        #   A unique workflow event ID.
+        #
+        #   @return [String, nil]
+        optional :event_id, String
+
+        # @!attribute improved_model_output
+        #   Improved model output after improvement tool was applied.
+        #
+        #   @return [String, nil]
+        optional :improved_model_output, String
+
+        # @!attribute improvement_tool_status
+        #   Status of the improvement tool used to improve the event.
+        #
+        #   @return [String, nil]
+        optional :improvement_tool_status, String
+
+        # @!method initialize(evaluations: nil, event_id: nil, improved_model_output: nil, improvement_tool_status: nil)
+        #   @param evaluations [Array<Deeprails::Models::DefendResponse::Event::Evaluation>] An array of evaluations for this event.
+        #
+        #   @param event_id [String] A unique workflow event ID.
+        #
+        #   @param improved_model_output [String] Improved model output after improvement tool was applied.
+        #
+        #   @param improvement_tool_status [String] Status of the improvement tool used to improve the event.
+
+        class Evaluation < Deeprails::Internal::Type::BaseModel
+          # @!attribute attempt
+          #   The attempt number or identifier for this evaluation.
+          #
+          #   @return [String, nil]
+          optional :attempt, String
+
+          # @!attribute created_at
+          #   The time the evaluation was created in UTC.
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute error_message
+          #   Error message if the evaluation failed.
+          #
+          #   @return [String, nil]
+          optional :error_message, String
+
+          # @!attribute evaluation_result
+          #   The result of the evaluation.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+          # @!attribute evaluation_status
+          #   Status of the evaluation.
+          #
+          #   @return [String, nil]
+          optional :evaluation_status, String
+
+          # @!attribute evaluation_total_cost
+          #   Total cost of the evaluation.
+          #
+          #   @return [Float, nil]
+          optional :evaluation_total_cost, Float
+
+          # @!attribute guardrail_metrics
+          #   An array of guardrail metrics evaluated.
+          #
+          #   @return [Array<String>, nil]
+          optional :guardrail_metrics, Deeprails::Internal::Type::ArrayOf[String]
+
+          # @!attribute model_input
+          #   The model input used for the evaluation.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :model_input, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+          # @!attribute model_output
+          #   The model output that was evaluated.
+          #
+          #   @return [String, nil]
+          optional :model_output, String
+
+          # @!attribute modified_at
+          #   The time the evaluation was last modified in UTC.
+          #
+          #   @return [Time, nil]
+          optional :modified_at, Time
+
+          # @!attribute nametag
+          #   An optional tag for the evaluation.
+          #
+          #   @return [String, nil]
+          optional :nametag, String
+
+          # @!attribute progress
+          #   Evaluation progress (0-100).
+          #
+          #   @return [Integer, nil]
+          optional :progress, Integer
+
+          # @!attribute run_mode
+          #   Run mode used for the evaluation.
+          #
+          #   @return [String, nil]
+          optional :run_mode, String
+
+          # @!method initialize(attempt: nil, created_at: nil, error_message: nil, evaluation_result: nil, evaluation_status: nil, evaluation_total_cost: nil, guardrail_metrics: nil, model_input: nil, model_output: nil, modified_at: nil, nametag: nil, progress: nil, run_mode: nil)
+          #   @param attempt [String] The attempt number or identifier for this evaluation.
+          #
+          #   @param created_at [Time] The time the evaluation was created in UTC.
+          #
+          #   @param error_message [String] Error message if the evaluation failed.
+          #
+          #   @param evaluation_result [Hash{Symbol=>Object}] The result of the evaluation.
+          #
+          #   @param evaluation_status [String] Status of the evaluation.
+          #
+          #   @param evaluation_total_cost [Float] Total cost of the evaluation.
+          #
+          #   @param guardrail_metrics [Array<String>] An array of guardrail metrics evaluated.
+          #
+          #   @param model_input [Hash{Symbol=>Object}] The model input used for the evaluation.
+          #
+          #   @param model_output [String] The model output that was evaluated.
+          #
+          #   @param modified_at [Time] The time the evaluation was last modified in UTC.
+          #
+          #   @param nametag [String] An optional tag for the evaluation.
+          #
+          #   @param progress [Integer] Evaluation progress (0-100).
+          #
+          #   @param run_mode [String] Run mode used for the evaluation.
+        end
+      end
+
+      class File < Deeprails::Internal::Type::BaseModel
+        # @!attribute file_id
+        #
+        #   @return [String, nil]
+        optional :file_id, String
+
+        # @!attribute file_name
+        #
+        #   @return [String, nil]
+        optional :file_name, String
+
+        # @!attribute file_size
+        #
+        #   @return [Integer, nil]
+        optional :file_size, Integer
+
+        # @!method initialize(file_id: nil, file_name: nil, file_size: nil)
+        #   @param file_id [String]
+        #   @param file_name [String]
+        #   @param file_size [Integer]
+      end
+
       # Status of the selected workflow. May be `inactive` or `active`. Inactive
       # workflows will not accept events.
       #
@@ -117,6 +316,47 @@ module Deeprails
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # Type of thresholds used to evaluate the event.
+      #
+      # @see Deeprails::Models::DefendResponse#threshold_type
+      module ThresholdType
+        extend Deeprails::Internal::Type::Enum
+
+        CUSTOM = :custom
+        AUTOMATIC = :automatic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Deeprails::Models::DefendResponse#stats
+      class Stats < Deeprails::Internal::Type::BaseModel
+        # @!attribute outputs_below_threshold
+        #   Number of AI outputs that failed the guardrails.
+        #
+        #   @return [Integer, nil]
+        optional :outputs_below_threshold, Integer
+
+        # @!attribute outputs_improved
+        #   Number of AI outputs that were improved.
+        #
+        #   @return [Integer, nil]
+        optional :outputs_improved, Integer
+
+        # @!attribute outputs_processed
+        #   Total number of AI outputs processed by the workflow.
+        #
+        #   @return [Integer, nil]
+        optional :outputs_processed, Integer
+
+        # @!method initialize(outputs_below_threshold: nil, outputs_improved: nil, outputs_processed: nil)
+        #   @param outputs_below_threshold [Integer] Number of AI outputs that failed the guardrails.
+        #
+        #   @param outputs_improved [Integer] Number of AI outputs that were improved.
+        #
+        #   @param outputs_processed [Integer] Total number of AI outputs processed by the workflow.
+      end
     end
   end
 end

data/lib/deeprails/models/defend_retrieve_workflow_params.rb

@@ -7,7 +7,19 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute limit
+      #   Limit the number of returned events associated with this workflow. Defaults
+      #   to 10.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::DefendRetrieveWorkflowParams} for more details.
+      #
+      #   @param limit [Integer] Limit the number of returned events associated with this workflow. Defaults to
+      #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/deeprails/models/defend_update_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#update_workflow
+    class DefendUpdateResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute modified_at
+      #   The time the workflow was last modified in UTC.
+      #
+      #   @return [Time]
+      required :modified_at, Time
+
+      # @!attribute status
+      #   Status of the selected workflow. May be `inactive` or `active`. Inactive
+      #   workflows will not accept events.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendUpdateResponse::Status]
+      required :status, enum: -> { Deeprails::DefendUpdateResponse::Status }
+
+      # @!attribute workflow_id
+      #   A unique workflow ID.
+      #
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!method initialize(modified_at:, status:, workflow_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::DefendUpdateResponse} for more details.
+      #
+      #   @param modified_at [Time] The time the workflow was last modified in UTC.
+      #
+      #   @param status [Symbol, Deeprails::Models::DefendUpdateResponse::Status] Status of the selected workflow. May be `inactive` or `active`. Inactive workf
+      #
+      #   @param workflow_id [String] A unique workflow ID.
+
+      # Status of the selected workflow. May be `inactive` or `active`. Inactive
+      # workflows will not accept events.
+      #
+      # @see Deeprails::Models::DefendUpdateResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        INACTIVE = :inactive
+        ACTIVE = :active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/file_response.rb

@@ -4,12 +4,6 @@ module Deeprails
   module Models
     # @see Deeprails::Resources::Files#upload
     class FileResponse < Deeprails::Internal::Type::BaseModel
-      # @!attribute created_at
-      #   The time the file was created in UTC.
-      #
-      #   @return [Time, nil]
-      optional :created_at, Time
-
       # @!attribute file_id
       #   A unique file ID.
       #
@@ -22,28 +16,18 @@ module Deeprails
       #   @return [String, nil]
       optional :file_name, String
 
-      # @!attribute file_path
-      #   Path to the s3 bucket where the file is stored.
+      # @!attribute file_size
+      #   The size of the file in bytes.
       #
-      #   @return [String, nil]
-      optional :file_path, String
+      #   @return [Integer, nil]
+      optional :file_size, Integer
 
-      # @!attribute updated_at
-      #   The most recent time the file was modified in UTC.
-      #
-      #   @return [Time, nil]
-      optional :updated_at, Time
-
-      # @!method initialize(created_at: nil, file_id: nil, file_name: nil, file_path: nil, updated_at: nil)
-      #   @param created_at [Time] The time the file was created in UTC.
-      #
+      # @!method initialize(file_id: nil, file_name: nil, file_size: nil)
       #   @param file_id [String] A unique file ID.
       #
       #   @param file_name [String] Name of the file.
       #
-      #   @param file_path [String] Path to the s3 bucket where the file is stored.
-      #
-      #   @param updated_at [Time] The most recent time the file was modified in UTC.
+      #   @param file_size [Integer] The size of the file in bytes.
     end
   end
 end

data/lib/deeprails/models/file_upload_params.rb

@@ -10,11 +10,11 @@ module Deeprails
       # @!attribute file
       #   The contents of the file to upload.
       #
-      #   @return [Pathname, StringIO, IO, String, Deeprails::FilePart]
-      required :file, Deeprails::Internal::Type::FileInput
+      #   @return [Array<String>]
+      required :file, Deeprails::Internal::Type::ArrayOf[String]
 
       # @!method initialize(file:, request_options: {})
-      #   @param file [Pathname, StringIO, IO, String, Deeprails::FilePart] The contents of the file to upload.
+      #   @param file [Array<String>] The contents of the file to upload.
       #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/deeprails/models/monitor_create_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#create
+    class MonitorCreateResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute created_at
+      #   The time the monitor was created in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute monitor_id
+      #   A unique monitor ID.
+      #
+      #   @return [String]
+      required :monitor_id, String
+
+      # @!attribute status
+      #   Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      #   longer record and evaluate events.
+      #
+      #   @return [Symbol, Deeprails::Models::MonitorCreateResponse::Status]
+      required :status, enum: -> { Deeprails::MonitorCreateResponse::Status }
+
+      # @!method initialize(created_at:, monitor_id:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::MonitorCreateResponse} for more details.
+      #
+      #   @param created_at [Time] The time the monitor was created in UTC.
+      #
+      #   @param monitor_id [String] A unique monitor ID.
+      #
+      #   @param status [Symbol, Deeprails::Models::MonitorCreateResponse::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      #
+      # @see Deeprails::Models::MonitorCreateResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end