safetykit 0.55.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b5b4643f502907fdb970af56e96464d4678cba3f08a4b0449e07c0a2e6c40b
-  data.tar.gz: 40fea2c964bb268f0fe1fc9fc0f1a82bd4be8e5aa0e3d21873e9b1c878731681
+  metadata.gz: e4a9fe4f557160546a74ced889958cc6d4661d93568c6661b7af9c58e2fdae86
+  data.tar.gz: '039d13c3701ca7716133699eed8054fe85c58b18dadf80011ddcde34c4698fd0'
 SHA512:
-  metadata.gz: db56747981445261a4964339ba06c666e0664944691369484959ef7e269641b5ae97583380edaee53bd1ab66d37013b1bf9f644ba0e5665bd79b15c051565468
-  data.tar.gz: f54bcac9413aaf2fefa6eed5973aae54fbea31112a4f4b9c6e49fea3d69cacfe27298b80335ae93aa9c6a6c36bc13a429697dd91aad9c7c1dec3a2e9a623a79f
+  metadata.gz: 98ec2e2670762a62dd4577d7fd3b4f1e00c2f336411690a193f201b9f072a3315d5af4156c2942601d8cbac69621fa0b22480ba996ec1155d8910892c38da4da
+  data.tar.gz: ab2f31b01990b336f95ba3c3b8664c945c15c87aef7e5cb94b22a774c67825098409a7fd4fb2786561e49af435d13ce3162d7724e3ce51017e826e2a97e8d37a

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.57.0 (2026-08-11)
+
+Full Changelog: [v0.56.0...v0.57.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.56.0...v0.57.0)
+
+### Features
+
+* **api:** api update ([85b1dd1](https://github.com/GetSafetyKit/safetykit-ruby/commit/85b1dd123b3cd30db6824146d29bffe4ef5e2f57))
+
+## 0.56.0 (2026-08-07)
+
+Full Changelog: [v0.55.0...v0.56.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.55.0...v0.56.0)
+
+### Features
+
+* **api:** api update ([56f203f](https://github.com/GetSafetyKit/safetykit-ruby/commit/56f203f076e1ca7e68776fc18543d100462963a0))
+
 ## 0.55.0 (2026-08-06)
 
 Full Changelog: [v0.54.0...v0.55.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.54.0...v0.55.0)

data/README.md

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

data/lib/safety_kit/models/content_create_response.rb

@@ -61,10 +61,11 @@ module SafetyKit
         required :policy_id, String
 
         # @!attribute score
-        #   Policy score between 0 and 1. Higher means more likely violating.
+        #   Classifier score between 0 and 1. Higher means more likely violating. Null when
+        #   no classifier scored the policy.
         #
-        #   @return [Float]
-        required :score, Float
+        #   @return [Float, nil]
+        required :score, Float, nil?: true
 
         # @!attribute version
         #   Version of the policy.
@@ -73,6 +74,9 @@ module SafetyKit
         required :version, String
 
         # @!method initialize(decision:, escalation:, policy_id:, score:, version:)
+        #   Some parameter documentations has been truncated, see
+        #   {SafetyKit::Models::ContentCreateResponse::Policy} for more details.
+        #
         #   Result for one policy evaluated against the submitted content.
         #
         #   @param decision [Symbol, SafetyKit::Models::ContentCreateResponse::Policy::Decision] Whether the submitted content violates the policy.
@@ -81,7 +85,7 @@ module SafetyKit
         #
         #   @param policy_id [String] Identifier of the policy.
         #
-        #   @param score [Float] Policy score between 0 and 1. Higher means more likely violating.
+        #   @param score [Float, nil] Classifier score between 0 and 1. Higher means more likely violating. Null when
         #
         #   @param version [String] Version of the policy.
 

data/lib/safety_kit/resources/content.rb

@@ -12,6 +12,11 @@ module SafetyKit
       # both, and receive per-policy results in the response. Requests have a maximum
       # size of 6MB.
       #
+      # Errors: 400 for an invalid body or images, with the failing field in the
+      # message. 401 for a missing or invalid API key. 413 for requests over 6MB. 503
+      # when classification is temporarily unavailable, in which case the request was
+      # not processed and is safe to retry.
+      #
       # @overload create(user_id:, content_id: nil, images: nil, metadata: nil, text: nil, request_options: {})
       #
       # @param user_id [String] Your stable identifier for the user this content belongs to.

data/lib/safety_kit/resources/streams.rb

@@ -6,6 +6,12 @@ module SafetyKit
     class Streams
       # Monitor the livestream at the given stream URL. This method returns immediately.
       #
+      # Errors: 400 for an invalid body, with the reason in the message. 401 for a
+      # missing Authorization header. 403 for an invalid API key. 429 when the rate
+      # limit is exceeded. 5xx for transient internal failures. Retry 429 and 5xx with
+      # exponential backoff. Do not retry other 4xx errors, they indicate a problem with
+      # the request.
+      #
       # @overload add(namespace, id:, stream_url:, request_options: {})
       #
       # @param namespace [String] The namespace to ingest stream data into
@@ -43,6 +49,13 @@ module SafetyKit
       # ignored by downstream processing. This method returns immediately after the
       # frame has been accepted for processing.
       #
+      # Errors: 400 for an invalid body or an image that fails validation, with the
+      # reason in the message. 401 for a missing Authorization header. 403 for an
+      # invalid API key. 429 when the rate limit is exceeded. 5xx for transient internal
+      # failures. Retry 429 and 5xx with exponential backoff. Frame ingestion is
+      # idempotent, so a retried request that already succeeded is ignored. Do not retry
+      # other 4xx errors, they indicate a problem with the request.
+      #
       # @overload add_frame(namespace, image_data_uri:, stream_id:, timestamp:, frame_id: nil, metadata: nil, request_options: {})
       #
       # @param namespace [String] The namespace to ingest stream data into
@@ -80,6 +93,13 @@ module SafetyKit
       # correctly with later frames. This method returns immediately after the
       # transcript has been accepted for processing.
       #
+      # Errors: 400 for an invalid body, with the reason in the message. 401 for a
+      # missing Authorization header. 403 for an invalid API key. 429 when the rate
+      # limit is exceeded. 5xx for transient internal failures. Retry 429 and 5xx with
+      # exponential backoff. Transcript ingestion is idempotent, so a retried request
+      # that already succeeded is ignored. Do not retry other 4xx errors, they indicate
+      # a problem with the request.
+      #
       # @overload add_transcript(namespace, stream_id:, text:, timestamp:, transcript_id: nil, request_options: {})
       #
       # @param namespace [String] The namespace to ingest stream data into

data/lib/safety_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafetyKit
-  VERSION = "0.55.0"
+  VERSION = "0.57.0"
 end

data/rbi/safety_kit/models/content_create_response.rbi

@@ -104,8 +104,9 @@ module SafetyKit
         sig { returns(String) }
         attr_accessor :policy_id
 
-        # Policy score between 0 and 1. Higher means more likely violating.
-        sig { returns(Float) }
+        # Classifier score between 0 and 1. Higher means more likely violating. Null when
+        # no classifier scored the policy.
+        sig { returns(T.nilable(Float)) }
         attr_accessor :score
 
         # Version of the policy.
@@ -120,7 +121,7 @@ module SafetyKit
             escalation:
               SafetyKit::Models::ContentCreateResponse::Policy::Escalation::OrSymbol,
             policy_id: String,
-            score: Float,
+            score: T.nilable(Float),
             version: String
           ).returns(T.attached_class)
         end
@@ -131,7 +132,8 @@ module SafetyKit
           escalation:,
           # Identifier of the policy.
           policy_id:,
-          # Policy score between 0 and 1. Higher means more likely violating.
+          # Classifier score between 0 and 1. Higher means more likely violating. Null when
+          # no classifier scored the policy.
           score:,
           # Version of the policy.
           version:
@@ -146,7 +148,7 @@ module SafetyKit
               escalation:
                 SafetyKit::Models::ContentCreateResponse::Policy::Escalation::TaggedSymbol,
               policy_id: String,
-              score: Float,
+              score: T.nilable(Float),
               version: String
             }
           )

data/rbi/safety_kit/resources/content.rbi

@@ -8,6 +8,11 @@ module SafetyKit
       # Classify a piece of content synchronously. Send user-authored text, images, or
       # both, and receive per-policy results in the response. Requests have a maximum
       # size of 6MB.
+      #
+      # Errors: 400 for an invalid body or images, with the failing field in the
+      # message. 401 for a missing or invalid API key. 413 for requests over 6MB. 503
+      # when classification is temporarily unavailable, in which case the request was
+      # not processed and is safe to retry.
       sig do
         params(
           user_id: String,

data/rbi/safety_kit/resources/streams.rbi

@@ -5,6 +5,12 @@ module SafetyKit
     # Ingest and monitor livestream content.
     class Streams
       # Monitor the livestream at the given stream URL. This method returns immediately.
+      #
+      # Errors: 400 for an invalid body, with the reason in the message. 401 for a
+      # missing Authorization header. 403 for an invalid API key. 429 when the rate
+      # limit is exceeded. 5xx for transient internal failures. Retry 429 and 5xx with
+      # exponential backoff. Do not retry other 4xx errors, they indicate a problem with
+      # the request.
       sig do
         params(
           namespace: String,
@@ -31,6 +37,13 @@ module SafetyKit
       # Duplicate or out-of-order frame timestamps are accepted at the API boundary but
       # ignored by downstream processing. This method returns immediately after the
       # frame has been accepted for processing.
+      #
+      # Errors: 400 for an invalid body or an image that fails validation, with the
+      # reason in the message. 401 for a missing Authorization header. 403 for an
+      # invalid API key. 429 when the rate limit is exceeded. 5xx for transient internal
+      # failures. Retry 429 and 5xx with exponential backoff. Frame ingestion is
+      # idempotent, so a retried request that already succeeded is ignored. Do not retry
+      # other 4xx errors, they indicate a problem with the request.
       sig do
         params(
           namespace: String,
@@ -67,6 +80,13 @@ module SafetyKit
       # monotonically increasing within a stream so transcript context lines up
       # correctly with later frames. This method returns immediately after the
       # transcript has been accepted for processing.
+      #
+      # Errors: 400 for an invalid body, with the reason in the message. 401 for a
+      # missing Authorization header. 403 for an invalid API key. 429 when the rate
+      # limit is exceeded. 5xx for transient internal failures. Retry 429 and 5xx with
+      # exponential backoff. Transcript ingestion is idempotent, so a retried request
+      # that already succeeded is ignored. Do not retry other 4xx errors, they indicate
+      # a problem with the request.
       sig do
         params(
           namespace: String,

data/sig/safety_kit/models/content_create_response.rbs

@@ -36,7 +36,7 @@ module SafetyKit
           decision: SafetyKit::Models::ContentCreateResponse::Policy::decision,
           escalation: SafetyKit::Models::ContentCreateResponse::Policy::escalation,
           policy_id: String,
-          score: Float,
+          score: Float?,
           version: String
         }
 
@@ -47,7 +47,7 @@ module SafetyKit
 
         attr_accessor policy_id: String
 
-        attr_accessor score: Float
+        attr_accessor score: Float?
 
         attr_accessor version: String
 
@@ -55,7 +55,7 @@ module SafetyKit
           decision: SafetyKit::Models::ContentCreateResponse::Policy::decision,
           escalation: SafetyKit::Models::ContentCreateResponse::Policy::escalation,
           policy_id: String,
-          score: Float,
+          score: Float?,
           version: String
         ) -> void
 
@@ -63,7 +63,7 @@ module SafetyKit
           decision: SafetyKit::Models::ContentCreateResponse::Policy::decision,
           escalation: SafetyKit::Models::ContentCreateResponse::Policy::escalation,
           policy_id: String,
-          score: Float,
+          score: Float?,
           version: String
         }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safetykit
 version: !ruby/object:Gem::Version
-  version: 0.55.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Safetykit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-06 00:00:00.000000000 Z
+date: 2026-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi