openai 0.92.0 → 0.93.0

data/sig/openai/models/responses/response_image_gen_call_completed_event.rbs

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseImageGenCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the image generation item being processed.
         attr_accessor item_id: String
 
+        # The index of the output item in the response's output array.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.image_generation_call.completed'.
         attr_accessor type: :"response.image_generation_call.completed"
 
+        # @param item_id
+        #   The unique identifier of the image generation item being processed.
+        # @param output_index
+        #   The index of the output item in the response's output array.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always 'response.image_generation_call.completed'.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_image_gen_call_generating_event.rbs

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseImageGenCallGeneratingEvent < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the image generation item being processed.
         attr_accessor item_id: String
 
+        # The index of the output item in the response's output array.
         attr_accessor output_index: Integer
 
+        # The sequence number of the image generation item being processed.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.image_generation_call.generating'.
         attr_accessor type: :"response.image_generation_call.generating"
 
+        # @param item_id
+        #   The unique identifier of the image generation item being processed.
+        # @param output_index
+        #   The index of the output item in the response's output array.
+        # @param sequence_number
+        #   The sequence number of the image generation item being processed.
+        # @param type
+        #   The type of the event. Always 'response.image_generation_call.generating'.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_image_gen_call_in_progress_event.rbs

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseImageGenCallInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the image generation item being processed.
         attr_accessor item_id: String
 
+        # The index of the output item in the response's output array.
         attr_accessor output_index: Integer
 
+        # The sequence number of the image generation item being processed.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.image_generation_call.in_progress'.
         attr_accessor type: :"response.image_generation_call.in_progress"
 
+        # @param item_id
+        #   The unique identifier of the image generation item being processed.
+        # @param output_index
+        #   The index of the output item in the response's output array.
+        # @param sequence_number
+        #   The sequence number of the image generation item being processed.
+        # @param type
+        #   The type of the event. Always 'response.image_generation_call.in_progress'.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_image_gen_call_partial_image_event.rbs

@@ -16,34 +16,70 @@ module OpenAI
         }
 
       class ResponseImageGenCallPartialImageEvent < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the image generation item being processed.
         attr_accessor item_id: String
 
+        # The index of the output item in the response's output array.
         attr_accessor output_index: Integer
 
+        # Base64-encoded partial image data, suitable for rendering as an image.
         attr_accessor partial_image_b64: String
 
+        # 0-based index for the partial image (backend is 1-based, but this is 0-based for
+        # the user).
         attr_accessor partial_image_index: Integer
 
+        # The sequence number of the image generation item being processed.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.image_generation_call.partial_image'.
         attr_accessor type: :"response.image_generation_call.partial_image"
 
+        # The background setting that was used.
         attr_reader background: String?
 
+        # The background setting that was used.
         def background=: (String) -> String
 
+        # The output format that was used.
         attr_reader output_format: String?
 
+        # The output format that was used.
         def output_format=: (String) -> String
 
+        # The image quality that was used.
         attr_reader quality: String?
 
+        # The image quality that was used.
         def quality=: (String) -> String
 
+        # The image size that was used.
         attr_reader size: String?
 
+        # The image size that was used.
         def size=: (String) -> String
 
+        # @param item_id
+        #   The unique identifier of the image generation item being processed.
+        # @param output_index
+        #   The index of the output item in the response's output array.
+        # @param partial_image_b64
+        #   Base64-encoded partial image data, suitable for rendering as an image.
+        # @param partial_image_index
+        #   0-based index for the partial image (backend is 1-based, but this is 0-based for
+        #   the user).
+        # @param sequence_number
+        #   The sequence number of the image generation item being processed.
+        # @param background
+        #   The background setting that was used.
+        # @param output_format
+        #   The output format that was used.
+        # @param quality
+        #   The image quality that was used.
+        # @param size
+        #   The image size that was used.
+        # @param type
+        #   The type of the event. Always 'response.image_generation_call.partial_image'.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_in_progress_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # The response that is in progress.
         attr_accessor response: OpenAI::Responses::Response
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.in_progress`.
         attr_accessor type: :"response.in_progress"
 
+        # @param response
+        #   The response that is in progress.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always `response.in_progress`.
         def initialize: (
           response: OpenAI::Responses::Response,
           sequence_number: Integer,

data/sig/openai/models/responses/response_incomplete_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseIncompleteEvent < OpenAI::Internal::Type::BaseModel
+        # The response that was incomplete.
         attr_accessor response: OpenAI::Responses::Response
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.incomplete`.
         attr_accessor type: :"response.incomplete"
 
