deeprails 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ebaa7695ef61eb142c92bdfdfca4efe6f3f9d3bac539994d35677283471188a
-  data.tar.gz: a0d241e2195cf1e576026ff4f07814ac2c1c3d6f2bd99a3ea96adc1851348fbe
+  metadata.gz: b7192d4dabd071a76430b8c959bf2d81f4e8e669c3ff435b3e03137e571ccf6a
+  data.tar.gz: de4f603949d3e0e379c7c0f4549d9d96f776f0ce4a591bceabdc54eb4b957a21
 SHA512:
-  metadata.gz: 2b444b978686ad3dd6464b0efb880aff62ea9e5cb40208eeb0e428c5377f5c0088c7c25d12999881f02c719c8da0fee1adcd21ad9ab5c376fec24b5ba38506bf
-  data.tar.gz: f9f557f27e5462b23dd53adc46eef67a11ceee0872dea89229b5ab55d38b28f87a487ff91b747f899aeaea5bff65456c4c61c079261256c41617bd583691ec21
+  metadata.gz: ba34997d3b6e6c383ee5570dc9bdfb4b39a88ab9b18749d15bb52c053fcd7b8cc5104382b5ea48cc23be05dbf98ede56d60edf0dc9997264c3d9323db35e6a34
+  data.tar.gz: d25c2b15590f995f3eb80ec2460c7888cc7f7359c6f5dc157cf582594b8ed813b0025fdc029c2128a2fa6b912e8338f139a8afba19a6067dd9fe15e43ed71b6c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.4.0 (2025-10-16)
+
+Full Changelog: [v0.3.1...v0.4.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.3.1...v0.4.0)
+
+### Features
+
+* **api:** adding support for system_prompt and ground_truth ([6b292f8](https://github.com/deeprails/deeprails-ruby-sdk/commit/6b292f8e125423e582f3937c343934e916e94ff6))
+
 ## 0.3.1 (2025-10-16)
 
 Full Changelog: [v0.3.0...v0.3.1](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.3.0...v0.3.1)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "deeprails", "~> 0.3.1"
+gem "deeprails", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/deeprails/models/defend_submit_event_params.rb

@@ -8,9 +8,9 @@ module Deeprails
       include Deeprails::Internal::Type::RequestParameters
 
       # @!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.
+      #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
+      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::DefendSubmitEventParams::ModelInput]
       required :model_input, -> { Deeprails::DefendSubmitEventParams::ModelInput }
@@ -46,7 +46,7 @@ module Deeprails
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendSubmitEventParams} for more details.
       #
-      #   @param model_input [Deeprails::Models::DefendSubmitEventParams::ModelInput] A dictionary of inputs sent to the LLM to generate output. This must contain a
+      #   @param model_input [Deeprails::Models::DefendSubmitEventParams::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.
       #
@@ -59,23 +59,34 @@ module Deeprails
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
 
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        # @!attribute user_prompt
+        # @!attribute ground_truth
+        #   The ground truth for evaluating Ground Truth Adherence guardrail.
+        #
+        #   @return [String, nil]
+        optional :ground_truth, String
+
+        # @!attribute system_prompt
+        #   The system prompt used to generate the output.
         #
-        #   @return [String]
-        required :user_prompt, String
+        #   @return [String, nil]
+        optional :system_prompt, String
 
-        # @!attribute context
+        # @!attribute user_prompt
+        #   The user prompt used to generate the output.
         #
         #   @return [String, nil]
-        optional :context, String
+        optional :user_prompt, 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.
+        # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
+        #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        #
+        #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.
+        #
+        #   @param system_prompt [String] The system prompt used to generate the output.
         #
-        #   @param user_prompt [String]
-        #   @param context [String]
+        #   @param user_prompt [String] The user prompt used to generate the output.
       end
 
       # Run mode for the workflow event. The run mode allows the user to optimize for

data/lib/deeprails/models/evaluate_create_params.rb

@@ -8,9 +8,9 @@ module Deeprails
       include Deeprails::Internal::Type::RequestParameters
 
       # @!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.
+      #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
+      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::EvaluateCreateParams::ModelInput]
       required :model_input, -> { Deeprails::EvaluateCreateParams::ModelInput }
