moderation_api 2.19.0 → 2.21.0

data/rbi/moderation_api/models/content_submit_params.rbi

@@ -43,6 +43,22 @@ module ModerationAPI
       sig { params(channel: String).void }
       attr_writer :channel
 
+      # A recommendation from your own client-side flagging (e.g. a banned-IP list or a
+      # third-party tool). Feeds the rules engine and can escalate or override the
+      # recommended action. Does not change whether our analysis flagged the content.
+      sig do
+        returns(T.nilable(ModerationAPI::ContentSubmitParams::ClientAction))
+      end
+      attr_reader :client_action
+
+      sig do
+        params(
+          client_action:
+            ModerationAPI::ContentSubmitParams::ClientAction::OrHash
+        ).void
+      end
+      attr_writer :client_action
+
       # The unique ID of the content in your database.
       sig { returns(T.nilable(String)) }
       attr_reader :content_id
@@ -112,6 +128,7 @@ module ModerationAPI
                 ModerationAPI::ContentSubmitParams::Policy::SelfHarm,
                 ModerationAPI::ContentSubmitParams::Policy::Spam,
                 ModerationAPI::ContentSubmitParams::Policy::LowQualityContent,
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection,
                 ModerationAPI::ContentSubmitParams::Policy::SelfPromotion,
                 ModerationAPI::ContentSubmitParams::Policy::Political,
                 ModerationAPI::ContentSubmitParams::Policy::Religion,
@@ -152,6 +169,7 @@ module ModerationAPI
                 ModerationAPI::ContentSubmitParams::Policy::SelfHarm::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Spam::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::LowQualityContent::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::SelfPromotion::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Political::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Religion::OrHash,
@@ -186,6 +204,8 @@ module ModerationAPI
             ),
           author_id: String,
           channel: String,
+          client_action:
+            ModerationAPI::ContentSubmitParams::ClientAction::OrHash,
           content_id: String,
           conversation_id: String,
           do_not_store: T::Boolean,
@@ -214,6 +234,7 @@ module ModerationAPI
                 ModerationAPI::ContentSubmitParams::Policy::SelfHarm::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Spam::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::LowQualityContent::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::SelfPromotion::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Political::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Religion::OrHash,
@@ -236,6 +257,10 @@ module ModerationAPI
         # Provide a channel ID or key. Will use the project's default channel if not
         # provided.
         channel: nil,
+        # A recommendation from your own client-side flagging (e.g. a banned-IP list or a
+        # third-party tool). Feeds the rules engine and can escalate or override the
+        # recommended action. Does not change whether our analysis flagged the content.
+        client_action: nil,
         # The unique ID of the content in your database.
         content_id: nil,
         # For example the ID of a chat room or a post
@@ -268,6 +293,7 @@ module ModerationAPI
               ),
             author_id: String,
             channel: String,
+            client_action: ModerationAPI::ContentSubmitParams::ClientAction,
             content_id: String,
             conversation_id: String,
             do_not_store: T::Boolean,
@@ -296,6 +322,7 @@ module ModerationAPI
                   ModerationAPI::ContentSubmitParams::Policy::SelfHarm,
                   ModerationAPI::ContentSubmitParams::Policy::Spam,
                   ModerationAPI::ContentSubmitParams::Policy::LowQualityContent,
+                  ModerationAPI::ContentSubmitParams::Policy::FaceDetection,
                   ModerationAPI::ContentSubmitParams::Policy::SelfPromotion,
                   ModerationAPI::ContentSubmitParams::Policy::Political,
                   ModerationAPI::ContentSubmitParams::Policy::Religion,
@@ -719,6 +746,174 @@ module ModerationAPI
         end
       end
 
