Class: ModerationAPI::Models::ContentSubmitResponse

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

Overview

See Also:

Defined Under Namespace

Modules: Insight, Policy Classes: Author, Content, Error, Evaluation, Meta, Recommendation

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(probability:, value:, id: :language, type: :insight) ⇒ Object

Language insight

Parameters:

  • probability (Float)
  • value (String, nil)
  • id (Symbol, :language) (defaults to: :language)
  • type (Symbol, :insight) (defaults to: :insight) 



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

Instance Attribute Details

#author ⇒ ModerationAPI::Models::ContentSubmitResponse::Author?

The author of the content if your account has authors enabled. Requires you to send authorId when submitting content.

Returns:



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

required :author, -> { ModerationAPI::Models::ContentSubmitResponse::Author }, nil?: true

#content ⇒ ModerationAPI::Models::ContentSubmitResponse::Content

Potentially modified content.

Returns:



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

required :content, -> { ModerationAPI::Models::ContentSubmitResponse::Content }

#errors ⇒ Array<ModerationAPI::Models::ContentSubmitResponse::Error>?

Policies that had errors

Returns:



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

optional :errors,
-> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ContentSubmitResponse::Error] }

#evaluation ⇒ ModerationAPI::Models::ContentSubmitResponse::Evaluation

The evaluation of the content after running the channel policies.

Returns:



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

required :evaluation, -> { ModerationAPI::Models::ContentSubmitResponse::Evaluation }

#insights ⇒ Array<ModerationAPI::Models::ContentSubmitResponse::Insight::SentimentInsight, ModerationAPI::Models::ContentSubmitResponse::Insight::LanguageInsight>

Results of all insights enabled in the channel.

Returns:



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

required :insights,
-> { ModerationAPI::Internal::Type::ArrayOf[union: ModerationAPI::Models::ContentSubmitResponse::Insight] }

#meta ⇒ ModerationAPI::Models::ContentSubmitResponse::Meta

Metadata about the moderation request

Returns:



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

required :meta, -> { ModerationAPI::Models::ContentSubmitResponse::Meta }

#policies ⇒ Array<ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput, ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput>

Results of all policies in the channel. Sorted by highest probability.

Returns:



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

required :policies,
-> { ModerationAPI::Internal::Type::ArrayOf[union: ModerationAPI::Models::ContentSubmitResponse::Policy] }

#recommendation ⇒ ModerationAPI::Models::ContentSubmitResponse::Recommendation

The recommendation for the content based on the evaluation.

Returns:



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

required :recommendation, -> { ModerationAPI::Models::ContentSubmitResponse::Recommendation }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

.variants ⇒ Array(ModerationAPI::Models::ContentSubmitResponse::Policy::ClassifierOutput, ModerationAPI::Models::ContentSubmitResponse::Policy::EntityMatcherOutput)

Returns:




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