Class: OpenAI::Models::Chat::ChatCompletion::Moderation

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

Overview

See Also:

Defined Under Namespace

Modules: Input, Output

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(code:, message:, type: :error) ⇒ Object

An error produced while attempting moderation.

Parameters:

  • code (String) —

    The error code.

  • message (String) —

    The error message.

  • type (Symbol, :error) (defaults to: :error) —

    The object type, which is always ‘error`.




# File 'lib/openai/models/chat/chat_completion.rb', line 217

Instance Attribute Details

#input ⇒ OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::Error

Moderation for the request input.

Returns:



209
 
# File 'lib/openai/models/chat/chat_completion.rb', line 209

required :input, union: -> { OpenAI::Chat::ChatCompletion::Moderation::Input }

#output ⇒ OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::Error

Moderation for the generated output.

Returns:



215
 
# File 'lib/openai/models/chat/chat_completion.rb', line 215

required :output, union: -> { OpenAI::Chat::ChatCompletion::Moderation::Output }