openai 0.68.0 → 0.69.0

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

@@ -44,13 +44,22 @@ module OpenAI
         #   @return [Symbol, :shell_call_output]
         required :type, const: :shell_call_output
 
+        # @!attribute caller_
+        #   The execution context that produced this tool call.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Caller::Program, nil]
+        optional :caller_,
+                 union: -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput::Caller },
+                 api_name: :caller,
+                 nil?: true
+
         # @!attribute created_by
         #   The identifier of the actor that created the item.
         #
         #   @return [String, nil]
         optional :created_by, String
 
-        # @!method initialize(id:, call_id:, max_output_length:, output:, status:, created_by: nil, type: :shell_call_output)
+        # @!method initialize(id:, call_id:, max_output_length:, output:, status:, caller_: nil, created_by: nil, type: :shell_call_output)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput} for more
         #   details.
@@ -67,6 +76,8 @@ module OpenAI
         #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Status] The status of the shell call output. One of `in_progress`, `completed`, or `inco
         #
+        #   @param caller_ [OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+        #
         #   @param created_by [String] The identifier of the actor that created the item.
         #
         #   @param type [Symbol, :shell_call_output] The type of the shell call output. Always `shell_call_output`.
@@ -180,6 +191,50 @@ module OpenAI
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # The execution context that produced this tool call.
+        #
+        # @see OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput#caller_
+        module Caller
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :direct, -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput::Caller::Direct }
+
+          variant :program, -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput::Caller::Program }
+
+          class Direct < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :direct]
+            required :type, const: :direct
+
+            # @!method initialize(type: :direct)
+            #   @param type [Symbol, :direct]
+          end
+
+          class Program < OpenAI::Internal::Type::BaseModel
+            # @!attribute caller_id
+            #   The call ID of the program item that produced this tool call.
+            #
+            #   @return [String]
+            required :caller_id, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :program]
+            required :type, const: :program
+
+            # @!method initialize(caller_id:, type: :program)
+            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #
+            #   @param type [Symbol, :program]
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Caller::Program)]
+        end
       end
     end
   end

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

@@ -42,6 +42,15 @@ module OpenAI
         #   @return [String, nil]
         optional :id, String
 
+        # @!attribute caller_
+        #   The execution context that produced this tool call.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseFunctionToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCall::Caller::Program, nil]
+        optional :caller_,
+                 union: -> { OpenAI::Responses::ResponseFunctionToolCall::Caller },
+                 api_name: :caller,
+                 nil?: true
+
         # @!attribute namespace
         #   The namespace of the function to run.
         #
@@ -55,7 +64,7 @@ module OpenAI
         #   @return [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCall::Status, nil]
         optional :status, enum: -> { OpenAI::Responses::ResponseFunctionToolCall::Status }
 
-        # @!method initialize(arguments:, call_id:, name:, id: nil, namespace: nil, status: nil, type: :function_call)
+        # @!method initialize(arguments:, call_id:, name:, id: nil, caller_: nil, namespace: nil, status: nil, type: :function_call)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseFunctionToolCall} for more details.
         #
@@ -71,12 +80,58 @@ module OpenAI
         #
         #   @param id [String] The unique ID of the function tool call.
         #
+        #   @param caller_ [OpenAI::Models::Responses::ResponseFunctionToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCall::Caller::Program, nil] The execution context that produced this tool call.
+        #
         #   @param namespace [String] The namespace of the function to run.
         #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCall::Status] The status of the item. One of `in_progress`, `completed`, or
         #
         #   @param type [Symbol, :function_call] The type of the function tool call. Always `function_call`.
 
+        # The execution context that produced this tool call.
+        #
+        # @see OpenAI::Models::Responses::ResponseFunctionToolCall#caller_
+        module Caller
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :direct, -> { OpenAI::Responses::ResponseFunctionToolCall::Caller::Direct }
+
+          variant :program, -> { OpenAI::Responses::ResponseFunctionToolCall::Caller::Program }
+
+          class Direct < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :direct]
+            required :type, const: :direct
+
+            # @!method initialize(type: :direct)
+            #   @param type [Symbol, :direct]
+          end
+
+          class Program < OpenAI::Internal::Type::BaseModel
+            # @!attribute caller_id
+            #   The call ID of the program item that produced this tool call.
+            #
+            #   @return [String]
+            required :caller_id, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :program]
+            required :type, const: :program
+
+            # @!method initialize(caller_id:, type: :program)
+            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #
+            #   @param type [Symbol, :program]
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Responses::ResponseFunctionToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCall::Caller::Program)]
+        end
+
         # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
         # Populated when items are returned via API.
         #

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

@@ -36,13 +36,22 @@ module OpenAI
         #   @return [Symbol, :function_call_output]
         required :type, const: :function_call_output
 
+        # @!attribute caller_
+        #   The execution context that produced this tool call.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Program, nil]
+        optional :caller_,
+                 union: -> { OpenAI::Responses::ResponseFunctionToolCallOutputItem::Caller },
+                 api_name: :caller,
+                 nil?: true
+
         # @!attribute created_by
         #   The identifier of the actor that created the item.
         #
         #   @return [String, nil]
         optional :created_by, String
 
-        # @!method initialize(id:, call_id:, output:, status:, created_by: nil, type: :function_call_output)
+        # @!method initialize(id:, call_id:, output:, status:, caller_: nil, created_by: nil, type: :function_call_output)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem} for more
         #   details.
@@ -55,6 +64,8 @@ module OpenAI
         #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Status] The status of the item. One of `in_progress`, `completed`, or
         #
+        #   @param caller_ [OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Program, nil] The execution context that produced this tool call.
+        #
         #   @param created_by [String] The identifier of the actor that created the item.
         #
         #   @param type [Symbol, :function_call_output] The type of the function tool call output. Always `function_call_output`.
@@ -115,6 +126,52 @@ module OpenAI
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # The execution context that produced this tool call.
+        #
+        # @see OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem#caller_
+        module Caller
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :direct, -> { OpenAI::Responses::ResponseFunctionToolCallOutputItem::Caller::Direct }
+
+          variant :program, -> { OpenAI::Responses::ResponseFunctionToolCallOutputItem::Caller::Program }
+
+          class Direct < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #   The caller type. Always `direct`.
+            #
+            #   @return [Symbol, :direct]
+            required :type, const: :direct
+
+            # @!method initialize(type: :direct)
+            #   @param type [Symbol, :direct] The caller type. Always `direct`.
+          end
+
+          class Program < OpenAI::Internal::Type::BaseModel
+            # @!attribute caller_id
+            #   The call ID of the program item that produced this tool call.
+            #
+            #   @return [String]
+            required :caller_id, String
+
+            # @!attribute type
+            #   The caller type. Always `program`.
+            #
+            #   @return [Symbol, :program]
+            required :type, const: :program
+
+            # @!method initialize(caller_id:, type: :program)
+            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #
+            #   @param type [Symbol, :program] The caller type. Always `program`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Program)]
+        end
       end
     end
   end

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

@@ -11,9 +11,11 @@ module OpenAI
         required :type, const: :input_file
 
         # @!attribute detail
-        #   The detail level of the file to be sent to the model. Use `low` for the default
-        #   rendering behavior, or `high` to render the file at higher quality. Defaults to
-        #   `low`.
+        #   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`.
         #
         #   @return [Symbol, OpenAI::Models::Responses::ResponseInputFile::Detail, nil]
         optional :detail, enum: -> { OpenAI::Responses::ResponseInputFile::Detail }
@@ -42,13 +44,21 @@ module OpenAI
         #   @return [String, nil]
         optional :filename, String
 
-        # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
+        # @!attribute 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.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseInputFile::PromptCacheBreakpoint, nil]
+        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 `low` for the default
+        #   @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 file_data [String] The content of the file to be sent to the model.
         #
@@ -58,22 +68,43 @@ module OpenAI
         #
         #   @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 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 `low` for the default
-        # rendering behavior, or `high` to render the file at higher quality. Defaults to
-        # `low`.
+        # 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`.
         #
         # @see OpenAI::Models::Responses::ResponseInputFile#detail
         module Detail
           extend OpenAI::Internal::Type::Enum
 
+          AUTO = :auto
           LOW = :low
           HIGH = :high
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see OpenAI::Models::Responses::ResponseInputFile#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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 mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
       end
     end
   end

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

@@ -11,9 +11,11 @@ module OpenAI
         required :type, const: :input_file
 
         # @!attribute detail
-        #   The detail level of the file to be sent to the model. Use `low` for the default
-        #   rendering behavior, or `high` to render the file at higher quality. Defaults to
-        #   `low`.
+        #   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`.
         #
         #   @return [Symbol, OpenAI::Models::Responses::ResponseInputFileContent::Detail, nil]
         optional :detail, enum: -> { OpenAI::Responses::ResponseInputFileContent::Detail }
@@ -42,13 +44,23 @@ module OpenAI
         #   @return [String, nil]
         optional :filename, String, nil?: true
 
-        # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
+        # @!attribute 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.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseInputFileContent::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint,
+                 -> { OpenAI::Responses::ResponseInputFileContent::PromptCacheBreakpoint },
+                 nil?: true
+
+        # @!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 `low` for the default
+        #   @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 file_data [String, nil] The base64-encoded data of the file to be sent to the model.
         #
@@ -58,22 +70,43 @@ module OpenAI
         #
         #   @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 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 `low` for the default
-        # rendering behavior, or `high` to render the file at higher quality. Defaults to
-        # `low`.
+        # 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`.
         #
         # @see OpenAI::Models::Responses::ResponseInputFileContent#detail
         module Detail
           extend OpenAI::Internal::Type::Enum
 
+          AUTO = :auto
           LOW = :low
           HIGH = :high
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see OpenAI::Models::Responses::ResponseInputFileContent#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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 mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
       end
     end
   end

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

@@ -30,7 +30,15 @@ module OpenAI
         #   @return [String, nil]
         optional :image_url, String, nil?: true
 
-        # @!method initialize(detail:, file_id: nil, image_url: nil, type: :input_image)
+        # @!attribute 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.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseInputImage::PromptCacheBreakpoint, nil]
+        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.
         #
@@ -43,6 +51,8 @@ module OpenAI
         #
         #   @param image_url [String, nil] The URL of the image to be sent to the model. A fully qualified URL or base64 en
         #
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Responses::ResponseInputImage::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #
         #   @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`,
@@ -60,6 +70,22 @@ module OpenAI
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see OpenAI::Models::Responses::ResponseInputImage#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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 mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
       end
     end
   end

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

@@ -30,7 +30,17 @@ module OpenAI
         #   @return [String, nil]
         optional :image_url, String, nil?: true
 
-        # @!method initialize(detail: nil, file_id: nil, image_url: nil, type: :input_image)
+        # @!attribute 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.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseInputImageContent::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint,
+                 -> { OpenAI::Responses::ResponseInputImageContent::PromptCacheBreakpoint },
+                 nil?: true
+
+        # @!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.
         #
@@ -43,6 +53,8 @@ module OpenAI
         #
         #   @param image_url [String, nil] The URL of the image to be sent to the model. A fully qualified URL or base64 en
         #
+        #   @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 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`,
@@ -60,6 +72,22 @@ module OpenAI
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see OpenAI::Models::Responses::ResponseInputImageContent#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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 mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
       end
     end
   end