@@ -55,7 +55,7 @@ module Deeprails
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::EvaluateCreateParams} for more details.
       #
-      #   @param model_input [Deeprails::Models::EvaluateCreateParams::ModelInput] A dictionary of inputs sent to the LLM to generate output. This must contain a
+      #   @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.
       #
@@ -70,23 +70,34 @@ module Deeprails
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
 
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        # @!attribute user_prompt
+        # @!attribute ground_truth
+        #   The ground truth for evaluating Ground Truth Adherence guardrail.
+        #
+        #   @return [String, nil]
+        optional :ground_truth, String
+
+        # @!attribute system_prompt
+        #   The system prompt used to generate the output.
         #
-        #   @return [String]
-        required :user_prompt, String
+        #   @return [String, nil]
+        optional :system_prompt, String
 
-        # @!attribute context
+        # @!attribute user_prompt
+        #   The user prompt used to generate the output.
         #
         #   @return [String, nil]
-        optional :context, String
+        optional :user_prompt, 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.
+        # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
+        #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        #
+        #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.
+        #
+        #   @param system_prompt [String] The system prompt used to generate the output.
         #
-        #   @param user_prompt [String]
-        #   @param context [String]
+        #   @param user_prompt [String] The user prompt used to generate the output.
       end
 
       # Run mode for the evaluation. The run mode allows the user to optimize for speed,

data/lib/deeprails/models/evaluation.rb

@@ -18,8 +18,8 @@ module Deeprails
 
       # @!attribute model_input
       #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      #   contain a `user_prompt` field and an optional `context` field. Additional
-      #   properties are allowed.
+      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::Evaluation::ModelInput]
       required :model_input, -> { Deeprails::Evaluation::ModelInput }
@@ -169,26 +169,34 @@ module Deeprails
 
       # @see Deeprails::Models::Evaluation#model_input
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        # @!attribute user_prompt
-        #   The user prompt used to generate the output.
+        # @!attribute ground_truth
+        #   The ground truth for evaluating Ground Truth Adherence guardrail.
         #
-        #   @return [String]
-        required :user_prompt, String
+        #   @return [String, nil]
+        optional :ground_truth, String
 
-        # @!attribute context
-        #   Optional context supplied to the LLM when generating the output.
+        # @!attribute system_prompt
+        #   The system prompt used to generate the output.
         #
         #   @return [String, nil]
-        optional :context, String
+        optional :system_prompt, String
 
-        # @!method initialize(user_prompt:, context: nil)
+        # @!attribute user_prompt
+        #   The user prompt used to generate the output.
+        #
+        #   @return [String, nil]
+        optional :user_prompt, String
+
+        # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
         #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        #   contain a `user_prompt` field and an optional `context` field. Additional
-        #   properties are allowed.
+        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         #
-        #   @param user_prompt [String] The user prompt used to generate the output.
+        #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.
         #
-        #   @param context [String] Optional context supplied to the LLM when generating the output.
+        #   @param system_prompt [String] The system prompt used to generate the output.
+        #
+        #   @param user_prompt [String] The user prompt used to generate the output.
       end
 
       # Run mode for the evaluation. The run mode allows the user to optimize for speed,

data/lib/deeprails/models/monitor_submit_event_params.rb

@@ -18,9 +18,9 @@ module Deeprails
                -> { 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.
+      #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
+      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::MonitorSubmitEventParams::ModelInput]
       required :model_input, -> { Deeprails::MonitorSubmitEventParams::ModelInput }
@@ -58,7 +58,7 @@ module Deeprails
       #
       #   @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_input [Deeprails::Models::MonitorSubmitEventParams::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.
       #
@@ -85,23 +85,34 @@ module Deeprails
       end
 
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        # @!attribute user_prompt
+        # @!attribute ground_truth
+        #   The ground truth for evaluating Ground Truth Adherence guardrail.
+        #
+        #   @return [String, nil]
+        optional :ground_truth, String
+
+        # @!attribute system_prompt
+        #   The system prompt used to generate the output.
         #
-        #   @return [String]
-        required :user_prompt, String
+        #   @return [String, nil]
+        optional :system_prompt, String
 
