openai 0.92.0 → 0.93.0

data/sig/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbs

@@ -19,36 +19,75 @@ module OpenAI
         }
 
       class BetaResponseImageGenCallPartialImageEvent < 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 agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseImageGenCallPartialImageEvent::Agent?
 
+        # 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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @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,
@@ -80,8 +119,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_in_progress_event.rbs

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # The response that is in progress.
         attr_accessor response: OpenAI::Beta::BetaResponse
 
+        # 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseInProgressEvent::Agent?
 
+        # @param response
+        #   The response that is in progress.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.in_progress`.
         def initialize: (
           response: OpenAI::Beta::BetaResponse,
           sequence_number: Integer,
@@ -37,8 +49,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_incomplete_event.rbs

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseIncompleteEvent < OpenAI::Internal::Type::BaseModel
+        # The response that was incomplete.
         attr_accessor response: OpenAI::Beta::BetaResponse
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.incomplete`.
         attr_accessor type: :"response.incomplete"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseIncompleteEvent::Agent?
 
+        # @param response
+        #   The response that was incomplete.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.incomplete`.
         def initialize: (
           response: OpenAI::Beta::BetaResponse,
           sequence_number: Integer,
@@ -37,8 +49,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_inject_created_event.rbs

@@ -12,16 +12,32 @@ module OpenAI
         }
 
       class BetaResponseInjectCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the response that accepted the input.
         attr_accessor response_id: String
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The event discriminator. Always `response.inject.created`.
         attr_accessor type: :"response.inject.created"
 
+        # The multiplexed WebSocket stream that emitted the event. This field is present
+        # only when WebSocket multiplexing is enabled separately.
         attr_reader stream_id: String?
 
+        # The multiplexed WebSocket stream that emitted the event. This field is present
+        # only when WebSocket multiplexing is enabled separately.
         def stream_id=: (String) -> String
 
+        # @param response_id
+        #   The ID of the response that accepted the input.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param stream_id
+        #   The multiplexed WebSocket stream that emitted the event. This field is present
+        #   only when WebSocket multiplexing is enabled separately.
+        # @param type
+        #   The event discriminator. Always `response.inject.created`.
         def initialize: (
           response_id: String,
           sequence_number: Integer,

data/sig/openai/models/beta/beta_response_inject_event.rbs

@@ -11,12 +11,21 @@ module OpenAI
         }
 
       class BetaResponseInjectEvent < OpenAI::Internal::Type::BaseModel
+        # Input items to inject into the active response.
         attr_accessor input: ::Array[OpenAI::Models::Beta::beta_response_input_item]
 
+        # The ID of the active response that should receive the input.
         attr_accessor response_id: String
 
+        # The event discriminator. Always `response.inject`.
         attr_accessor type: :"response.inject"
 
+        # @param input
+        #   Input items to inject into the active response.
+        # @param response_id
+        #   The ID of the active response that should receive the input.
+        # @param type
+        #   The event discriminator. Always `response.inject`.
         def initialize: (
           input: ::Array[OpenAI::Models::Beta::beta_response_input_item],
           response_id: String,

data/sig/openai/models/beta/beta_response_inject_failed_event.rbs

@@ -14,20 +14,42 @@ module OpenAI
         }
 
       class BetaResponseInjectFailedEvent < OpenAI::Internal::Type::BaseModel
+        # Information about why the input was not committed.
         attr_accessor error: OpenAI::Beta::BetaResponseInjectFailedEvent::Error
 
+        # The raw input items that were not committed.
         attr_accessor input: ::Array[OpenAI::Models::Beta::beta_response_input_item]
 
+        # The ID of the response that rejected the input.
         attr_accessor response_id: String
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The event discriminator. Always `response.inject.failed`.
         attr_accessor type: :"response.inject.failed"
 
+        # The multiplexed WebSocket stream that emitted the event. This field is present
+        # only when WebSocket multiplexing is enabled separately.
         attr_reader stream_id: String?
 
+        # The multiplexed WebSocket stream that emitted the event. This field is present
+        # only when WebSocket multiplexing is enabled separately.
         def stream_id=: (String) -> String
 
+        # @param error
+        #   Information about why the input was not committed.
+        # @param input
+        #   The raw input items that were not committed.
+        # @param response_id
+        #   The ID of the response that rejected the input.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param stream_id
+        #   The multiplexed WebSocket stream that emitted the event. This field is present
+        #   only when WebSocket multiplexing is enabled separately.
+        # @param type
+        #   The event discriminator. Always `response.inject.failed`.
         def initialize: (
           error: OpenAI::Beta::BetaResponseInjectFailedEvent::Error,
           input: ::Array[OpenAI::Models::Beta::beta_response_input_item],
@@ -53,10 +75,16 @@ module OpenAI
           }
 
         class Error < OpenAI::Internal::Type::BaseModel
+          # A machine-readable error code.
           attr_accessor code: OpenAI::Models::Beta::BetaResponseInjectFailedEvent::Error::code
 
+          # A human-readable description of the error.
           attr_accessor message: String
 
+          # @param code
+          #   A machine-readable error code.
+          # @param message
+          #   A human-readable description of the error.
           def initialize: (
             code: OpenAI::Models::Beta::BetaResponseInjectFailedEvent::Error::code,
             message: String

data/sig/openai/models/beta/beta_response_input_audio.rbs

@@ -12,8 +12,11 @@ module OpenAI
       class BetaResponseInputAudio < OpenAI::Internal::Type::BaseModel
         attr_accessor input_audio: OpenAI::Beta::BetaResponseInputAudio::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::Beta::BetaResponseInputAudio::InputAudio,
           ?type: :input_audio
@@ -31,10 +34,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::Beta::BetaResponseInputAudio::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::Beta::BetaResponseInputAudio::InputAudio::format_

data/sig/openai/models/beta/beta_response_input_file.rbs

@@ -15,34 +15,78 @@ module OpenAI
         }
 
       class BetaResponseInputFile < 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::Beta::BetaResponseInputFile::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::Beta::BetaResponseInputFile::detail
         ) -> OpenAI::Models::Beta::BetaResponseInputFile::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::Beta::BetaResponseInputFile::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::Beta::BetaResponseInputFile::PromptCacheBreakpoint
         ) -> OpenAI::Beta::BetaResponseInputFile::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::Beta::BetaResponseInputFile::detail,
           ?file_data: String,
@@ -78,8 +122,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/beta/beta_response_input_file_content.rbs

@@ -15,24 +15,62 @@ module OpenAI
         }
 
       class BetaResponseInputFileContent < 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::Beta::BetaResponseInputFileContent::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::Beta::BetaResponseInputFileContent::detail
         ) -> OpenAI::Models::Beta::BetaResponseInputFileContent::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::Beta::BetaResponseInputFileContent::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::Beta::BetaResponseInputFileContent::detail,
           ?file_data: String?,
@@ -68,8 +106,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/beta/beta_response_input_image.rbs

@@ -13,20 +13,46 @@ module OpenAI
         }
 
       class BetaResponseInputImage < 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::Beta::BetaResponseInputImage::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::Beta::BetaResponseInputImage::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::Beta::BetaResponseInputImage::PromptCacheBreakpoint
         ) -> OpenAI::Beta::BetaResponseInputImage::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::Beta::BetaResponseInputImage::detail,
           ?file_id: String?,
@@ -59,8 +85,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/beta/beta_response_input_image_content.rbs

@@ -13,16 +13,39 @@ module OpenAI
         }
 
       class BetaResponseInputImageContent < 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::Beta::BetaResponseInputImageContent::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::Beta::BetaResponseInputImageContent::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::Beta::BetaResponseInputImageContent::detail?,
           ?file_id: String?,
@@ -55,8 +78,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 }