Class: OpenAI::Models::Beta::BetaResponse::Moderation::Output::ModerationResult

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::BetaResponse::Moderation::Output::ModerationResult

Defined in:

lib/openai/models/beta/beta_response.rb,
sig/openai/models/beta/beta_response.rbs

Defined Under Namespace

Modules: CategoryAppliedInputType

Instance Attribute Summary

• #categories ⇒ Hash{Symbol=>Boolean}

  A dictionary of moderation categories to booleans, True if the input is flagged under this category.

• #category_applied_input_types ⇒ Hash{Symbol=>Array<Symbol, OpenAI::Models::Beta::BetaResponse::Moderation::Output::ModerationResult::CategoryAppliedInputType>}

  Which modalities of input are reflected by the score for each category.

• #category_scores ⇒ Hash{Symbol=>Float}

  A dictionary of moderation categories to scores.

• #flagged ⇒ Boolean

  A boolean indicating whether the content was flagged by any category.

• #model ⇒ String

  The moderation model that produced this result.

• #type ⇒ Symbol, :moderation_result

  The object type, which was always moderation_result for successful moderation results.

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/openai/models/beta/beta_response.rbs', line 622

def initialize: (

Instance Attribute Details

#categories ⇒ Hash{Symbol=>Boolean}

A dictionary of moderation categories to booleans, True if the input is flagged under this category.

Parameters:

• value (::Hash[Symbol, bool])

Returns:

• (Hash{Symbol=>Boolean})

# File 'lib/openai/models/beta/beta_response.rb', line 1009

required :categories, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Boolean]

#category_applied_input_types ⇒ Hash{Symbol=>Array<Symbol, OpenAI::Models::Beta::BetaResponse::Moderation::Output::ModerationResult::CategoryAppliedInputType>}

Which modalities of input are reflected by the score for each category.

Parameters:

• value (::Hash[Symbol, ::Array[OpenAI::Models::Beta::BetaResponse::Moderation::Output::ModerationResult::category_applied_input_type]])

Returns:

• (Hash{Symbol=>Array<Symbol, OpenAI::Models::Beta::BetaResponse::Moderation::Output::ModerationResult::CategoryAppliedInputType>})

# File 'lib/openai/models/beta/beta_response.rb', line 1015

required :category_applied_input_types,
-> do
  OpenAI::Internal::Type::HashOf[
    OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::BetaResponse::Moderation::Output::ModerationResult::CategoryAppliedInputType]
  ]
end

#category_scores ⇒ Hash{Symbol=>Float}

A dictionary of moderation categories to scores.

Parameters:

• value (::Hash[Symbol, Float])

Returns:

• (Hash{Symbol=>Float})

# File 'lib/openai/models/beta/beta_response.rb', line 1026

required :category_scores, OpenAI::Internal::Type::HashOf[Float]

#flagged ⇒ Boolean

A boolean indicating whether the content was flagged by any category.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/openai/models/beta/beta_response.rb', line 1032

required :flagged, OpenAI::Internal::Type::Boolean

#model ⇒ String

The moderation model that produced this result.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/beta/beta_response.rb', line 1038

required :model, String

#type ⇒ Symbol, :moderation_result

The object type, which was always moderation_result for successful moderation results.

Parameters:

• value (:moderation_result)

Returns:

• (Symbol, :moderation_result)

# File 'lib/openai/models/beta/beta_response.rb', line 1045

required :type, const: :moderation_result

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/beta_response.rbs', line 631

def to_hash: -> {