+      class ClientAction < ModerationAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::ContentSubmitParams::ClientAction,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # Your recommendation for the content: allow, review, or reject.
+        sig do
+          returns(
+            ModerationAPI::ContentSubmitParams::ClientAction::Action::OrSymbol
+          )
+        end
+        attr_accessor :action
+
+        # How your recommendation combines with ours. Defaults to 'escalate', which only
+        # applies it when stricter than ours; 'override' replaces ours outright.
+        sig do
+          returns(
+            T.nilable(
+              ModerationAPI::ContentSubmitParams::ClientAction::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ModerationAPI::ContentSubmitParams::ClientAction::Behavior::OrSymbol
+          ).void
+        end
+        attr_writer :behavior
+
+        # A human-readable explanation for your recommendation.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reason
+
+        sig { params(reason: String).void }
+        attr_writer :reason
+
+        # Where your recommendation came from, e.g. "banned-ip".
+        sig { returns(T.nilable(String)) }
+        attr_reader :source
+
+        sig { params(source: String).void }
+        attr_writer :source
+
+        # A recommendation from your own client-side flagging (e.g. a banned-IP list or a
+        # third-party tool). Feeds the rules engine and can escalate or override the
+        # recommended action. Does not change whether our analysis flagged the content.
+        sig do
+          params(
+            action:
+              ModerationAPI::ContentSubmitParams::ClientAction::Action::OrSymbol,
+            behavior:
+              ModerationAPI::ContentSubmitParams::ClientAction::Behavior::OrSymbol,
+            reason: String,
+            source: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Your recommendation for the content: allow, review, or reject.
+          action:,
+          # How your recommendation combines with ours. Defaults to 'escalate', which only
+          # applies it when stricter than ours; 'override' replaces ours outright.
+          behavior: nil,
+          # A human-readable explanation for your recommendation.
+          reason: nil,
+          # Where your recommendation came from, e.g. "banned-ip".
+          source: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              action:
+                ModerationAPI::ContentSubmitParams::ClientAction::Action::OrSymbol,
+              behavior:
+                ModerationAPI::ContentSubmitParams::ClientAction::Behavior::OrSymbol,
+              reason: String,
+              source: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Your recommendation for the content: allow, review, or reject.
+        module Action
+          extend ModerationAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModerationAPI::ContentSubmitParams::ClientAction::Action
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REVIEW =
+            T.let(
+              :review,
+              ModerationAPI::ContentSubmitParams::ClientAction::Action::TaggedSymbol
+            )
+          ALLOW =
+            T.let(
+              :allow,
+              ModerationAPI::ContentSubmitParams::ClientAction::Action::TaggedSymbol
+            )
+          REJECT =
+            T.let(
+              :reject,
+              ModerationAPI::ContentSubmitParams::ClientAction::Action::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModerationAPI::ContentSubmitParams::ClientAction::Action::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # How your recommendation combines with ours. Defaults to 'escalate', which only
+        # applies it when stricter than ours; 'override' replaces ours outright.
+        module Behavior
+          extend ModerationAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModerationAPI::ContentSubmitParams::ClientAction::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          OVERRIDE =
+            T.let(
+              :override,
+              ModerationAPI::ContentSubmitParams::ClientAction::Behavior::TaggedSymbol
+            )
+          ESCALATE =
+            T.let(
+              :escalate,
+              ModerationAPI::ContentSubmitParams::ClientAction::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModerationAPI::ContentSubmitParams::ClientAction::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # The meta type of content being moderated
       module MetaType
         extend ModerationAPI::Internal::Type::Enum
@@ -805,6 +1000,7 @@ module ModerationAPI
               ModerationAPI::ContentSubmitParams::Policy::SelfHarm,
               ModerationAPI::ContentSubmitParams::Policy::Spam,
               ModerationAPI::ContentSubmitParams::Policy::LowQualityContent,
+              ModerationAPI::ContentSubmitParams::Policy::FaceDetection,
               ModerationAPI::ContentSubmitParams::Policy::SelfPromotion,
               ModerationAPI::ContentSubmitParams::Policy::Political,
               ModerationAPI::ContentSubmitParams::Policy::Religion,
@@ -1561,6 +1757,129 @@ module ModerationAPI
           end
         end
 
+        class FaceDetection < ModerationAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection,
+                ModerationAPI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Symbol) }
+          attr_accessor :id
+
+          sig { returns(T::Boolean) }
+          attr_accessor :flag
+
+          # Flag images that contain "at least" or "fewer than" the configured number of
+          # faces. Defaults to at_least.
+          sig do
+            returns(
+              T.nilable(
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator::OrSymbol
+              )
+            )
+          end
+          attr_reader :comparator
+
+          sig do
+            params(
+              comparator:
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator::OrSymbol
+            ).void
+          end
+          attr_writer :comparator
+
+          # Number of faces the comparator applies to. Defaults to 1, so the default rule
+          # flags any image containing a face.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :count
+
+          sig { params(count: Integer).void }
+          attr_writer :count
+
+          sig { returns(T.nilable(Float)) }
+          attr_reader :threshold
+
+          sig { params(threshold: Float).void }
+          attr_writer :threshold
+
+          sig do
+            params(
+              flag: T::Boolean,
+              comparator:
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator::OrSymbol,
+              count: Integer,
+              threshold: Float,
+              id: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            flag:,
+            # Flag images that contain "at least" or "fewer than" the configured number of
+            # faces. Defaults to at_least.
+            comparator: nil,
+            # Number of faces the comparator applies to. Defaults to 1, so the default rule
+            # flags any image containing a face.
+            count: nil,
+            threshold: nil,
+            id: :face_detection
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: Symbol,
+                flag: T::Boolean,
+                comparator:
+                  ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator::OrSymbol,
+                count: Integer,
+                threshold: Float
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Flag images that contain "at least" or "fewer than" the configured number of
+          # faces. Defaults to at_least.
+          module Comparator
+            extend ModerationAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AT_LEAST =
+              T.let(
+                :at_least,
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator::TaggedSymbol
+              )
+            FEWER_THAN =
+              T.let(
+                :fewer_than,
+                ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class SelfPromotion < ModerationAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/moderation_api/models/content_submit_response.rbi

@@ -1093,6 +1093,14 @@ module ModerationAPI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Optional structured data produced by the policy. For face detection: { count,
+          # faces: [{ confidence, gender, age }] }.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :data
+
+          sig { params(data: T::Hash[Symbol, T.anything]).void }
+          attr_writer :data
+
           # The keys of the flagged fields if submitting an object.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :flagged_fields
@@ -1127,6 +1135,7 @@ module ModerationAPI
               id: String,
               flagged: T::Boolean,
               probability: Float,
+              data: T::Hash[Symbol, T.anything],
               flagged_fields: T::Array[String],
               labels:
                 T::Array[
@@ -1140,6 +1149,9 @@ module ModerationAPI
             id:,
             flagged:,
             probability:,
+            # Optional structured data produced by the policy. For face detection: { count,
+            # faces: [{ confidence, gender, age }] }.
+            data: nil,
             # The keys of the flagged fields if submitting an object.
             flagged_fields: nil,
             labels: nil,
@@ -1154,6 +1166,7 @@ module ModerationAPI
                 flagged: T::Boolean,
                 probability: Float,
                 type: Symbol,
+                data: T::Hash[Symbol, T.anything],
                 flagged_fields: T::Array[String],
                 labels:
                   T::Array[
@@ -1763,6 +1776,11 @@ module ModerationAPI
               :rule_fallback,
               ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
             )
+          CLIENT_OVERRIDE =
+            T.let(
+              :client_override,
+              ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
+            )
 
           sig do
             override.returns(