+        # @param response
+        #   The response that was incomplete.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always `response.incomplete`.
         def initialize: (
           response: OpenAI::Responses::Response,
           sequence_number: Integer,

data/sig/openai/models/responses/response_input_audio.rbs

@@ -10,8 +10,11 @@ module OpenAI
       class ResponseInputAudio < OpenAI::Internal::Type::BaseModel
         attr_accessor input_audio: OpenAI::Responses::ResponseInputAudio::InputAudio
 
+        # The type of the input item. Always `input_audio`.
         attr_accessor type: :input_audio
 
+        # @param type
+        #   The type of the input item. Always `input_audio`.
         def initialize: (
           input_audio: OpenAI::Responses::ResponseInputAudio::InputAudio,
           ?type: :input_audio
@@ -29,10 +32,16 @@ module OpenAI
           }
 
         class InputAudio < OpenAI::Internal::Type::BaseModel
+          # Base64-encoded audio data.
           attr_accessor data: String
 
+          # The format of the audio data. Currently supported formats are `mp3` and `wav`.
           attr_accessor format_: OpenAI::Models::Responses::ResponseInputAudio::InputAudio::format_
 
+          # @param data
+          #   Base64-encoded audio data.
+          # @param format_
+          #   The format of the audio data. Currently supported formats are `mp3` and `wav`.
           def initialize: (
             data: String,
             format_: OpenAI::Models::Responses::ResponseInputAudio::InputAudio::format_

data/sig/openai/models/responses/response_input_file.rbs

@@ -13,34 +13,78 @@ module OpenAI
         }
 
       class ResponseInputFile < OpenAI::Internal::Type::BaseModel
+        # The type of the input item. Always `input_file`.
         attr_accessor type: :input_file
 
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
         attr_reader detail: OpenAI::Models::Responses::ResponseInputFile::detail?
 
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
         def detail=: (
           OpenAI::Models::Responses::ResponseInputFile::detail
         ) -> OpenAI::Models::Responses::ResponseInputFile::detail
 
+        # The content of the file to be sent to the model.
         attr_reader file_data: String?
 
+        # The content of the file to be sent to the model.
         def file_data=: (String) -> String
 
+        # The ID of the file to be sent to the model.
         attr_accessor file_id: String?
 
+        # The URL of the file to be sent to the model.
         attr_reader file_url: String?
 
+        # The URL of the file to be sent to the model.
         def file_url=: (String) -> String
 
+        # The name of the file to be sent to the model.
         attr_reader filename: String?
 
+        # The name of the file to be sent to the model.
         def filename=: (String) -> String
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         attr_reader prompt_cache_breakpoint: OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint?
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         def prompt_cache_breakpoint=: (
           OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint
         ) -> OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint
 
+        # @param detail
+        #   The detail level of the file to be sent to the model. Use `auto` to let the
+        #   system select the detail level; for GPT-5.6 and later models, `auto` uses
+        #   high-quality rendering, which may increase input token usage. Use `low` for
+        #   lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        #   to `auto`.
+        # @param file_data
+        #   The content of the file to be sent to the model.
+        # @param file_id
+        #   The ID of the file to be sent to the model.
+        # @param file_url
+        #   The URL of the file to be sent to the model.
+        # @param filename
+        #   The name of the file to be sent to the model.
+        # @param prompt_cache_breakpoint
+        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #   token block.
+        # @param type
+        #   The type of the input item. Always `input_file`.
         def initialize: (
           ?detail: OpenAI::Models::Responses::ResponseInputFile::detail,
           ?file_data: String,
@@ -76,8 +120,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }

data/sig/openai/models/responses/response_input_file_content.rbs

@@ -13,24 +13,62 @@ module OpenAI
         }
 
       class ResponseInputFileContent < OpenAI::Internal::Type::BaseModel
+        # The type of the input item. Always `input_file`.
         attr_accessor type: :input_file
 
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
         attr_reader detail: OpenAI::Models::Responses::ResponseInputFileContent::detail?
 
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
         def detail=: (
           OpenAI::Models::Responses::ResponseInputFileContent::detail
         ) -> OpenAI::Models::Responses::ResponseInputFileContent::detail
 
+        # The base64-encoded data of the file to be sent to the model.
         attr_accessor file_data: String?
 
+        # The ID of the file to be sent to the model.
         attr_accessor file_id: String?
 
+        # The URL of the file to be sent to the model.
         attr_accessor file_url: String?
 
