moderation_api 2.34.0 → 2.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c81ee2a9da518fa7c2d46dd6de06482739a80d3c7bc72e415c459e049b5118
-  data.tar.gz: 30591937048d8e2662f1b4106fa0a1e1478220759995543efd8305a24e31fbc0
+  metadata.gz: 58efdd27a36bd37a1e9b27e916fe3591f4ad21e43f3dac943a48cdee701f84e5
+  data.tar.gz: cb32bc627ec56cc42a6c0831ef68a25da57a591695662f30c6177799d34e252e
 SHA512:
-  metadata.gz: f22f683cf8f5a19e6f672ea2823869a529aae0a159ad30a7eda1e47fb1ca5f2714d1bab28b21b05af334ad8fa645797cf9efbcddf709bfa5f18fb86e13f5140e
-  data.tar.gz: 0e6cd98b619b02bbdcfa571fcae9f9903c8062f95554f1673649c5c8341190c3d321a15fcaffcde5eeb7b1c5fbd87f35f7cfe00e8dd4df04d0db1b4df6786c93
+  metadata.gz: ef3456ebe2958f141802fd4d6e46dc1ce03ad95805d5158658b0c1a6cd3aca172a659c4d8758f0737ca1f3a65d9727c84d138f403af835618f6e817a712162b8
+  data.tar.gz: 703455e6b65df299a0b01e4ee53bb51ab68e25e7d4188025d467d6200c529261bd49171ed5eecdaa1c9dedac41f4a012f16809c4a5f5daf45268ce20b57c2cfd

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.35.0 (2026-08-21)
+
+Full Changelog: [v2.34.0...v2.35.0](https://github.com/moderation-api/sdk-ruby/compare/v2.34.0...v2.35.0)
+
+### Features
+
+* **api:** api update ([ce30b48](https://github.com/moderation-api/sdk-ruby/commit/ce30b48c33ec082b8143b3af082d07de83c44a3d))
+
 ## 2.34.0 (2026-08-20)
 
 Full Changelog: [v2.33.0...v2.34.0](https://github.com/moderation-api/sdk-ruby/compare/v2.33.0...v2.34.0)

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 "moderation_api", "~> 2.34.0"
+gem "moderation_api", "~> 2.35.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/moderation_api/models/content_submit_response.rb

@@ -11,6 +11,16 @@ module ModerationAPI
       #   @return [ModerationAPI::Models::ContentSubmitResponse::Author, nil]
       required :author, -> { ModerationAPI::Models::ContentSubmitResponse::Author }, nil?: true
 
+      # @!attribute casebook
+      #   What your casebook — the record of your past moderation decisions — found for
+      #   this content, or null when it had nothing close enough to say, when the matching
+      #   cases disagreed, or when casebook lookups are not switched on for this channel.
+      #   Reports what the casebook found; whether it decided the outcome is shown in
+      #   `recommendation`, where a higher-priority rule may have settled the item first.
+      #
+      #   @return [ModerationAPI::Models::ContentSubmitResponse::Casebook, nil]
+      required :casebook, -> { ModerationAPI::Models::ContentSubmitResponse::Casebook }, nil?: true
+
       # @!attribute content
       #   Potentially modified content.
       #
@@ -56,12 +66,14 @@ module ModerationAPI
       optional :errors,
                -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ContentSubmitResponse::Error] }
 
-      # @!method initialize(author:, content:, evaluation:, insights:, meta:, policies:, recommendation:, errors: nil)
+      # @!method initialize(author:, casebook:, content:, evaluation:, insights:, meta:, policies:, recommendation:, errors: nil)
       #   Some parameter documentations has been truncated, see
       #   {ModerationAPI::Models::ContentSubmitResponse} for more details.
       #
       #   @param author [ModerationAPI::Models::ContentSubmitResponse::Author, nil] The author of the content if your account has authors enabled. Requires you to s
       #
+      #   @param casebook [ModerationAPI::Models::ContentSubmitResponse::Casebook, nil] What your casebook — the record of your past moderation decisions — found for th
+      #
       #   @param content [ModerationAPI::Models::ContentSubmitResponse::Content] Potentially modified content.
       #
       #   @param evaluation [ModerationAPI::Models::ContentSubmitResponse::Evaluation] The evaluation of the content after running the channel policies.
@@ -178,6 +190,109 @@ module ModerationAPI
         end
       end
 
+      # @see ModerationAPI::Models::ContentSubmitResponse#casebook
+      class Casebook < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute agreement
+        #   How unanimous the matching cases are, from 0 to 1: the share of them that
+        #   decided this way, ignoring how many there are. Always at least 0.8 when a ruling
+        #   is returned — below that the casebook reports a disagreement instead of picking
+        #   a side — so it tells you how clean the consensus was, and is not a threshold to
+        #   re-apply yourself.
+        #
+        #   @return [Float]
+        required :agreement, Float
+
+        # @!attribute case_count
+        #   How many of your past cases backed this ruling.
+        #
+        #   @return [Float]
+        required :case_count, Float
+
+        # @!attribute confidence
+        #   How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled
+        #   by how much evidence backs it, so a handful of close, recent cases outweighs one
+        #   distant one. Older cases count for less, halving in weight roughly every 180
+        #   days. This is the number to use in rules when you want a strength condition.
+        #
+        #   @return [Float]
+        required :confidence, Float
+
+        # @!attribute similarity
+        #   How close the nearest matching case is, from 0 to 1. 1 means the content is
+        #   identical to something you have already decided.
+        #
+        #   @return [Float]
+        required :similarity, Float
+
+        # @!attribute topic
+        #   The topic the closest matching case is filed under, or null when it has not been
+        #   grouped into one yet.
+        #
+        #   @return [ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic, nil]
+        required :topic, -> { ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic }, nil?: true
+
+        # @!attribute verdict
+        #   The ruling your past decisions point to for this content.
+        #
+        #   @return [Symbol, ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict]
+        required :verdict, enum: -> { ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict }
+
+        # @!method initialize(agreement:, case_count:, confidence:, similarity:, topic:, verdict:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModerationAPI::Models::ContentSubmitResponse::Casebook} for more details.
+        #
+        #   What your casebook — the record of your past moderation decisions — found for
+        #   this content, or null when it had nothing close enough to say, when the matching
+        #   cases disagreed, or when casebook lookups are not switched on for this channel.
+        #   Reports what the casebook found; whether it decided the outcome is shown in
+        #   `recommendation`, where a higher-priority rule may have settled the item first.
+        #
+        #   @param agreement [Float] How unanimous the matching cases are, from 0 to 1: the share of them that decide
+        #
+        #   @param case_count [Float] How many of your past cases backed this ruling.
+        #
+        #   @param confidence [Float] How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled b
+        #
+        #   @param similarity [Float] How close the nearest matching case is, from 0 to 1. 1 means the content is iden
+        #
+        #   @param topic [ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic, nil] The topic the closest matching case is filed under, or null when it has not been
+        #
+        #   @param verdict [Symbol, ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict] The ruling your past decisions point to for this content.
+
+        # @see ModerationAPI::Models::ContentSubmitResponse::Casebook#topic
+        class Topic < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute label
+          #
+          #   @return [String]
+          required :label, String
+
+          # @!method initialize(id:, label:)
+          #   The topic the closest matching case is filed under, or null when it has not been
+          #   grouped into one yet.
+          #
+          #   @param id [String]
+          #   @param label [String]
+        end
+
+        # The ruling your past decisions point to for this content.
+        #
+        # @see ModerationAPI::Models::ContentSubmitResponse::Casebook#verdict
+        module Verdict
+          extend ModerationAPI::Internal::Type::Enum
+
+          ALLOW = :allow
+          REJECT = :reject
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ModerationAPI::Models::ContentSubmitResponse#content
       class Content < ModerationAPI::Internal::Type::BaseModel
         # @!attribute id
@@ -935,6 +1050,8 @@ module ModerationAPI
 
           variant const: -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::CLIENT_OVERRIDE }
 
+          variant const: -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::CASEBOOK_MATCH }
+
           variant String
 
           # @!method self.variants
