deeprails 0.12.0 → 0.14.0

data/lib/deeprails/models/workflow_event_detail_response.rb

@@ -4,6 +4,20 @@ module Deeprails
   module Models
     # @see Deeprails::Resources::Defend#retrieve_event
     class WorkflowEventDetailResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute evaluation_history
+      #   History of evaluations for the event.
+      #
+      #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory>]
+      required :evaluation_history,
+               -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::EvaluationHistory] }
+
+      # @!attribute evaluation_result
+      #   Evaluation result consisting of average scores and rationales for each of the
+      #   evaluated guardrail metrics.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
       # @!attribute event_id
       #   A unique workflow event ID.
       #
@@ -22,11 +36,32 @@ module Deeprails
       #   @return [Boolean]
       required :filtered, Deeprails::Internal::Type::Boolean
 
-      # @!attribute improvement_tool_type
-      #   Type of improvement tool used to improve the event.
+      # @!attribute improved_model_output
+      #   Improved model output after improvement tool was applied and each metric passed
+      #   evaluation.
+      #
+      #   @return [String]
+      required :improved_model_output, String
+
+      # @!attribute improvement_action
+      #   Type of improvement action used to improve the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementAction]
+      required :improvement_action, enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementAction }
+
+      # @!attribute improvement_tool_status
+      #   Status of the improvement tool used to improve the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil]
+      required :improvement_tool_status,
+               enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus },
+               nil?: true
+
+      # @!attribute threshold_type
+      #   Type of thresholds used to evaluate the event.
       #
-      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolType]
-      required :improvement_tool_type, enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementToolType }
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ThresholdType]
+      required :threshold_type, enum: -> { Deeprails::WorkflowEventDetailResponse::ThresholdType }
 
       # @!attribute workflow_id
       #   Workflow ID associated with the event.
@@ -57,20 +92,6 @@ module Deeprails
       #   @return [Hash{Symbol=>Float}, nil]
       optional :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
 
-      # @!attribute evaluation_history
-      #   History of evaluations for the event.
-      #
-      #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory>, nil]
-      optional :evaluation_history,
-               -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::EvaluationHistory] }
-
-      # @!attribute evaluation_result
-      #   Evaluation result consisting of average scores and rationales for each of the
-      #   evaluated guardrail metrics.
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
-
       # @!attribute files
       #   List of files available to the event, if any. Will only be present if
       #   `file_search` is enabled.
@@ -78,38 +99,27 @@ module Deeprails
       #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::File>, nil]
       optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::File] }
 
-      # @!attribute improved_model_output
-      #   Improved model output after improvement tool was applied and each metric passed
-      #   evaluation.
-      #
-      #   @return [String, nil]
-      optional :improved_model_output, String
-
-      # @!attribute improvement_tool_status
-      #   Status of the improvement tool used to improve the event.
-      #
-      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil]
-      optional :improvement_tool_status,
-               enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus },
-               nil?: true
-
-      # @!attribute threshold_type
-      #   Type of thresholds used to evaluate the event.
-      #
-      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ThresholdType, nil]
-      optional :threshold_type, enum: -> { Deeprails::WorkflowEventDetailResponse::ThresholdType }
-
-      # @!method initialize(event_id:, event_status:, filtered:, improvement_tool_type:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, custom_hallucination_threshold_values: nil, evaluation_history: nil, evaluation_result: nil, files: nil, improved_model_output: nil, improvement_tool_status: nil, threshold_type: nil)
+      # @!method initialize(evaluation_history:, evaluation_result:, event_id:, event_status:, filtered:, improved_model_output:, improvement_action:, improvement_tool_status:, threshold_type:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, custom_hallucination_threshold_values: nil, files: nil)
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::WorkflowEventDetailResponse} for more details.
       #
+      #   @param evaluation_history [Array<Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory>] History of evaluations for the event.
+      #
+      #   @param evaluation_result [Hash{Symbol=>Object}] Evaluation result consisting of average scores and rationales for each of the ev
+      #
       #   @param event_id [String] A unique workflow event ID.
       #
       #   @param event_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::EventStatus] Status of the event.
       #
       #   @param filtered [Boolean] Whether the event was filtered and requires improvement.
       #
-      #   @param improvement_tool_type [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolType] Type of improvement tool used to improve the event.
+      #   @param improved_model_output [String] Improved model output after improvement tool was applied and each metric passed
+      #
+      #   @param improvement_action [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementAction] Type of improvement action used to improve the event.
+      #
+      #   @param improvement_tool_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil] Status of the improvement tool used to improve the event.
+      #
+      #   @param threshold_type [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ThresholdType] Type of thresholds used to evaluate the event.
       #
       #   @param workflow_id [String] Workflow ID associated with the event.
       #
@@ -119,65 +129,7 @@ module Deeprails
       #
       #   @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metric names to threshold values. Values are floating point
       #
-      #   @param evaluation_history [Array<Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory>] History of evaluations for the event.
-      #
-      #   @param evaluation_result [Hash{Symbol=>Object}] Evaluation result consisting of average scores and rationales for each of the ev
-      #
       #   @param files [Array<Deeprails::Models::WorkflowEventDetailResponse::File>] List of files available to the event, if any. Will only be present if `file_sear
-      #
-      #   @param improved_model_output [String] Improved model output after improvement tool was applied and each metric passed
-      #
-      #   @param improvement_tool_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil] Status of the improvement tool used to improve the event.
-      #
-      #   @param threshold_type [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ThresholdType] Type of thresholds used to evaluate the event.
-
-      # Status of the event.
-      #
-      # @see Deeprails::Models::WorkflowEventDetailResponse#event_status
-      module EventStatus
-        extend Deeprails::Internal::Type::Enum
-
-        IN_PROGRESS = :"In Progress"
-        COMPLETED = :Completed
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Type of improvement tool used to improve the event.
-      #
-      # @see Deeprails::Models::WorkflowEventDetailResponse#improvement_tool_type
-      module ImprovementToolType
-        extend Deeprails::Internal::Type::Enum
-
-        REGEN = :regen
-        FIXIT = :fixit
-        DO_NOTHING = :do_nothing
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module AutomaticHallucinationToleranceLevel
-        extend Deeprails::Internal::Type::Enum
-
-        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 EvaluationHistory < Deeprails::Internal::Type::BaseModel
         # @!attribute attempt
@@ -261,26 +213,31 @@ module Deeprails
         #   @param run_mode [String]
       end
 
-      class File < Deeprails::Internal::Type::BaseModel
-        # @!attribute file_id
-        #
-        #   @return [String, nil]
-        optional :file_id, String
+      # Status of the event.
+      #
+      # @see Deeprails::Models::WorkflowEventDetailResponse#event_status
+      module EventStatus
+        extend Deeprails::Internal::Type::Enum
 
-        # @!attribute file_name
-        #
-        #   @return [String, nil]
-        optional :file_name, String
+        IN_PROGRESS = :"In Progress"
+        COMPLETED = :Completed
 
-        # @!attribute file_size
-        #
-        #   @return [Integer, nil]
-        optional :file_size, Integer
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
 
-        # @!method initialize(file_id: nil, file_name: nil, file_size: nil)
-        #   @param file_id [String]
-        #   @param file_name [String]
-        #   @param file_size [Integer]
+      # Type of improvement action used to improve the event.
+      #
+      # @see Deeprails::Models::WorkflowEventDetailResponse#improvement_action
+      module ImprovementAction
+        extend Deeprails::Internal::Type::Enum
+
+        REGEN = :regen
+        FIXIT = :fixit
+        DO_NOTHING = :do_nothing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # Status of the improvement tool used to improve the event.
@@ -309,6 +266,49 @@ module Deeprails
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      module AutomaticHallucinationToleranceLevel
+        extend Deeprails::Internal::Type::Enum
+
+        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 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
     end
   end
 end

data/lib/deeprails/models.rb

@@ -69,6 +69,8 @@ module Deeprails
 
   MonitorEventResponse = Deeprails::Models::MonitorEventResponse
 
+  MonitorRetrieveEventParams = Deeprails::Models::MonitorRetrieveEventParams
+
   MonitorRetrieveParams = Deeprails::Models::MonitorRetrieveParams
 
   MonitorSubmitEventParams = Deeprails::Models::MonitorSubmitEventParams

data/lib/deeprails/resources/monitor.rb

@@ -97,6 +97,33 @@ module Deeprails
         )
       end
 
+      # Use this endpoint to retrieve the details of a specific monitor event
+      #
+      # @overload retrieve_event(event_id, monitor_id:, request_options: {})
+      #
+      # @param event_id [String] The ID of the requested monitor event.
+      #
+      # @param monitor_id [String] The ID of the monitor associated with this event.
+      #
+      # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Deeprails::Models::MonitorEventDetailResponse]
+      #
+      # @see Deeprails::Models::MonitorRetrieveEventParams
+      def retrieve_event(event_id, params)
+        parsed, options = Deeprails::MonitorRetrieveEventParams.dump_request(params)
+        monitor_id =
+          parsed.delete(:monitor_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["monitor/%1$s/events/%2$s", monitor_id, event_id],
+          model: Deeprails::MonitorEventDetailResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::MonitorSubmitEventParams} for more details.
       #

data/lib/deeprails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deeprails
-  VERSION = "0.12.0"
+  VERSION = "0.14.0"
 end

data/lib/deeprails.rb

@@ -66,6 +66,7 @@ require_relative "deeprails/models/monitor_create_response"
 require_relative "deeprails/models/monitor_detail_response"
 require_relative "deeprails/models/monitor_event_detail_response"
 require_relative "deeprails/models/monitor_event_response"
+require_relative "deeprails/models/monitor_retrieve_event_params"
 require_relative "deeprails/models/monitor_retrieve_params"
 require_relative "deeprails/models/monitor_submit_event_params"
 require_relative "deeprails/models/monitor_update_params"