-        # @!attribute context
+        # @!attribute user_prompt
+        #   The user prompt used to generate the output.
         #
         #   @return [String, nil]
-        optional :context, String
+        optional :user_prompt, 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.
+        # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
+        #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        #
+        #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.
+        #
+        #   @param system_prompt [String] The system prompt used to generate the output.
         #
-        #   @param user_prompt [String]
-        #   @param context [String]
+        #   @param user_prompt [String] The user prompt used to generate the output.
       end
 
       # Run mode for the monitor event. The run mode allows the user to optimize for

data/lib/deeprails/resources/defend.rb

@@ -98,7 +98,7 @@ module Deeprails
       #
       # @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_input [Deeprails::Models::DefendSubmitEventParams::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.
       #

data/lib/deeprails/resources/evaluate.rb

@@ -11,7 +11,7 @@ module Deeprails
       #
       # @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. This must contain a
+      # @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.
       #

data/lib/deeprails/resources/monitor.rb

@@ -97,7 +97,7 @@ module Deeprails
       #
       # @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_input [Deeprails::Models::MonitorSubmitEventParams::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.
       #

data/lib/deeprails/version.rb

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

data/rbi/deeprails/models/defend_submit_event_params.rbi

@@ -14,9 +14,9 @@ module Deeprails
           )
         end
 
-      # 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.
+      # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+      # contain at least one of `user_prompt` or `system_prompt`. For
+      # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       sig { returns(Deeprails::DefendSubmitEventParams::ModelInput) }
       attr_reader :model_input
 
@@ -60,9 +60,9 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,
@@ -103,25 +103,52 @@ module Deeprails
             )
           end
 
-        sig { returns(String) }
-        attr_accessor :user_prompt
+        # 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 :context
+        attr_reader :user_prompt
 
-        sig { params(context: String).void }
-        attr_writer :context
+        sig { params(user_prompt: String).void }
+        attr_writer :user_prompt
 
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         sig do
-          params(user_prompt: String, context: String).returns(T.attached_class)
+          params(
+            ground_truth: String,
+            system_prompt: String,
+            user_prompt: String
+          ).returns(T.attached_class)
         end
-        def self.new(user_prompt:, context: nil)
+        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 { override.returns({ user_prompt: String, context: String }) }
+        sig do
+          override.returns(
+            { ground_truth: String, system_prompt: String, user_prompt: String }
+          )
+        end
         def to_hash
         end
       end

data/rbi/deeprails/models/evaluate_create_params.rbi

@@ -11,9 +11,9 @@ module Deeprails
           T.any(Deeprails::EvaluateCreateParams, Deeprails::Internal::AnyHash)
         end
 
-      # 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.
+      # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+      # contain at least one of `user_prompt` or `system_prompt`. For
+      # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       sig { returns(Deeprails::EvaluateCreateParams::ModelInput) }
       attr_reader :model_input
 
@@ -84,9 +84,9 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,
@@ -135,25 +135,52 @@ module Deeprails
             )
           end
 
-        sig { returns(String) }
-        attr_accessor :user_prompt
+        # 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 :context
+        attr_reader :user_prompt
 
-        sig { params(context: String).void }
-        attr_writer :context
+        sig { params(user_prompt: String).void }
+        attr_writer :user_prompt
 
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         sig do
-          params(user_prompt: String, context: String).returns(T.attached_class)
+          params(
+            ground_truth: String,
+            system_prompt: String,
+            user_prompt: String
+          ).returns(T.attached_class)
         end
-        def self.new(user_prompt:, context: nil)
+        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 { override.returns({ user_prompt: String, context: String }) }
+        sig do
+          override.returns(
+            { ground_truth: String, system_prompt: String, user_prompt: String }
+          )
+        end
         def to_hash
         end
       end

data/rbi/deeprails/models/evaluation.rbi

@@ -17,8 +17,8 @@ module Deeprails
       attr_accessor :evaluation_status
 
       # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      # contain a `user_prompt` field and an optional `context` field. Additional
-      # properties are allowed.
+      # contain at least one of `user_prompt` or `system_prompt`. For
+      # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       sig { returns(Deeprails::Evaluation::ModelInput) }
       attr_reader :model_input
 
