Class: OpenAI::Models::VideoCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/video_create_params.rb,
sig/openai/models/video_create_params.rbs

Overview

See Also:

  • OpenAI::Resources::Videos#create

Defined Under Namespace

Modules: InputReference

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

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

dump_request

Methods included from Internal::Type::RequestParameters

included

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(prompt:, input_reference: nil, model: nil, seconds: nil, size: nil, request_options: {}) ⇒ Object

Parameters:

  • prompt —

    Text prompt that describes the video to generate.

  • input_reference (defaults to: nil) —

    Optional reference asset upload or reference object that guides generation.

    String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

  • model (defaults to: nil) —

    The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to sora-2.

  • seconds (defaults to: nil) —

    Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.

  • size (defaults to: nil) —

    Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.




# File 'lib/openai/models/video_create_params.rb', line 46

Instance Attribute Details

#input_reference ⇒ OpenAI::Models::VideoCreateParams::input_reference?

Optional reference asset upload or reference object that guides generation.

String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

Returns:

  • (OpenAI::Models::VideoCreateParams::input_reference, nil) 


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

optional :input_reference, union: -> { OpenAI::VideoCreateParams::InputReference }

#model ⇒ OpenAI::Models::video_model?

The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to sora-2.

Returns:

  • (OpenAI::Models::video_model, nil) 


31
 
# File 'lib/openai/models/video_create_params.rb', line 31

optional :model, union: -> { OpenAI::VideoModel }

#prompt ⇒ String

Text prompt that describes the video to generate.

Returns:

  • (String) 


14
 
# File 'lib/openai/models/video_create_params.rb', line 14

required :prompt, String

#seconds ⇒ OpenAI::Models::video_seconds?

Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.

Returns:

  • (OpenAI::Models::video_seconds, nil) 


37
 
# File 'lib/openai/models/video_create_params.rb', line 37

optional :seconds, enum: -> { OpenAI::VideoSeconds }

#size ⇒ OpenAI::Models::video_size?

Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.

Returns:

  • (OpenAI::Models::video_size, nil) 


44
 
# File 'lib/openai/models/video_create_params.rb', line 44

optional :size, enum: -> { OpenAI::VideoSize }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


85
 
# File 'sig/openai/models/video_create_params.rbs', line 85

def to_hash: -> {