Class: ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput::Label

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

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(id:, flagged:, probability:, data: nil, flagged_fields: nil, labels: nil, type: :classifier) ⇒ Object

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

Classifier policy.

Parameters:

  • id (String) —

    The unique identifier for the classifier output.

  • flagged (Boolean)
  • probability (Float)
  • data (Hash{Symbol=>Object}) (defaults to: nil) —

    Optional structured data produced by the policy. For face detection: { count, fa

  • flagged_fields (Array<String>) (defaults to: nil) —

    The keys of the flagged fields if submitting an object.

  • labels (Array<ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput::Label>) (defaults to: nil)
  • type (Symbol, :classifier) (defaults to: :classifier) 


639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/moderation_api/models/content_submit_response.rb', line 639

class Label < ModerationAPI::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute flagged
  #
  #   @return [Boolean]
  required :flagged, ModerationAPI::Internal::Type::Boolean

  # @!attribute probability
  #
  #   @return [Float]
  required :probability, Float

  # @!attribute shadow_flagged
  #
  #   @return [Boolean, nil]
  optional :shadow_flagged, ModerationAPI::Internal::Type::Boolean, api_name: :shadowFlagged

  # @!method initialize(id:, flagged:, probability:, shadow_flagged: nil)
  #   @param id [String]
  #   @param flagged [Boolean]
  #   @param probability [Float]
  #   @param shadow_flagged [Boolean]
end

Instance Attribute Details

#flagged ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


648
 
# File 'lib/moderation_api/models/content_submit_response.rb', line 648

required :flagged, ModerationAPI::Internal::Type::Boolean

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


643
 
# File 'lib/moderation_api/models/content_submit_response.rb', line 643

required :id, String

#probability ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


653
 
# File 'lib/moderation_api/models/content_submit_response.rb', line 653

required :probability, Float

#shadow_flagged ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


658
 
# File 'lib/moderation_api/models/content_submit_response.rb', line 658

optional :shadow_flagged, ModerationAPI::Internal::Type::Boolean, api_name: :shadowFlagged

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


512
 
# File 'sig/moderation_api/models/content_submit_response.rbs', line 512

def to_hash: -> {