@@ -162,8 +162,8 @@ module Deeprails
         # Status of the evaluation.
         evaluation_status:,
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain a `user_prompt` field and an optional `context` field. Additional
-        # properties are allowed.
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,
@@ -276,32 +276,52 @@ module Deeprails
             )
           end
 
-        # The user prompt used to generate the output.
-        sig { returns(String) }
-        attr_accessor :user_prompt
+        # 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
 
-        # Optional context supplied to the LLM when generating the output.
+        # The system prompt used to generate the output.
         sig { returns(T.nilable(String)) }
-        attr_reader :context
+        attr_reader :system_prompt
 
-        sig { params(context: String).void }
-        attr_writer :context
+        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 a `user_prompt` field and an optional `context` field. Additional
-        # properties are allowed.
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         sig do
-          params(user_prompt: String, context: String).returns(T.attached_class)
+          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:,
-          # Optional context supplied to the LLM when generating the output.
-          context: nil
+          user_prompt: nil
         )
         end
 
-        sig { override.returns({ user_prompt: String, context: String }) }
+        sig do
+          override.returns(
+            { ground_truth: String, system_prompt: String, user_prompt: String }
+          )
+        end
         def to_hash
         end
       end

data/rbi/deeprails/models/monitor_submit_event_params.rbi

@@ -27,9 +27,9 @@ module Deeprails
       end
       attr_accessor :guardrail_metrics
 
-      # 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.
+      # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+      # contain at least one of `user_prompt` or `system_prompt`. For
+      # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       sig { returns(Deeprails::MonitorSubmitEventParams::ModelInput) }
       attr_reader :model_input
 
@@ -96,9 +96,9 @@ module Deeprails
         # `completeness`, `instruction_adherence`, `context_adherence`,
         # `ground_truth_adherence`, and/or `comprehensive_safety`.
         guardrail_metrics:,
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,
@@ -194,25 +194,52 @@ module Deeprails
             )
           end
 
-        sig { returns(String) }
-        attr_accessor :user_prompt
+        # 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 :context
+        attr_reader :user_prompt
 
-        sig { params(context: String).void }
-        attr_writer :context
+        sig { params(user_prompt: String).void }
+        attr_writer :user_prompt
 
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         sig do
-          params(user_prompt: String, context: String).returns(T.attached_class)
+          params(
+            ground_truth: String,
+            system_prompt: String,
+            user_prompt: String
+          ).returns(T.attached_class)
         end
-        def self.new(user_prompt:, context: nil)
+        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 { override.returns({ user_prompt: String, context: String }) }
+        sig do
+          override.returns(
+            { ground_truth: String, system_prompt: String, user_prompt: String }
+          )
+        end
         def to_hash
         end
       end

data/rbi/deeprails/resources/defend.rbi

@@ -101,9 +101,9 @@ module Deeprails
       def submit_event(
         # Workflow ID associated with this event.
         workflow_id,
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,

data/rbi/deeprails/resources/evaluate.rbi

@@ -20,9 +20,9 @@ module Deeprails
         ).returns(Deeprails::Evaluation)
       end
       def create(
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,

data/rbi/deeprails/resources/monitor.rbi

@@ -90,9 +90,9 @@ module Deeprails
         # `completeness`, `instruction_adherence`, `context_adherence`,
         # `ground_truth_adherence`, and/or `comprehensive_safety`.
         guardrail_metrics:,
-        # 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.
+        # A dictionary of inputs sent to the LLM to generate output. The dictionary must
+        # contain at least one of `user_prompt` or `system_prompt`. For
+        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,

data/sig/deeprails/models/defend_submit_event_params.rbs

@@ -44,18 +44,33 @@ module Deeprails
         request_options: Deeprails::RequestOptions
       }
 
-      type model_input = { user_prompt: String, context: String }
+      type model_input =
+        { ground_truth: String, system_prompt: String, user_prompt: String }
 
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        attr_accessor user_prompt: String
+        attr_reader ground_truth: String?
 
-        attr_reader context: String?
+        def ground_truth=: (String) -> String
 
-        def context=: (String) -> String
+        attr_reader system_prompt: String?
 
-        def initialize: (user_prompt: String, ?context: String) -> void
+        def system_prompt=: (String) -> String
 
