openai 0.87.0 → 0.88.0

data/lib/openai/models/responses/response_image_gen_call_generating_event.rb

@@ -32,13 +32,17 @@ module OpenAI
         #   Emitted when an image generation tool call is actively generating an image
         #   (intermediate state).
         #
-        #   @param item_id [String] The unique identifier of the image generation item being processed.
+        #   @param item_id [String]
+        #     The unique identifier of the image generation item being processed.
         #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response's output array.
         #
-        #   @param sequence_number [Integer] The sequence number of the image generation item being processed.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the image generation item being processed.
         #
-        #   @param type [Symbol, :"response.image_generation_call.generating"] The type of the event. Always 'response.image_generation_call.generating'.
+        #   @param type [Symbol, :"response.image_generation_call.generating"]
+        #     The type of the event. Always 'response.image_generation_call.generating'.
       end
     end
   end

data/lib/openai/models/responses/response_image_gen_call_in_progress_event.rb

@@ -31,13 +31,17 @@ module OpenAI
         # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.image_generation_call.in_progress")
         #   Emitted when an image generation tool call is in progress.
         #
-        #   @param item_id [String] The unique identifier of the image generation item being processed.
+        #   @param item_id [String]
+        #     The unique identifier of the image generation item being processed.
         #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response's output array.
         #
-        #   @param sequence_number [Integer] The sequence number of the image generation item being processed.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the image generation item being processed.
         #
-        #   @param type [Symbol, :"response.image_generation_call.in_progress"] The type of the event. Always 'response.image_generation_call.in_progress'.
+        #   @param type [Symbol, :"response.image_generation_call.in_progress"]
+        #     The type of the event. Always 'response.image_generation_call.in_progress'.
       end
     end
   end

data/lib/openai/models/responses/response_image_gen_call_partial_image_event.rb

@@ -66,31 +66,38 @@ module OpenAI
         optional :size, String
 
         # @!method initialize(item_id:, output_index:, partial_image_b64:, partial_image_index:, sequence_number:, background: nil, output_format: nil, quality: nil, size: nil, type: :"response.image_generation_call.partial_image")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent} for more
-        #   details.
-        #
         #   Emitted when a partial image is available during image generation streaming.
         #
-        #   @param item_id [String] The unique identifier of the image generation item being processed.
+        #   @param item_id [String]
+        #     The unique identifier of the image generation item being processed.
         #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response's output array.
         #
-        #   @param partial_image_b64 [String] Base64-encoded partial image data, suitable for rendering as an image.
+        #   @param partial_image_b64 [String]
+        #     Base64-encoded partial image data, suitable for rendering as an image.
         #
-        #   @param partial_image_index [Integer] 0-based index for the partial image (backend is 1-based, but this is 0-based for
+        #   @param partial_image_index [Integer]
+        #     0-based index for the partial image (backend is 1-based, but this is 0-based for
+        #     the user).
         #
-        #   @param sequence_number [Integer] The sequence number of the image generation item being processed.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the image generation item being processed.
         #
-        #   @param background [String] The background setting that was used.
+        #   @param background [String]
+        #     The background setting that was used.
         #
-        #   @param output_format [String] The output format that was used.
+        #   @param output_format [String]
+        #     The output format that was used.
         #
-        #   @param quality [String] The image quality that was used.
+        #   @param quality [String]
+        #     The image quality that was used.
         #
-        #   @param size [String] The image size that was used.
+        #   @param size [String]
+        #     The image size that was used.
         #
-        #   @param type [Symbol, :"response.image_generation_call.partial_image"] The type of the event. Always 'response.image_generation_call.partial_image'.
+        #   @param type [Symbol, :"response.image_generation_call.partial_image"]
+        #     The type of the event. Always 'response.image_generation_call.partial_image'.
       end
     end
   end

data/lib/openai/models/responses/response_in_progress_event.rb

@@ -23,16 +23,16 @@ module OpenAI
         required :type, const: :"response.in_progress"
 
         # @!method initialize(response:, sequence_number:, type: :"response.in_progress")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInProgressEvent} for more details.
-        #
         #   Emitted when the response is in progress.
         #
-        #   @param response [OpenAI::Models::Responses::Response] The response that is in progress.
+        #   @param response [OpenAI::Models::Responses::Response]
+        #     The response that is in progress.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.in_progress"] The type of the event. Always `response.in_progress`.
+        #   @param type [Symbol, :"response.in_progress"]
+        #     The type of the event. Always `response.in_progress`.
       end
     end
   end

data/lib/openai/models/responses/response_incomplete_event.rb

