Class: OpenAI::Models::ModerationCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/moderation_create_params.rb

Overview

See Also:

• Resources::Moderations#create

Defined Under Namespace

Modules: Input, Model

Instance Attribute Summary

• #input ⇒ String, ...

  Input (or inputs) to classify.

• #model ⇒ String, ...

  The content moderation model you would like to use.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(input: , model: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ModerationCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(input: , model: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::ModerationCreateParams for more details.

Parameters:

• input (String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>) (defaults to: ) —

  Input (or inputs) to classify. Can be a single string, an array of strings, or

• model (String, Symbol, OpenAI::Models::ModerationModel) (defaults to: nil) —

  The content moderation model you would like to use. Learn more in

• request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/openai/models/moderation_create_params.rb', line 26

Instance Attribute Details

#input ⇒ String, ...

Input (or inputs) to classify. Can be a single string, an array of strings, or an array of multi-modal input objects similar to other models.

Returns:

• (String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>)

# File 'lib/openai/models/moderation_create_params.rb', line 15

required :input, union: -> { OpenAI::ModerationCreateParams::Input }

#model ⇒ String, ...

The content moderation model you would like to use. Learn more in [the moderation guide](platform.openai.com/docs/guides/moderation), and learn about available models [here](platform.openai.com/docs/models#moderation).

Returns:

• (String, Symbol, OpenAI::Models::ModerationModel, nil)

# File 'lib/openai/models/moderation_create_params.rb', line 24

optional :model, union: -> { OpenAI::ModerationCreateParams::Model }