-        def to_hash: -> { user_prompt: String, context: String }
+        attr_reader user_prompt: String?
+
+        def user_prompt=: (String) -> String
+
+        def initialize: (
+          ?ground_truth: String,
+          ?system_prompt: String,
+          ?user_prompt: String
+        ) -> void
+
+        def to_hash: -> {
+          ground_truth: String,
+          system_prompt: String,
+          user_prompt: String
+        }
       end
 
       type run_mode = :precision_plus | :precision | :smart | :economy

data/sig/deeprails/models/evaluate_create_params.rbs

@@ -55,18 +55,33 @@ module Deeprails
         request_options: Deeprails::RequestOptions
       }
 
-      type model_input = { user_prompt: String, context: String }
+      type model_input =
+        { ground_truth: String, system_prompt: String, user_prompt: String }
 
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        attr_accessor user_prompt: String
+        attr_reader ground_truth: String?
 
-        attr_reader context: String?
+        def ground_truth=: (String) -> String
 
-        def context=: (String) -> String
+        attr_reader system_prompt: String?
 
-        def initialize: (user_prompt: String, ?context: String) -> void
+        def system_prompt=: (String) -> String
 
-        def to_hash: -> { user_prompt: String, context: String }
+        attr_reader user_prompt: String?
+
+        def user_prompt=: (String) -> String
+
+        def initialize: (
+          ?ground_truth: String,
+          ?system_prompt: String,
+          ?user_prompt: String
+        ) -> void
+
+        def to_hash: -> {
+          ground_truth: String,
+          system_prompt: String,
+          user_prompt: String
+        }
       end
 
       type run_mode = :precision_plus | :precision | :smart | :economy

data/sig/deeprails/models/evaluation.rbs

@@ -137,18 +137,33 @@ module Deeprails
         def self?.values: -> ::Array[Deeprails::Models::Evaluation::evaluation_status]
       end
 
-      type model_input = { user_prompt: String, context: String }
+      type model_input =
+        { ground_truth: String, system_prompt: String, user_prompt: String }
 
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        attr_accessor user_prompt: String
+        attr_reader ground_truth: String?
 
-        attr_reader context: String?
+        def ground_truth=: (String) -> String
 
-        def context=: (String) -> String
+        attr_reader system_prompt: String?
 
-        def initialize: (user_prompt: String, ?context: String) -> void
+        def system_prompt=: (String) -> String
 
-        def to_hash: -> { user_prompt: String, context: String }
+        attr_reader user_prompt: String?
+
+        def user_prompt=: (String) -> String
+
+        def initialize: (
+          ?ground_truth: String,
+          ?system_prompt: String,
+          ?user_prompt: String
+        ) -> void
+
+        def to_hash: -> {
+          ground_truth: String,
+          system_prompt: String,
+          user_prompt: String
+        }
       end
 
       type run_mode = :precision_plus | :precision | :smart | :economy

data/sig/deeprails/models/monitor_submit_event_params.rbs

@@ -76,18 +76,33 @@ module Deeprails
         def self?.values: -> ::Array[Deeprails::Models::MonitorSubmitEventParams::guardrail_metric]
       end
 
-      type model_input = { user_prompt: String, context: String }
+      type model_input =
+        { ground_truth: String, system_prompt: String, user_prompt: String }
 
       class ModelInput < Deeprails::Internal::Type::BaseModel
-        attr_accessor user_prompt: String
+        attr_reader ground_truth: String?
 
-        attr_reader context: String?
+        def ground_truth=: (String) -> String
 
-        def context=: (String) -> String
+        attr_reader system_prompt: String?
 
-        def initialize: (user_prompt: String, ?context: String) -> void
+        def system_prompt=: (String) -> String
 
-        def to_hash: -> { user_prompt: String, context: String }
+        attr_reader user_prompt: String?
+
+        def user_prompt=: (String) -> String
+
+        def initialize: (
+          ?ground_truth: String,
+          ?system_prompt: String,
+          ?user_prompt: String
+        ) -> void
+
+        def to_hash: -> {
+          ground_truth: String,
+          system_prompt: String,
+          user_prompt: String
+        }
       end
 
       type run_mode = :precision_plus | :precision | :smart | :economy

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deeprails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Deeprails