+        # The name of the file to be sent to the model.
         attr_accessor filename: String?
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         attr_accessor prompt_cache_breakpoint: OpenAI::Responses::ResponseInputFileContent::PromptCacheBreakpoint?
 
+        # @param detail
+        #   The detail level of the file to be sent to the model. Use `auto` to let the
+        #   system select the detail level; for GPT-5.6 and later models, `auto` uses
+        #   high-quality rendering, which may increase input token usage. Use `low` for
+        #   lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        #   to `auto`.
+        # @param file_data
+        #   The base64-encoded data of the file to be sent to the model.
+        # @param file_id
+        #   The ID of the file to be sent to the model.
+        # @param file_url
+        #   The URL of the file to be sent to the model.
+        # @param filename
+        #   The name of the file to be sent to the model.
+        # @param prompt_cache_breakpoint
+        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #   token block.
+        # @param type
+        #   The type of the input item. Always `input_file`.
         def initialize: (
           ?detail: OpenAI::Models::Responses::ResponseInputFileContent::detail,
           ?file_data: String?,
@@ -66,8 +104,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }

data/sig/openai/models/responses/response_input_image.rbs

@@ -11,20 +11,46 @@ module OpenAI
         }
 
       class ResponseInputImage < OpenAI::Internal::Type::BaseModel
+        # The detail level of the image to be sent to the model. One of `high`, `low`,
+        # `auto`, or `original`. Defaults to `auto`.
         attr_accessor detail: OpenAI::Models::Responses::ResponseInputImage::detail
 
+        # The type of the input item. Always `input_image`.
         attr_accessor type: :input_image
 
+        # The ID of the file to be sent to the model.
         attr_accessor file_id: String?
 
+        # The URL of the image to be sent to the model. A fully qualified URL or base64
+        # encoded image in a data URL.
         attr_accessor image_url: String?
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         attr_reader prompt_cache_breakpoint: OpenAI::Responses::ResponseInputImage::PromptCacheBreakpoint?
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         def prompt_cache_breakpoint=: (
           OpenAI::Responses::ResponseInputImage::PromptCacheBreakpoint
         ) -> OpenAI::Responses::ResponseInputImage::PromptCacheBreakpoint
 
+        # @param detail
+        #   The detail level of the image to be sent to the model. One of `high`, `low`,
+        #   `auto`, or `original`. Defaults to `auto`.
+        # @param file_id
+        #   The ID of the file to be sent to the model.
+        # @param image_url
+        #   The URL of the image to be sent to the model. A fully qualified URL or base64
+        #   encoded image in a data URL.
+        # @param prompt_cache_breakpoint
+        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #   token block.
+        # @param type
+        #   The type of the input item. Always `input_image`.
         def initialize: (
           detail: OpenAI::Models::Responses::ResponseInputImage::detail,
           ?file_id: String?,
@@ -57,8 +83,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }

data/sig/openai/models/responses/response_input_image_content.rbs

@@ -11,16 +11,39 @@ module OpenAI
         }
 
       class ResponseInputImageContent < OpenAI::Internal::Type::BaseModel
+        # The type of the input item. Always `input_image`.
         attr_accessor type: :input_image
 
+        # The detail level of the image to be sent to the model. One of `high`, `low`,
+        # `auto`, or `original`. Defaults to `auto`.
         attr_accessor detail: OpenAI::Models::Responses::ResponseInputImageContent::detail?
 
+        # The ID of the file to be sent to the model.
         attr_accessor file_id: String?
 
+        # The URL of the image to be sent to the model. A fully qualified URL or base64
+        # encoded image in a data URL.
         attr_accessor image_url: String?
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         attr_accessor prompt_cache_breakpoint: OpenAI::Responses::ResponseInputImageContent::PromptCacheBreakpoint?
 
+        # @param detail
+        #   The detail level of the image to be sent to the model. One of `high`, `low`,
+        #   `auto`, or `original`. Defaults to `auto`.
+        # @param file_id
+        #   The ID of the file to be sent to the model.
+        # @param image_url
+        #   The URL of the image to be sent to the model. A fully qualified URL or base64
+        #   encoded image in a data URL.
+        # @param prompt_cache_breakpoint
+        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #   token block.
+        # @param type
+        #   The type of the input item. Always `input_image`.
         def initialize: (
           ?detail: OpenAI::Models::Responses::ResponseInputImageContent::detail?,
           ?file_id: String?,
@@ -53,8 +76,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }