Class: ModerationAPI::Models::ContentSubmitResponse::Recommendation

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

Overview

See Also:

Defined Under Namespace

Modules: Action, ReasonCode

Instance Attribute Summary collapse

Class Method 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(action:, reason_codes:) ⇒ Object

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

The recommendation for the content based on the evaluation.

Parameters:




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

Instance Attribute Details

#action ⇒ Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::Action

The action to take based on the recommendation

Returns:



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

required :action, enum: -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation::Action }

#reason_codes ⇒ Array<Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode>

The reason code for the recommendation. Can be used to display a reason to the user.

Returns:



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

required :reason_codes,
-> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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