openai 0.92.0 → 0.93.0

data/sig/openai/models/vector_stores/vector_store_file.rbs

@@ -17,28 +17,78 @@ module OpenAI
         }
 
       class VectorStoreFile < OpenAI::Internal::Type::BaseModel
+        # The identifier, which can be referenced in API endpoints.
         attr_accessor id: String
 
+        # The Unix timestamp (in seconds) for when the vector store file was created.
         attr_accessor created_at: Integer
 
+        # The last error associated with this vector store file. Will be `null` if there
+        # are no errors.
         attr_accessor last_error: OpenAI::VectorStores::VectorStoreFile::LastError?
 
+        # The object type, which is always `vector_store.file`.
         attr_accessor object: :"vector_store.file"
 
+        # The status of the vector store file, which can be either `in_progress`,
+        # `completed`, `cancelled`, or `failed`. The status `completed` indicates that the
+        # vector store file is ready for use.
         attr_accessor status: OpenAI::Models::VectorStores::VectorStoreFile::status
 
+        # The total vector store usage in bytes. Note that this may be different from the
+        # original file size.
         attr_accessor usage_bytes: Integer
 
+        # The ID of the
+        # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+        # that the [File](https://developers.openai.com/api/reference/resources/files) is
+        # attached to.
         attr_accessor vector_store_id: String
 
+        # Set of 16 key-value pairs that can be attached to an object. This can be useful
+        # for storing additional information about the object in a structured format, and
+        # querying for objects via API or the dashboard. Keys are strings with a maximum
+        # length of 64 characters. Values are strings with a maximum length of 512
+        # characters, booleans, or numbers.
         attr_accessor attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::VectorStoreFile::attribute]?
 
+        # The strategy used to chunk the file.
         attr_reader chunking_strategy: OpenAI::Models::file_chunking_strategy?
 
+        # The strategy used to chunk the file.
         def chunking_strategy=: (
           OpenAI::Models::file_chunking_strategy
         ) -> OpenAI::Models::file_chunking_strategy
 
+        # @param id
+        #   The identifier, which can be referenced in API endpoints.
+        # @param created_at
+        #   The Unix timestamp (in seconds) for when the vector store file was created.
+        # @param last_error
+        #   The last error associated with this vector store file. Will be `null` if there
+        #   are no errors.
+        # @param status
+        #   The status of the vector store file, which can be either `in_progress`,
+        #   `completed`, `cancelled`, or `failed`. The status `completed` indicates that the
+        #   vector store file is ready for use.
+        # @param usage_bytes
+        #   The total vector store usage in bytes. Note that this may be different from the
+        #   original file size.
+        # @param vector_store_id
+        #   The ID of the
+        #   [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+        #   that the [File](https://developers.openai.com/api/reference/resources/files) is
+        #   attached to.
+        # @param attributes
+        #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #   for storing additional information about the object in a structured format, and
+        #   querying for objects via API or the dashboard. Keys are strings with a maximum
+        #   length of 64 characters. Values are strings with a maximum length of 512
+        #   characters, booleans, or numbers.
+        # @param chunking_strategy
+        #   The strategy used to chunk the file.
+        # @param object
+        #   The object type, which is always `vector_store.file`.
         def initialize: (
           id: String,
           created_at: Integer,
@@ -70,10 +120,16 @@ module OpenAI
           }
 
         class LastError < OpenAI::Internal::Type::BaseModel
+          # One of `server_error`, `unsupported_file`, or `invalid_file`.
           attr_accessor code: OpenAI::Models::VectorStores::VectorStoreFile::LastError::code
 
+          # A human-readable description of the error.
           attr_accessor message: String
 
+          # @param code
+          #   One of `server_error`, `unsupported_file`, or `invalid_file`.
+          # @param message
+          #   A human-readable description of the error.
           def initialize: (
             code: OpenAI::Models::VectorStores::VectorStoreFile::LastError::code,
             message: String

data/sig/openai/models/vector_stores/vector_store_file_batch.rbs

@@ -14,18 +14,43 @@ module OpenAI
         }
 
       class VectorStoreFileBatch < OpenAI::Internal::Type::BaseModel
+        # The identifier, which can be referenced in API endpoints.
         attr_accessor id: String
 
+        # The Unix timestamp (in seconds) for when the vector store files batch was
+        # created.
         attr_accessor created_at: Integer
 
         attr_accessor file_counts: OpenAI::VectorStores::VectorStoreFileBatch::FileCounts
 
