Class: OpenAI::Models::Moderation::Categories

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/moderation.rb

Overview

See Also:

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#harassmentBoolean

Content that expresses, incites, or promotes harassing language towards any target.

Returns:



49
# File 'lib/openai/models/moderation.rb', line 49

required :harassment, OpenAI::Internal::Type::Boolean

#harassment_threateningBoolean

Harassment content that also includes violence or serious harm towards any target.

Returns:



56
# File 'lib/openai/models/moderation.rb', line 56

required :harassment_threatening, OpenAI::Internal::Type::Boolean, api_name: :"harassment/threatening"

#hateBoolean

Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Hateful content aimed at non-protected groups (e.g., chess players) is harassment.

Returns:



65
# File 'lib/openai/models/moderation.rb', line 65

required :hate, OpenAI::Internal::Type::Boolean

#hate_threateningBoolean

Hateful content that also includes violence or serious harm towards the targeted group based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste.

Returns:



73
# File 'lib/openai/models/moderation.rb', line 73

required :hate_threatening, OpenAI::Internal::Type::Boolean, api_name: :"hate/threatening"

#illicitBoolean?

Content that includes instructions or advice that facilitate the planning or execution of wrongdoing, or that gives advice or instruction on how to commit illicit acts. For example, “how to shoplift” would fit this category.

Returns:



81
# File 'lib/openai/models/moderation.rb', line 81

required :illicit, OpenAI::Internal::Type::Boolean, nil?: true

#illicit_violentBoolean?

Content that includes instructions or advice that facilitate the planning or execution of wrongdoing that also includes violence, or that gives advice or instruction on the procurement of any weapon.

Returns:



89
# File 'lib/openai/models/moderation.rb', line 89

required :illicit_violent, OpenAI::Internal::Type::Boolean, api_name: :"illicit/violent", nil?: true

#self_harmBoolean

Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders.

Returns:



96
# File 'lib/openai/models/moderation.rb', line 96

required :self_harm, OpenAI::Internal::Type::Boolean, api_name: :"self-harm"

#self_harm_instructionsBoolean

Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts.

Returns:



104
# File 'lib/openai/models/moderation.rb', line 104

required :self_harm_instructions, OpenAI::Internal::Type::Boolean, api_name: :"self-harm/instructions"

#self_harm_intentBoolean

Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders.

Returns:



111
# File 'lib/openai/models/moderation.rb', line 111

required :self_harm_intent, OpenAI::Internal::Type::Boolean, api_name: :"self-harm/intent"

#sexualBoolean

Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness).

Returns:



119
# File 'lib/openai/models/moderation.rb', line 119

required :sexual, OpenAI::Internal::Type::Boolean

#sexual_minorsBoolean

Sexual content that includes an individual who is under 18 years old.

Returns:



125
# File 'lib/openai/models/moderation.rb', line 125

required :sexual_minors, OpenAI::Internal::Type::Boolean, api_name: :"sexual/minors"

#violenceBoolean

Content that depicts death, violence, or physical injury.

Returns:



131
# File 'lib/openai/models/moderation.rb', line 131

required :violence, OpenAI::Internal::Type::Boolean

#violence_graphicBoolean

Content that depicts death, violence, or physical injury in graphic detail.

Returns:



137
# File 'lib/openai/models/moderation.rb', line 137

required :violence_graphic, OpenAI::Internal::Type::Boolean, api_name: :"violence/graphic"