Class: OpenAI::Models::ModerationCreateResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::ModerationCreateResponse

Defined in:

lib/openai/models/moderation_create_response.rb

Overview

See Also:

• Resources::Moderations#create

Instance Attribute Summary

• #id ⇒ String

  The unique identifier for the moderation request.

• #model ⇒ String

  The model used to generate the moderation results.

• #results ⇒ Array<OpenAI::Models::Moderation>

  A list of moderation objects.

Instance Method Summary

• #initialize(id: , model: , results: ) ⇒ Object constructor

  Represents if a given text input is potentially harmful.

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, 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(id: , model: , results: ) ⇒ Object

Represents if a given text input is potentially harmful.

Parameters:

• id (String) (defaults to: ) —

  The unique identifier for the moderation request.

• model (String) (defaults to: ) —

  The model used to generate the moderation results.

• results (Array<OpenAI::Models::Moderation>) (defaults to: ) —

  A list of moderation objects.

# File 'lib/openai/models/moderation_create_response.rb', line 25

Instance Attribute Details

#id ⇒ String

The unique identifier for the moderation request.

Returns:

• (String)

# File 'lib/openai/models/moderation_create_response.rb', line 11

required :id, String

#model ⇒ String

The model used to generate the moderation results.

Returns:

• (String)

# File 'lib/openai/models/moderation_create_response.rb', line 17

required :model, String

#results ⇒ Array<OpenAI::Models::Moderation>

A list of moderation objects.

Returns:

• (Array<OpenAI::Models::Moderation>)

# File 'lib/openai/models/moderation_create_response.rb', line 23

required :results, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Moderation] }