@@ -23,20 +23,20 @@ module OpenAI
         required :type, const: :"response.incomplete"
 
         # @!method initialize(response:, sequence_number:, type: :"response.incomplete")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseIncompleteEvent} for more details.
-        #
         #   An event that is emitted when a response finishes as incomplete.
         #
         #   Over WebSocket, steering can finish a response with
         #   `response.incomplete_details.reason` set to `steered`, followed automatically by
         #   a successor `response.created` that commits the queued steering input.
         #
-        #   @param response [OpenAI::Models::Responses::Response] The response that was incomplete.
+        #   @param response [OpenAI::Models::Responses::Response]
+        #     The response that was incomplete.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.incomplete"] The type of the event. Always `response.incomplete`.
+        #   @param type [Symbol, :"response.incomplete"]
+        #     The type of the event. Always `response.incomplete`.
       end
     end
   end

data/lib/openai/models/responses/response_input_audio.rb

@@ -16,14 +16,12 @@ module OpenAI
         required :type, const: :input_audio
 
         # @!method initialize(input_audio:, type: :input_audio)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputAudio} for more details.
-        #
         #   An audio input to the model.
         #
         #   @param input_audio [OpenAI::Models::Responses::ResponseInputAudio::InputAudio]
         #
-        #   @param type [Symbol, :input_audio] The type of the input item. Always `input_audio`.
+        #   @param type [Symbol, :input_audio]
+        #     The type of the input item. Always `input_audio`.
 
         # @see OpenAI::Models::Responses::ResponseInputAudio#input_audio
         class InputAudio < OpenAI::Internal::Type::BaseModel
@@ -44,12 +42,11 @@ module OpenAI
           )
 
           # @!method initialize(data:, format_:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseInputAudio::InputAudio} for more details.
-          #
-          #   @param data [String] Base64-encoded audio data.
+          #   @param data [String]
+          #     Base64-encoded audio data.
           #
-          #   @param format_ [Symbol, OpenAI::Models::Responses::ResponseInputAudio::InputAudio::Format] The format of the audio data. Currently supported formats are `mp3` and
+          #   @param format_ [Symbol, OpenAI::Models::Responses::ResponseInputAudio::InputAudio::Format]
+          #     The format of the audio data. Currently supported formats are `mp3` and `wav`.
 
           # The format of the audio data. Currently supported formats are `mp3` and `wav`.
           #

data/lib/openai/models/responses/response_input_content.rb

@@ -12,7 +12,7 @@ module OpenAI
         # A text input to the model.
         variant :input_text, -> { OpenAI::Responses::ResponseInputText }
 
-        # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+        # An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
         variant :input_image, -> { OpenAI::Responses::ResponseInputImage }
 
         # A file input to the model.

data/lib/openai/models/responses/response_input_file.rb

@@ -53,24 +53,34 @@ module OpenAI
         optional :prompt_cache_breakpoint, -> { OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint }
 
         # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, prompt_cache_breakpoint: nil, type: :input_file)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputFile} for more details.
-        #
         #   A file input to the model.
         #
-        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputFile::Detail] The detail level of the file to be sent to the model. Use `auto` to let the syst
+        #   @param detail [Symbol, 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`.
         #
-        #   @param file_data [String] The content of the file to be sent to the model.
+        #   @param file_data [String]
+        #     The content of the file to be sent to the model.
         #
-        #   @param file_id [String, nil] The ID of the file to be sent to the model.
+        #   @param file_id [String, nil]
+        #     The ID of the file to be sent to the model.
         #
-        #   @param file_url [String] The URL of the file to be sent to the model.
+        #   @param file_url [String]
+        #     The URL of the file to be sent to the model.
         #
-        #   @param filename [String] The name of the file to be sent to the model.
+        #   @param filename [String]
+        #     The name of the file to be sent to the model.
         #
-        #   @param prompt_cache_breakpoint [OpenAI::Models::Responses::ResponseInputFile::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   @param prompt_cache_breakpoint [OpenAI::Models::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.
         #
-        #   @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
+        #   @param type [Symbol, :input_file]
+        #     The type of the input item. Always `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
@@ -103,7 +113,8 @@ module OpenAI
           #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
           #   token block.
           #
-          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+          #   @param mode [Symbol, :explicit]
+          #     The breakpoint mode. Always `explicit`.
         end
       end
     end

data/lib/openai/models/responses/response_input_file_content.rb

@@ -57,24 +57,34 @@ module OpenAI
         )
 
         # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, prompt_cache_breakpoint: nil, type: :input_file)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputFileContent} for more details.
-        #
         #   A file input to the model.
         #
-        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputFileContent::Detail] The detail level of the file to be sent to the model. Use `auto` to let the syst
+        #   @param detail [Symbol, 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`.
         #
-        #   @param file_data [String, nil] The base64-encoded data of the file to be sent to the model.
+        #   @param file_data [String, nil]
+        #     The base64-encoded data of the file to be sent to the model.
         #
-        #   @param file_id [String, nil] The ID of the file to be sent to the model.
+        #   @param file_id [String, nil]
+        #     The ID of the file to be sent to the model.
         #
-        #   @param file_url [String, nil] The URL of the file to be sent to the model.
+        #   @param file_url [String, nil]
+        #     The URL of the file to be sent to the model.
         #
-        #   @param filename [String, nil] The name of the file to be sent to the model.
+        #   @param filename [String, nil]
+        #     The name of the file to be sent to the model.
         #
-        #   @param prompt_cache_breakpoint [OpenAI::Models::Responses::ResponseInputFileContent::PromptCacheBreakpoint, nil] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Responses::ResponseInputFileContent::PromptCacheBreakpoint, nil]
+        #     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 [Symbol, :input_file] The type of the input item. Always `input_file`.
+        #   @param type [Symbol, :input_file]
+        #     The type of the input item. Always `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
@@ -107,7 +117,8 @@ module OpenAI
           #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
           #   token block.
           #
-          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+          #   @param mode [Symbol, :explicit]
+          #     The breakpoint mode. Always `explicit`.
         end
       end
     end

data/lib/openai/models/responses/response_input_image.rb

@@ -39,21 +39,27 @@ module OpenAI
         optional :prompt_cache_breakpoint, -> { OpenAI::Responses::ResponseInputImage::PromptCacheBreakpoint }
 
         # @!method initialize(detail:, file_id: nil, image_url: nil, prompt_cache_breakpoint: nil, type: :input_image)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputImage} for more details.
-        #
         #   An image input to the model. Learn about
-        #   [image inputs](https://platform.openai.com/docs/guides/vision).
+        #   [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
         #
-        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputImage::Detail] The detail level of the image to be sent to the model. One of `high`, `low`, `au
+        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputImage::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 [String, nil] The ID of the file to be sent to the model.
+        #   @param file_id [String, nil]
+        #     The ID of the file to be sent to the model.
         #
-        #   @param image_url [String, nil] The URL of the image to be sent to the model. A fully qualified URL or base64 en
+        #   @param image_url [String, nil]
+        #     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 [OpenAI::Models::Responses::ResponseInputImage::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   @param prompt_cache_breakpoint [OpenAI::Models::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.
         #
-        #   @param type [Symbol, :input_image] The type of the input item. Always `input_image`.
+        #   @param type [Symbol, :input_image]
+        #     The type of the input item. Always `input_image`.
 
         # The detail level of the image to be sent to the model. One of `high`, `low`,
         # `auto`, or `original`. Defaults to `auto`.
@@ -84,7 +90,8 @@ module OpenAI
           #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
           #   token block.
           #
-          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+          #   @param mode [Symbol, :explicit]
+          #     The breakpoint mode. Always `explicit`.
         end
       end
     end

data/lib/openai/models/responses/response_input_image_content.rb

@@ -43,21 +43,27 @@ module OpenAI
         )
 
         # @!method initialize(detail: nil, file_id: nil, image_url: nil, prompt_cache_breakpoint: nil, type: :input_image)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseInputImageContent} for more details.
-        #
         #   An image input to the model. Learn about
-        #   [image inputs](https://platform.openai.com/docs/guides/vision)
+        #   [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
         #
-        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputImageContent::Detail, nil] The detail level of the image to be sent to the model. One of `high`, `low`, `au
+        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputImageContent::Detail, nil]
+        #     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 [String, nil] The ID of the file to be sent to the model.
+        #   @param file_id [String, nil]
+        #     The ID of the file to be sent to the model.
         #
-        #   @param image_url [String, nil] The URL of the image to be sent to the model. A fully qualified URL or base64 en
+        #   @param image_url [String, nil]
+        #     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 [OpenAI::Models::Responses::ResponseInputImageContent::PromptCacheBreakpoint, nil] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Responses::ResponseInputImageContent::PromptCacheBreakpoint, nil]
+        #     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 [Symbol, :input_image] The type of the input item. Always `input_image`.
+        #   @param type [Symbol, :input_image]
+        #     The type of the input item. Always `input_image`.
 
         # The detail level of the image to be sent to the model. One of `high`, `low`,
         # `auto`, or `original`. Defaults to `auto`.
@@ -88,7 +94,8 @@ module OpenAI
           #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
           #   token block.
           #
-          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+          #   @param mode [Symbol, :explicit]
+          #     The breakpoint mode. Always `explicit`.
         end
       end
     end