@@ -956,6 +1073,7 @@ module ModerationAPI
           RULE_DEFAULT = :rule_default
           RULE_FALLBACK = :rule_fallback
           CLIENT_OVERRIDE = :client_override
+          CASEBOOK_MATCH = :casebook_match
 
           # @!endgroup
         end

data/lib/moderation_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModerationAPI
-  VERSION = "2.34.0"
+  VERSION = "2.35.0"
 end

data/rbi/moderation_api/models/content_submit_response.rbi

@@ -28,6 +28,28 @@ module ModerationAPI
       end
       attr_writer :author
 
+      # What your casebook — the record of your past moderation decisions — found for
+      # this content, or null when it had nothing close enough to say, when the matching
+      # cases disagreed, or when casebook lookups are not switched on for this channel.
+      # Reports what the casebook found; whether it decided the outcome is shown in
+      # `recommendation`, where a higher-priority rule may have settled the item first.
+      sig do
+        returns(
+          T.nilable(ModerationAPI::Models::ContentSubmitResponse::Casebook)
+        )
+      end
+      attr_reader :casebook
+
+      sig do
+        params(
+          casebook:
+            T.nilable(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::OrHash
+            )
+        ).void
+      end
+      attr_writer :casebook
+
       # Potentially modified content.
       sig { returns(ModerationAPI::Models::ContentSubmitResponse::Content) }
       attr_reader :content
@@ -122,6 +144,10 @@ module ModerationAPI
             T.nilable(
               ModerationAPI::Models::ContentSubmitResponse::Author::OrHash
             ),
+          casebook:
+            T.nilable(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::OrHash
+            ),
           content:
             ModerationAPI::Models::ContentSubmitResponse::Content::OrHash,
           evaluation:
@@ -153,6 +179,12 @@ module ModerationAPI
         # The author of the content if your account has authors enabled. Requires you to
         # send authorId when submitting content.
         author:,
+        # What your casebook — the record of your past moderation decisions — found for
+        # this content, or null when it had nothing close enough to say, when the matching
+        # cases disagreed, or when casebook lookups are not switched on for this channel.
+        # Reports what the casebook found; whether it decided the outcome is shown in
+        # `recommendation`, where a higher-priority rule may have settled the item first.
+        casebook:,
         # Potentially modified content.
         content:,
         # The evaluation of the content after running the channel policies.
@@ -175,6 +207,8 @@ module ModerationAPI
           {
             author:
               T.nilable(ModerationAPI::Models::ContentSubmitResponse::Author),
+            casebook:
+              T.nilable(ModerationAPI::Models::ContentSubmitResponse::Casebook),
             content: ModerationAPI::Models::ContentSubmitResponse::Content,
             evaluation:
               ModerationAPI::Models::ContentSubmitResponse::Evaluation,
@@ -419,6 +453,193 @@ module ModerationAPI
         end
       end
 
+      class Casebook < ModerationAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # How unanimous the matching cases are, from 0 to 1: the share of them that
+        # decided this way, ignoring how many there are. Always at least 0.8 when a ruling
+        # is returned — below that the casebook reports a disagreement instead of picking
+        # a side — so it tells you how clean the consensus was, and is not a threshold to
+        # re-apply yourself.
+        sig { returns(Float) }
+        attr_accessor :agreement
+
+        # How many of your past cases backed this ruling.
+        sig { returns(Float) }
+        attr_accessor :case_count
+
+        # How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled
+        # by how much evidence backs it, so a handful of close, recent cases outweighs one
+        # distant one. Older cases count for less, halving in weight roughly every 180
+        # days. This is the number to use in rules when you want a strength condition.
+        sig { returns(Float) }
+        attr_accessor :confidence
+
+        # How close the nearest matching case is, from 0 to 1. 1 means the content is
+        # identical to something you have already decided.
+        sig { returns(Float) }
+        attr_accessor :similarity
+
+        # The topic the closest matching case is filed under, or null when it has not been
+        # grouped into one yet.
+        sig do
+          returns(
+            T.nilable(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic
+            )
+          )
+        end
+        attr_reader :topic
+
+        sig do
+          params(
+            topic:
+              T.nilable(
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic::OrHash
+              )
+          ).void
+        end
+        attr_writer :topic
+
+        # The ruling your past decisions point to for this content.
+        sig do
+          returns(
+            ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+          )
+        end
+        attr_accessor :verdict
+
+        # What your casebook — the record of your past moderation decisions — found for
+        # this content, or null when it had nothing close enough to say, when the matching
+        # cases disagreed, or when casebook lookups are not switched on for this channel.
+        # Reports what the casebook found; whether it decided the outcome is shown in
+        # `recommendation`, where a higher-priority rule may have settled the item first.
+        sig do
+          params(
+            agreement: Float,
+            case_count: Float,
+            confidence: Float,
+            similarity: Float,
+            topic:
+              T.nilable(
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic::OrHash
+              ),
+            verdict:
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # How unanimous the matching cases are, from 0 to 1: the share of them that
+          # decided this way, ignoring how many there are. Always at least 0.8 when a ruling
+          # is returned — below that the casebook reports a disagreement instead of picking
+          # a side — so it tells you how clean the consensus was, and is not a threshold to
+          # re-apply yourself.
+          agreement:,
+          # How many of your past cases backed this ruling.
+          case_count:,
+          # How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled
+          # by how much evidence backs it, so a handful of close, recent cases outweighs one
+          # distant one. Older cases count for less, halving in weight roughly every 180
+          # days. This is the number to use in rules when you want a strength condition.
+          confidence:,
+          # How close the nearest matching case is, from 0 to 1. 1 means the content is
+          # identical to something you have already decided.
+          similarity:,
+          # The topic the closest matching case is filed under, or null when it has not been
+          # grouped into one yet.
+          topic:,
+          # The ruling your past decisions point to for this content.
+          verdict:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              agreement: Float,
+              case_count: Float,
+              confidence: Float,
+              similarity: Float,
+              topic:
+                T.nilable(
+                  ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic
+                ),
+              verdict:
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Topic < ModerationAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic,
+                ModerationAPI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :label
+
+          # The topic the closest matching case is filed under, or null when it has not been
+          # grouped into one yet.
+          sig { params(id: String, label: String).returns(T.attached_class) }
+          def self.new(id:, label:)
+          end
+
+          sig { override.returns({ id: String, label: String }) }
+          def to_hash
+          end
+        end
+
+        # The ruling your past decisions point to for this content.
+        module Verdict
+          extend ModerationAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALLOW =
+            T.let(
+              :allow,
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+            )
+          REJECT =
+            T.let(
+              :reject,
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Content < ModerationAPI::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1828,6 +2049,11 @@ module ModerationAPI
               :client_override,
               ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
             )
+          CASEBOOK_MATCH =
+            T.let(
+              :casebook_match,
+              ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
+            )
         end
 
         class MatchedRule < ModerationAPI::Internal::Type::BaseModel

data/sig/moderation_api/models/content_submit_response.rbs

@@ -3,6 +3,7 @@ module ModerationAPI
     type content_submit_response =
       {
         author: ModerationAPI::Models::ContentSubmitResponse::Author?,
+        casebook: ModerationAPI::Models::ContentSubmitResponse::Casebook?,
         content: ModerationAPI::Models::ContentSubmitResponse::Content,
         evaluation: ModerationAPI::Models::ContentSubmitResponse::Evaluation,
         insights: ::Array[ModerationAPI::Models::ContentSubmitResponse::insight],
@@ -15,6 +16,8 @@ module ModerationAPI
     class ContentSubmitResponse < ModerationAPI::Internal::Type::BaseModel
       attr_accessor author: ModerationAPI::Models::ContentSubmitResponse::Author?
 
+      attr_accessor casebook: ModerationAPI::Models::ContentSubmitResponse::Casebook?
+
       attr_accessor content: ModerationAPI::Models::ContentSubmitResponse::Content
 
       attr_accessor evaluation: ModerationAPI::Models::ContentSubmitResponse::Evaluation
@@ -35,6 +38,7 @@ module ModerationAPI
 
       def initialize: (
         author: ModerationAPI::Models::ContentSubmitResponse::Author?,
+        casebook: ModerationAPI::Models::ContentSubmitResponse::Casebook?,
         content: ModerationAPI::Models::ContentSubmitResponse::Content,
         evaluation: ModerationAPI::Models::ContentSubmitResponse::Evaluation,
         insights: ::Array[ModerationAPI::Models::ContentSubmitResponse::insight],
@@ -46,6 +50,7 @@ module ModerationAPI
 
       def to_hash: -> {
         author: ModerationAPI::Models::ContentSubmitResponse::Author?,
+        casebook: ModerationAPI::Models::ContentSubmitResponse::Casebook?,
         content: ModerationAPI::Models::ContentSubmitResponse::Content,
         evaluation: ModerationAPI::Models::ContentSubmitResponse::Evaluation,
         insights: ::Array[ModerationAPI::Models::ContentSubmitResponse::insight],
@@ -128,6 +133,71 @@ module ModerationAPI
         end
       end
 
+      type casebook =
+        {
+          agreement: Float,
+          case_count: Float,
+          confidence: Float,
+          similarity: Float,
+          topic: ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic?,
+          verdict: ModerationAPI::Models::ContentSubmitResponse::Casebook::verdict
+        }
+
+      class Casebook < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor agreement: Float
+
+        attr_accessor case_count: Float
+
+        attr_accessor confidence: Float
+
+        attr_accessor similarity: Float
+
+        attr_accessor topic: ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic?
+
+        attr_accessor verdict: ModerationAPI::Models::ContentSubmitResponse::Casebook::verdict
+
+        def initialize: (
+          agreement: Float,
+          case_count: Float,
+          confidence: Float,
+          similarity: Float,
+          topic: ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic?,
+          verdict: ModerationAPI::Models::ContentSubmitResponse::Casebook::verdict
+        ) -> void
+
+        def to_hash: -> {
+          agreement: Float,
+          case_count: Float,
+          confidence: Float,
+          similarity: Float,
+          topic: ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic?,
+          verdict: ModerationAPI::Models::ContentSubmitResponse::Casebook::verdict
+        }
+
+        type topic = { id: String, label: String }
+
+        class Topic < ModerationAPI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor label: String
+
+          def initialize: (id: String, label: String) -> void
+
+          def to_hash: -> { id: String, label: String }
+        end
+
+        type verdict = :allow | :reject
+
+        module Verdict
+          extend ModerationAPI::Internal::Type::Enum
+
+          ALLOW: :allow
+          REJECT: :reject
+
+          def self?.values: -> ::Array[ModerationAPI::Models::ContentSubmitResponse::Casebook::verdict]
+        end
+      end
+
       type content =
         {
           id: String,
@@ -758,6 +828,7 @@ module ModerationAPI
           | :rule_default
           | :rule_fallback
           | :client_override
+          | :casebook_match
           | String
 
         module ReasonCode
@@ -775,6 +846,7 @@ module ModerationAPI
           RULE_DEFAULT: :rule_default
           RULE_FALLBACK: :rule_fallback
           CLIENT_OVERRIDE: :client_override
+          CASEBOOK_MATCH: :casebook_match
         end
 
         type matched_rule = { key: String, name: String }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moderation_api
 version: !ruby/object:Gem::Version
-  version: 2.34.0
+  version: 2.35.0
 platform: ruby
 authors:
 - Moderation API
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-20 00:00:00.000000000 Z
+date: 2026-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi