Class: OpenAI::Models::Video

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

Overview

See Also:

Defined Under Namespace

Modules: Status

Instance Attribute 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(id:, completed_at:, created_at:, error:, expires_at:, model:, progress:, prompt:, remixed_from_video_id:, seconds:, size:, status:, object: :video) ⇒ Object

Structured information describing a generated video job.

Parameters:

  • id (String) —

    Unique identifier for the video job.

  • completed_at (Integer, nil) —

    Unix timestamp (seconds) for when the job completed, if finished.

  • created_at (Integer) —

    Unix timestamp (seconds) for when the job was created.

  • error (OpenAI::Models::VideoCreateError, nil) —

    Error payload that explains why generation failed, if applicable.

  • expires_at (Integer, nil) —

    Unix timestamp (seconds) for when the downloadable assets expire, if set.

  • model (Symbol, OpenAI::Models::VideoModel) —

    The video generation model that produced the job.

  • progress (Integer) —

    Approximate completion percentage for the generation task.

  • prompt (String, nil) —

    The prompt that was used to generate the video.

  • remixed_from_video_id (String, nil) —

    Identifier of the source video if this video is a remix.

  • seconds (Symbol, OpenAI::Models::VideoSeconds) —

    Duration of the generated clip in seconds.

  • size (Symbol, OpenAI::Models::VideoSize) —

    The resolution of the generated video.

  • status (Symbol, OpenAI::Models::Video::Status) —

    Current lifecycle status of the video job.

  • object (Symbol, :video) (defaults to: :video) —

    The object type, which is always ‘video`.




# File 'lib/openai/models/video.rb', line 85

Instance Attribute Details

#completed_at ⇒ Integer?

Unix timestamp (seconds) for when the job completed, if finished.

Returns:

  • (Integer, nil) 


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

required :completed_at, Integer, nil?: true

#created_at ⇒ Integer

Unix timestamp (seconds) for when the job was created.

Returns:

  • (Integer) 


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

required :created_at, Integer

#error ⇒ OpenAI::Models::VideoCreateError?

Error payload that explains why generation failed, if applicable.

Returns:



29
 
# File 'lib/openai/models/video.rb', line 29

required :error, -> { OpenAI::VideoCreateError }, nil?: true

#expires_at ⇒ Integer?

Unix timestamp (seconds) for when the downloadable assets expire, if set.

Returns:

  • (Integer, nil) 


35
 
# File 'lib/openai/models/video.rb', line 35

required :expires_at, Integer, nil?: true

#id ⇒ String

Unique identifier for the video job.

Returns:

  • (String) 


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

required :id, String

#model ⇒ Symbol, OpenAI::Models::VideoModel

The video generation model that produced the job.

Returns:



41
 
# File 'lib/openai/models/video.rb', line 41

required :model, enum: -> { OpenAI::VideoModel }

#object ⇒ Symbol, :video

The object type, which is always ‘video`.

Returns:

  • (Symbol, :video) 


47
 
# File 'lib/openai/models/video.rb', line 47

required :object, const: :video

#progress ⇒ Integer

Approximate completion percentage for the generation task.

Returns:

  • (Integer) 


53
 
# File 'lib/openai/models/video.rb', line 53

required :progress, Integer

#prompt ⇒ String?

The prompt that was used to generate the video.

Returns:

  • (String, nil) 


59
 
# File 'lib/openai/models/video.rb', line 59

required :prompt, String, nil?: true

#remixed_from_video_id ⇒ String?

Identifier of the source video if this video is a remix.

Returns:

  • (String, nil) 


65
 
# File 'lib/openai/models/video.rb', line 65

required :remixed_from_video_id, String, nil?: true

#seconds ⇒ Symbol, OpenAI::Models::VideoSeconds

Duration of the generated clip in seconds.

Returns:



71
 
# File 'lib/openai/models/video.rb', line 71

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

#size ⇒ Symbol, OpenAI::Models::VideoSize

The resolution of the generated video.

Returns:



77
 
# File 'lib/openai/models/video.rb', line 77

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

#status ⇒ Symbol, OpenAI::Models::Video::Status

Current lifecycle status of the video job.

Returns:



83
 
# File 'lib/openai/models/video.rb', line 83

required :status, enum: -> { OpenAI::Video::Status }