Class: OpenAI::Models::Responses::Response::Moderation::Output::ModerationResult

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response.rb,
sig/openai/models/responses/response.rbs

Defined Under Namespace

Modules: CategoryAppliedInputType

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, #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 



418
 
# File 'sig/openai/models/responses/response.rbs', line 418

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:




# File 'lib/openai/models/responses/response.rb', line 732

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

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

Parameters:

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

Returns:



738
739
740
741
742
743
744
745
746
747
 
# File 'lib/openai/models/responses/response.rb', line 738

required(
  :category_applied_input_types,
  -> do
    OpenAI::Internal::Type::HashOf[
      OpenAI::Internal::Type::ArrayOf[
        enum: OpenAI::Responses::Response::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/responses/response.rb', line 753

#flagged ⇒ Boolean

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

Parameters:

Returns:



759
 
# File 'lib/openai/models/responses/response.rb', line 759

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

#model ⇒ String

The moderation model that produced this result.

Parameters:

  • value (String)

Returns:

  • (String) 


765
 
# File 'lib/openai/models/responses/response.rb', line 765

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) 


772
 
# File 'lib/openai/models/responses/response.rb', line 772

required :type, const: :moderation_result

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


427
 
# File 'sig/openai/models/responses/response.rbs', line 427

def to_hash: -> {