+        # The object type, which is always `vector_store.file_batch`.
         attr_accessor object: :"vector_store.files_batch"
 
+        # The status of the vector store files batch, which can be either `in_progress`,
+        # `completed`, `cancelled` or `failed`.
         attr_accessor status: OpenAI::Models::VectorStores::VectorStoreFileBatch::status
 
+        # The ID of the
+        # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+        # that the [File](https://developers.openai.com/api/reference/resources/files) is
+        # attached to.
         attr_accessor vector_store_id: String
 
+        # @param id
+        #   The identifier, which can be referenced in API endpoints.
+        # @param created_at
+        #   The Unix timestamp (in seconds) for when the vector store files batch was
+        #   created.
+        # @param status
+        #   The status of the vector store files batch, which can be either `in_progress`,
+        #   `completed`, `cancelled` or `failed`.
+        # @param vector_store_id
+        #   The ID of the
+        #   [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+        #   that the [File](https://developers.openai.com/api/reference/resources/files) is
+        #   attached to.
+        # @param object
+        #   The object type, which is always `vector_store.file_batch`.
         def initialize: (
           id: String,
           created_at: Integer,
@@ -54,16 +79,31 @@ module OpenAI
           }
 
         class FileCounts < OpenAI::Internal::Type::BaseModel
+          # The number of files that where cancelled.
           attr_accessor cancelled: Integer
 
+          # The number of files that have been processed.
           attr_accessor completed: Integer
 
+          # The number of files that have failed to process.
           attr_accessor failed: Integer
 
+          # The number of files that are currently being processed.
           attr_accessor in_progress: Integer
 
+          # The total number of files.
           attr_accessor total: Integer
 
+          # @param cancelled
+          #   The number of files that where cancelled.
+          # @param completed
+          #   The number of files that have been processed.
+          # @param failed
+          #   The number of files that have failed to process.
+          # @param in_progress
+          #   The number of files that are currently being processed.
+          # @param total
+          #   The total number of files.
           def initialize: (
             cancelled: Integer,
             completed: Integer,

data/sig/openai/models/video.rbs

@@ -18,32 +18,73 @@ module OpenAI
       }
 
     class Video < OpenAI::Internal::Type::BaseModel
+      # Unique identifier for the video job.
       attr_accessor id: String
 
+      # Unix timestamp (seconds) for when the job completed, if finished.
       attr_accessor completed_at: Integer?
 
+      # Unix timestamp (seconds) for when the job was created.
       attr_accessor created_at: Integer
 
+      # Error payload that explains why generation failed, if applicable.
       attr_accessor error: OpenAI::VideoCreateError?
 
+      # Unix timestamp (seconds) for when the downloadable assets expire, if set.
       attr_accessor expires_at: Integer?
 
+      # The video generation model that produced the job.
       attr_accessor model: OpenAI::Models::video_model
 
+      # The object type, which is always `video`.
       attr_accessor object: :video
 
+      # Approximate completion percentage for the generation task.
       attr_accessor progress: Integer
 
+      # The prompt that was used to generate the video.
       attr_accessor prompt: String?
 
+      # Identifier of the source video if this video is a remix.
       attr_accessor remixed_from_video_id: String?
 
+      # Duration of the generated clip in seconds. For extensions, this is the stitched
+      # total duration.
       attr_accessor seconds: OpenAI::Models::Video::seconds
 
+      # The resolution of the generated video.
       attr_accessor size: OpenAI::Models::video_size
 
+      # Current lifecycle status of the video job.
       attr_accessor status: OpenAI::Models::Video::status
 
+      # @param id
+      #   Unique identifier for the video job.
+      # @param completed_at
+      #   Unix timestamp (seconds) for when the job completed, if finished.
+      # @param created_at
+      #   Unix timestamp (seconds) for when the job was created.
+      # @param error
+      #   Error payload that explains why generation failed, if applicable.
+      # @param expires_at
+      #   Unix timestamp (seconds) for when the downloadable assets expire, if set.
+      # @param model
+      #   The video generation model that produced the job.
+      # @param progress
+      #   Approximate completion percentage for the generation task.
+      # @param prompt
+      #   The prompt that was used to generate the video.
+      # @param remixed_from_video_id
+      #   Identifier of the source video if this video is a remix.
+      # @param seconds
+      #   Duration of the generated clip in seconds. For extensions, this is the stitched
+      #   total duration.
+      # @param size
+      #   The resolution of the generated video.
+      # @param status
+      #   Current lifecycle status of the video job.
+      # @param object
+      #   The object type, which is always `video`.
       def initialize: (
         id: String,
         completed_at: Integer?,

data/sig/openai/models/video_create_character_params.rbs

@@ -11,10 +11,24 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # Display name for this API character.
       attr_accessor name: String
 
+      # Video file used to create a character.
+      #
+      # `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.
       attr_accessor video: OpenAI::Internal::file_input
 
+      # @param name
+      #   Display name for this API character.
+      # @param video
+      #   Video file used to create a character.
+      #
+      #   `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.
       def initialize: (
         name: String,
         video: OpenAI::Internal::file_input,

data/sig/openai/models/video_create_character_response.rbs

@@ -4,12 +4,21 @@ module OpenAI
       { id: String?, created_at: Integer, name: String? }
 
     class VideoCreateCharacterResponse < OpenAI::Internal::Type::BaseModel
+      # Identifier for the character creation cameo.
       attr_accessor id: String?
 
+      # Unix timestamp (in seconds) when the character was created.
       attr_accessor created_at: Integer
 
+      # Display name for the character.
       attr_accessor name: String?
 
+      # @param id
+      #   Identifier for the character creation cameo.
+      # @param created_at
+      #   Unix timestamp (in seconds) when the character was created.
+      # @param name
+      #   Display name for the character.
       def initialize: (id: String?, created_at: Integer, name: String?) -> void
 
       def to_hash: -> { id: String?, created_at: Integer, name: String? }

data/sig/openai/models/video_create_error.rbs

@@ -8,8 +8,10 @@ module OpenAI
       }
 
     class VideoCreateError < OpenAI::Internal::Type::BaseModel
+      # A machine-readable error code that was returned.
       attr_accessor code: String
 
+      # A human-readable description of the error that was returned.
       attr_accessor message: String
 
       attr_reader misalignment: OpenAI::VideoCreateError::Misalignment?
@@ -18,6 +20,10 @@ module OpenAI
         OpenAI::VideoCreateError::Misalignment
       ) -> OpenAI::VideoCreateError::Misalignment
 
+      # @param code
+      #   A machine-readable error code that was returned.
+      # @param message
+      #   A human-readable description of the error that was returned.
       def initialize: (
         code: String,
         message: String,
@@ -38,22 +44,34 @@ module OpenAI
         }
 
       class Misalignment < OpenAI::Internal::Type::BaseModel
+        # The public explanation for this block.
         attr_reader detailed_explanation: String?
 
+        # The public explanation for this block.
         def detailed_explanation=: (String) -> String
 
+        # An optional classification; clients must accept additional values.
         attr_reader error_type: OpenAI::Models::VideoCreateError::Misalignment::error_type?
 
+        # An optional classification; clients must accept additional values.
         def error_type=: (
           OpenAI::Models::VideoCreateError::Misalignment::error_type
         ) -> OpenAI::Models::VideoCreateError::Misalignment::error_type
 
+        # An optional public continuation instruction.
         attr_reader steer: OpenAI::VideoCreateError::Misalignment::Steer?
 
+        # An optional public continuation instruction.
         def steer=: (
           OpenAI::VideoCreateError::Misalignment::Steer
         ) -> OpenAI::VideoCreateError::Misalignment::Steer
 
+        # @param detailed_explanation
+        #   The public explanation for this block.
+        # @param error_type
+        #   An optional classification; clients must accept additional values.
+        # @param steer
+        #   An optional public continuation instruction.
         def initialize: (
           ?detailed_explanation: String,
           ?error_type: OpenAI::Models::VideoCreateError::Misalignment::error_type,
@@ -87,8 +105,11 @@ module OpenAI
         type steer = { message: String }
 
         class Steer < OpenAI::Internal::Type::BaseModel
+          # The public continuation instruction.
           attr_accessor message: String
 
+          # @param message
+          #   The public continuation instruction.
           def initialize: (message: String) -> void
 
           def to_hash: -> { message: String }

data/sig/openai/models/video_create_params.rbs

@@ -14,28 +14,65 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # Text prompt that describes the video to generate.
       attr_accessor prompt: String
 
+      # 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.
       attr_reader 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.
       def input_reference=: (
         OpenAI::Models::VideoCreateParams::input_reference
       ) -> OpenAI::Models::VideoCreateParams::input_reference
 
+      # The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
+      # to `sora-2`.
       attr_reader model: OpenAI::Models::video_model?
 
+      # The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
+      # to `sora-2`.
       def model=: (OpenAI::Models::video_model) -> OpenAI::Models::video_model
 
+      # Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
       attr_reader seconds: OpenAI::Models::video_seconds?
 
+      # Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
       def seconds=: (
         OpenAI::Models::video_seconds
       ) -> OpenAI::Models::video_seconds
 
+      # Output resolution formatted as width x height (allowed values: 720x1280,
+      # 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
       attr_reader size: OpenAI::Models::video_size?
 
+      # Output resolution formatted as width x height (allowed values: 720x1280,
+      # 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
       def size=: (OpenAI::Models::video_size) -> OpenAI::Models::video_size
 
+      # @param prompt
+      #   Text prompt that describes the video to generate.
+      # @param 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.
+      # @param model
+      #   The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
+      #   to `sora-2`.
+      # @param seconds
+      #   Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
+      # @param size
+      #   Output resolution formatted as width x height (allowed values: 720x1280,
+      #   1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
       def initialize: (
         prompt: String,
         ?input_reference: OpenAI::Models::VideoCreateParams::input_reference,

data/sig/openai/models/video_delete_response.rbs

@@ -4,12 +4,21 @@ module OpenAI
       { id: String, deleted: bool, ?object: :"video.deleted" }
 
     class VideoDeleteResponse < OpenAI::Internal::Type::BaseModel
+      # Identifier of the deleted video.
       attr_accessor id: String
 
+      # Indicates that the video resource was deleted.
       attr_accessor deleted: bool
 
+      # The object type that signals the deletion response.
       attr_accessor object: :"video.deleted"
 
+      # @param id
+      #   Identifier of the deleted video.
+      # @param deleted
+      #   Indicates that the video resource was deleted.
+      # @param object
+      #   The object type that signals the deletion response.
       def initialize: (
         id: String,
         deleted: bool,

data/sig/openai/models/video_download_content_params.rbs

@@ -13,12 +13,16 @@ module OpenAI
 
       attr_accessor video_id: String
 
+      # Which downloadable asset to return. Defaults to the MP4 video.
       attr_reader variant: OpenAI::Models::VideoDownloadContentParams::variant?
 
+      # Which downloadable asset to return. Defaults to the MP4 video.
       def variant=: (
         OpenAI::Models::VideoDownloadContentParams::variant
       ) -> OpenAI::Models::VideoDownloadContentParams::variant
 
+      # @param variant
+      #   Which downloadable asset to return. Defaults to the MP4 video.
       def initialize: (
         video_id: String,
         ?variant: OpenAI::Models::VideoDownloadContentParams::variant,

data/sig/openai/models/video_edit_params.rbs

@@ -11,10 +11,24 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # Text prompt that describes how to edit the source video.
       attr_accessor prompt: String
 
+      # Reference to the completed video to edit.
+      #
+      # `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.
       attr_accessor video: OpenAI::Models::VideoEditParams::video
 
+      # @param prompt
+      #   Text prompt that describes how to edit the source video.
+      # @param video
+      #   Reference to the completed video to edit.
+      #
+      #   `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.
       def initialize: (
         prompt: String,
         video: OpenAI::Models::VideoEditParams::video,
@@ -37,8 +51,11 @@ module OpenAI
         type video_reference_input_param = { id: String }
 
         class VideoReferenceInputParam < OpenAI::Internal::Type::BaseModel
+          # The identifier of the completed video.
           attr_accessor id: String
 
+          # @param id
+          #   The identifier of the completed video.
           def initialize: (id: String) -> void
 
           def to_hash: -> { id: String }

data/sig/openai/models/video_extend_params.rbs

@@ -12,12 +12,31 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # Updated text prompt that directs the extension generation.
       attr_accessor prompt: String
 
+      # Length of the newly generated extension segment in seconds (allowed values: 4,
+      # 8, 12, 16, 20).
       attr_accessor seconds: OpenAI::Models::video_seconds
 
+      # Reference to the completed video to extend.
+      #
+      # `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.
       attr_accessor video: OpenAI::Models::VideoExtendParams::video
 
+      # @param prompt
+      #   Updated text prompt that directs the extension generation.
+      # @param seconds
+      #   Length of the newly generated extension segment in seconds (allowed values: 4,
+      #   8, 12, 16, 20).
+      # @param video
+      #   Reference to the completed video to extend.
+      #
+      #   `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.
       def initialize: (
         prompt: String,
         seconds: OpenAI::Models::video_seconds,
@@ -42,8 +61,11 @@ module OpenAI
         type video_reference_input_param = { id: String }
 
         class VideoReferenceInputParam < OpenAI::Internal::Type::BaseModel
+          # The identifier of the completed video.
           attr_accessor id: String
 
+          # @param id
+          #   The identifier of the completed video.
           def initialize: (id: String) -> void
 
           def to_hash: -> { id: String }

data/sig/openai/models/video_get_character_response.rbs

@@ -4,12 +4,21 @@ module OpenAI
       { id: String?, created_at: Integer, name: String? }
 
     class VideoGetCharacterResponse < OpenAI::Internal::Type::BaseModel
+      # Identifier for the character creation cameo.
       attr_accessor id: String?
 
+      # Unix timestamp (in seconds) when the character was created.
       attr_accessor created_at: Integer
 
+      # Display name for the character.
       attr_accessor name: String?
 
+      # @param id
+      #   Identifier for the character creation cameo.
+      # @param created_at
+      #   Unix timestamp (in seconds) when the character was created.
+      # @param name
+      #   Display name for the character.
       def initialize: (id: String?, created_at: Integer, name: String?) -> void
 
       def to_hash: -> { id: String?, created_at: Integer, name: String? }

data/sig/openai/models/video_list_params.rbs

@@ -12,20 +12,35 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # Identifier for the last item from the previous pagination request
       attr_reader after: String?
 
+      # Identifier for the last item from the previous pagination request
       def after=: (String) -> String
 
+      # Number of items to retrieve
       attr_reader limit: Integer?
 
+      # Number of items to retrieve
       def limit=: (Integer) -> Integer
 
+      # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      # descending order.
       attr_reader order: OpenAI::Models::VideoListParams::order?
 
+      # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      # descending order.
       def order=: (
         OpenAI::Models::VideoListParams::order
       ) -> OpenAI::Models::VideoListParams::order
 
+      # @param after
+      #   Identifier for the last item from the previous pagination request
+      # @param limit
+      #   Number of items to retrieve
+      # @param order
+      #   Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      #   descending order.
       def initialize: (
         ?after: String,
         ?limit: Integer,

data/sig/openai/models/video_remix_params.rbs

@@ -13,8 +13,11 @@ module OpenAI
 
       attr_accessor video_id: String
 
+      # Updated text prompt that directs the remix generation.
       attr_accessor prompt: String
 
+      # @param prompt
+      #   Updated text prompt that directs the remix generation.
       def initialize: (
         video_id: String,
         prompt: String,

data/sig/openai/models/webhooks/batch_cancelled_webhook_event.rbs

@@ -11,20 +11,36 @@ module OpenAI
         }
 
       class BatchCancelledWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor id: String
 
+        # The Unix timestamp (in seconds) of when the batch API request was cancelled.
         attr_accessor created_at: Integer
 
+        # Event data payload.
         attr_accessor data: OpenAI::Webhooks::BatchCancelledWebhookEvent::Data
 
+        # The type of the event. Always `batch.cancelled`.
         attr_accessor type: :"batch.cancelled"
 
+        # The object of the event. Always `event`.
         attr_reader object: OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::object?
 
+        # The object of the event. Always `event`.
         def object=: (
           OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::object
         ) -> OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::object
 
+        # @param id
+        #   The unique ID of the event.
+        # @param created_at
+        #   The Unix timestamp (in seconds) of when the batch API request was cancelled.
+        # @param data
+        #   Event data payload.
+        # @param object
+        #   The object of the event. Always `event`.
+        # @param type
+        #   The type of the event. Always `batch.cancelled`.
         def initialize: (
           id: String,
           created_at: Integer,
@@ -44,8 +60,11 @@ module OpenAI
         type data = { id: String }
 
         class Data < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the batch API request.
           attr_accessor id: String
 
+          # @param id
+          #   The unique ID of the batch API request.
           def initialize: (id: String) -> void
 
           def to_hash: -> { id: String }