Class: ModerationAPI::Models::ContentSubmitParams::Policy::FaceDetection

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moderation_api/models/content_submit_params.rb,
sig/moderation_api/models/content_submit_params.rbs

Defined Under Namespace

Modules: Comparator

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(flag:, comparator: nil, count: nil, threshold: nil, id: :face_detection) ⇒ Object

Some parameter documentations has been truncated, see ModerationAPI::Models::ContentSubmitParams::Policy::FaceDetection for more details.

Parameters:

  • flag (Boolean)
  • comparator (Symbol, ModerationAPI::Models::ContentSubmitParams::Policy::FaceDetection::Comparator) (defaults to: nil) —

    Flag images that contain "at least" or "fewer than" the configured number of fac

  • count (Integer) (defaults to: nil) —

    Number of faces the comparator applies to. Defaults to 1, so the default rule fl

  • threshold (Float) (defaults to: nil)
  • id (Symbol, :face_detection) (defaults to: :face_detection) 



# File 'lib/moderation_api/models/content_submit_params.rb', line 1023

Instance Attribute Details

#comparator ⇒ Symbol, ...

Flag images that contain "at least" or "fewer than" the configured number of faces. Defaults to at_least.

Returns:



1009
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 1009

optional :comparator, enum: -> { ModerationAPI::ContentSubmitParams::Policy::FaceDetection::Comparator }

#count ⇒ Integer?

Number of faces the comparator applies to. Defaults to 1, so the default rule flags any image containing a face.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


1016
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 1016

optional :count, Integer

#flag ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


1002
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 1002

required :flag, ModerationAPI::Internal::Type::Boolean

#id ⇒ Symbol, :face_detection

Parameters:

  • value (:face_detection)

Returns:

  • (Symbol, :face_detection) 


997
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 997

required :id, const: :face_detection

#threshold ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


1021
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 1021

optional :threshold, Float

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


849
 
# File 'sig/moderation_api/models/content_submit_params.rbs', line 849

def to_hash: -> {