openai 0.35.1 → 0.36.0

data/rbi/openai/models/responses/input_token_count_params.rbi

@@ -100,7 +100,9 @@ module OpenAI
                 OpenAI::Responses::ToolChoiceTypes,
                 OpenAI::Responses::ToolChoiceFunction,
                 OpenAI::Responses::ToolChoiceMcp,
-                OpenAI::Responses::ToolChoiceCustom
+                OpenAI::Responses::ToolChoiceCustom,
+                OpenAI::Responses::ToolChoiceApplyPatch,
+                OpenAI::Responses::ToolChoiceShell
               )
             )
           )
@@ -121,7 +123,9 @@ module OpenAI
                   OpenAI::Responses::Tool::CodeInterpreter,
                   OpenAI::Responses::Tool::ImageGeneration,
                   OpenAI::Responses::Tool::LocalShell,
+                  OpenAI::Responses::FunctionShellTool,
                   OpenAI::Responses::CustomTool,
+                  OpenAI::Responses::ApplyPatchTool,
                   OpenAI::Responses::WebSearchTool,
                   OpenAI::Responses::WebSearchPreviewTool
                 )
@@ -181,7 +185,9 @@ module OpenAI
                   OpenAI::Responses::ToolChoiceTypes::OrHash,
                   OpenAI::Responses::ToolChoiceFunction::OrHash,
                   OpenAI::Responses::ToolChoiceMcp::OrHash,
-                  OpenAI::Responses::ToolChoiceCustom::OrHash
+                  OpenAI::Responses::ToolChoiceCustom::OrHash,
+                  OpenAI::Responses::ToolChoiceApplyPatch::OrHash,
+                  OpenAI::Responses::ToolChoiceShell::OrHash
                 )
               ),
             tools:
@@ -195,7 +201,9 @@ module OpenAI
                     OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                     OpenAI::Responses::Tool::ImageGeneration::OrHash,
                     OpenAI::Responses::Tool::LocalShell::OrHash,
+                    OpenAI::Responses::FunctionShellTool::OrHash,
                     OpenAI::Responses::CustomTool::OrHash,
+                    OpenAI::Responses::ApplyPatchTool::OrHash,
                     OpenAI::Responses::WebSearchTool::OrHash,
                     OpenAI::Responses::WebSearchPreviewTool::OrHash
                   )
@@ -283,7 +291,9 @@ module OpenAI
                     OpenAI::Responses::ToolChoiceTypes,
                     OpenAI::Responses::ToolChoiceFunction,
                     OpenAI::Responses::ToolChoiceMcp,
-                    OpenAI::Responses::ToolChoiceCustom
+                    OpenAI::Responses::ToolChoiceCustom,
+                    OpenAI::Responses::ToolChoiceApplyPatch,
+                    OpenAI::Responses::ToolChoiceShell
                   )
                 ),
               tools:
@@ -297,7 +307,9 @@ module OpenAI
                       OpenAI::Responses::Tool::CodeInterpreter,
                       OpenAI::Responses::Tool::ImageGeneration,
                       OpenAI::Responses::Tool::LocalShell,
+                      OpenAI::Responses::FunctionShellTool,
                       OpenAI::Responses::CustomTool,
+                      OpenAI::Responses::ApplyPatchTool,
                       OpenAI::Responses::WebSearchTool,
                       OpenAI::Responses::WebSearchPreviewTool
                     )
@@ -542,7 +554,9 @@ module OpenAI
                 OpenAI::Responses::ToolChoiceTypes,
                 OpenAI::Responses::ToolChoiceFunction,
                 OpenAI::Responses::ToolChoiceMcp,
-                OpenAI::Responses::ToolChoiceCustom
+                OpenAI::Responses::ToolChoiceCustom,
+                OpenAI::Responses::ToolChoiceApplyPatch,
+                OpenAI::Responses::ToolChoiceShell
               )
             end
 

data/rbi/openai/models/responses/response.rbi

@@ -193,6 +193,19 @@ module OpenAI
         sig { params(prompt_cache_key: String).void }
         attr_writer :prompt_cache_key
 
+        # The retention policy for the prompt cache. Set to `24h` to enable extended
+        # prompt caching, which keeps cached prefixes active for longer, up to a maximum
+        # of 24 hours.
+        # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::Response::PromptCacheRetention::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :prompt_cache_retention
+
         # **gpt-5 and o-series models only**
         #
         # Configuration options for
@@ -324,6 +337,10 @@ module OpenAI
                   OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OrHash,
                   OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
                   OpenAI::Responses::ResponseOutputItem::LocalShellCall::OrHash,
+                  OpenAI::Responses::ResponseFunctionShellToolCall::OrHash,
+                  OpenAI::Responses::ResponseFunctionShellToolCallOutput::OrHash,
+                  OpenAI::Responses::ResponseApplyPatchToolCall::OrHash,
+                  OpenAI::Responses::ResponseApplyPatchToolCallOutput::OrHash,
                   OpenAI::Responses::ResponseOutputItem::McpCall::OrHash,
                   OpenAI::Responses::ResponseOutputItem::McpListTools::OrHash,
                   OpenAI::Responses::ResponseOutputItem::McpApprovalRequest::OrHash,
@@ -339,7 +356,9 @@ module OpenAI
                 OpenAI::Responses::ToolChoiceTypes::OrHash,
                 OpenAI::Responses::ToolChoiceFunction::OrHash,
                 OpenAI::Responses::ToolChoiceMcp::OrHash,
-                OpenAI::Responses::ToolChoiceCustom::OrHash
+                OpenAI::Responses::ToolChoiceCustom::OrHash,
+                OpenAI::Responses::ToolChoiceApplyPatch::OrHash,
+                OpenAI::Responses::ToolChoiceShell::OrHash
               ),
             tools:
               T::Array[
@@ -351,7 +370,9 @@ module OpenAI
                   OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                   OpenAI::Responses::Tool::ImageGeneration::OrHash,
                   OpenAI::Responses::Tool::LocalShell::OrHash,
+                  OpenAI::Responses::FunctionShellTool::OrHash,
                   OpenAI::Responses::CustomTool::OrHash,
+                  OpenAI::Responses::ApplyPatchTool::OrHash,
                   OpenAI::Responses::WebSearchTool::OrHash,
                   OpenAI::Responses::WebSearchPreviewTool::OrHash
                 )
@@ -365,6 +386,10 @@ module OpenAI
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
             prompt_cache_key: String,
+            prompt_cache_retention:
+              T.nilable(
+                OpenAI::Responses::Response::PromptCacheRetention::OrSymbol
+              ),
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
             safety_identifier: String,
             service_tier:
@@ -479,6 +504,11 @@ module OpenAI
           # hit rates. Replaces the `user` field.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
           prompt_cache_key: nil,
+          # The retention policy for the prompt cache. Set to `24h` to enable extended
+          # prompt caching, which keeps cached prefixes active for longer, up to a maximum
+          # of 24 hours.
+          # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+          prompt_cache_retention: nil,
           # **gpt-5 and o-series models only**
           #
           # Configuration options for
@@ -568,6 +598,10 @@ module OpenAI
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
               prompt_cache_key: String,
+              prompt_cache_retention:
+                T.nilable(
+                  OpenAI::Responses::Response::PromptCacheRetention::TaggedSymbol
+                ),
               reasoning: T.nilable(OpenAI::Reasoning),
               safety_identifier: String,
               service_tier:
@@ -723,7 +757,9 @@ module OpenAI
                 OpenAI::Responses::ToolChoiceTypes,
                 OpenAI::Responses::ToolChoiceFunction,
                 OpenAI::Responses::ToolChoiceMcp,
-                OpenAI::Responses::ToolChoiceCustom
+                OpenAI::Responses::ToolChoiceCustom,
+                OpenAI::Responses::ToolChoiceApplyPatch,
+                OpenAI::Responses::ToolChoiceShell
               )
             end
 
@@ -763,6 +799,41 @@ module OpenAI
           end
         end
 
+        # The retention policy for the prompt cache. Set to `24h` to enable extended
+        # prompt caching, which keeps cached prefixes active for longer, up to a maximum
+        # of 24 hours.
+        # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        module PromptCacheRetention
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Responses::Response::PromptCacheRetention)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_MEMORY =
+            T.let(
+              :"in-memory",
+              OpenAI::Responses::Response::PromptCacheRetention::TaggedSymbol
+            )
+          PROMPT_CACHE_RETENTION_24H =
+            T.let(
+              :"24h",
+              OpenAI::Responses::Response::PromptCacheRetention::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::Response::PromptCacheRetention::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier

data/rbi/openai/models/responses/response_apply_patch_tool_call.rbi

@@ -0,0 +1,300 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseApplyPatchToolCall < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseApplyPatchToolCall,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the apply patch tool call. Populated when this item is returned
+        # via API.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The unique ID of the apply patch tool call generated by the model.
+        sig { returns(String) }
+        attr_accessor :call_id
+
+        # The status of the apply patch tool call. One of `in_progress` or `completed`.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The type of the item. Always `apply_patch_call`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The ID of the entity that created this tool call.
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_by
+
+        sig { params(created_by: String).void }
+        attr_writer :created_by
+
+        # One of the create_file, delete_file, or update_file operations applied via
+        # apply_patch.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::ResponseApplyPatchToolCall::Operation::Variants
+            )
+          )
+        end
+        attr_reader :operation
+
+        sig do
+          params(
+            operation:
+              T.any(
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::CreateFile::OrHash,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile::OrHash,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile::OrHash
+              )
+          ).void
+        end
+        attr_writer :operation
+
+        # A tool call that applies file diffs by creating, deleting, or updating files.
+        sig do
+          params(
+            id: String,
+            call_id: String,
+            status:
+              OpenAI::Responses::ResponseApplyPatchToolCall::Status::OrSymbol,
+            created_by: String,
+            operation:
+              T.any(
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::CreateFile::OrHash,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile::OrHash,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the apply patch tool call. Populated when this item is returned
+          # via API.
+          id:,
+          # The unique ID of the apply patch tool call generated by the model.
+          call_id:,
+          # The status of the apply patch tool call. One of `in_progress` or `completed`.
+          status:,
+          # The ID of the entity that created this tool call.
+          created_by: nil,
+          # One of the create_file, delete_file, or update_file operations applied via
+          # apply_patch.
+          operation: nil,
+          # The type of the item. Always `apply_patch_call`.
+          type: :apply_patch_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              call_id: String,
+              status:
+                OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol,
+              type: Symbol,
+              created_by: String,
+              operation:
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the apply patch tool call. One of `in_progress` or `completed`.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # One of the create_file, delete_file, or update_file operations applied via
+        # apply_patch.
+        module Operation
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::CreateFile,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile
+              )
+            end
+
+          class CreateFile < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseApplyPatchToolCall::Operation::CreateFile,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Diff to apply.
+            sig { returns(String) }
+            attr_accessor :diff
+
+            # Path of the file to create.
+            sig { returns(String) }
+            attr_accessor :path
+
+            # Create a new file with the provided diff.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Instruction describing how to create a file via the apply_patch tool.
+            sig do
+              params(diff: String, path: String, type: Symbol).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Diff to apply.
+              diff:,
+              # Path of the file to create.
+              path:,
+              # Create a new file with the provided diff.
+              type: :create_file
+            )
+            end
+
+            sig do
+              override.returns({ diff: String, path: String, type: Symbol })
+            end
+            def to_hash
+            end
+          end
+
+          class DeleteFile < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Path of the file to delete.
+            sig { returns(String) }
+            attr_accessor :path
+
+            # Delete the specified file.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Instruction describing how to delete a file via the apply_patch tool.
+            sig { params(path: String, type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # Path of the file to delete.
+              path:,
+              # Delete the specified file.
+              type: :delete_file
+            )
+            end
+
+            sig { override.returns({ path: String, type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          class UpdateFile < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Diff to apply.
+            sig { returns(String) }
+            attr_accessor :diff
+
+            # Path of the file to update.
+            sig { returns(String) }
+            attr_accessor :path
+
+            # Update an existing file with the provided diff.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Instruction describing how to update a file via the apply_patch tool.
+            sig do
+              params(diff: String, path: String, type: Symbol).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Diff to apply.
+              diff:,
+              # Path of the file to update.
+              path:,
+              # Update an existing file with the provided diff.
+              type: :update_file
+            )
+            end
+
+            sig do
+              override.returns({ diff: String, path: String, type: Symbol })
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/responses/response_apply_patch_tool_call_output.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseApplyPatchToolCallOutput < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseApplyPatchToolCallOutput,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the apply patch tool call output. Populated when this item is
+        # returned via API.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The unique ID of the apply patch tool call generated by the model.
+        sig { returns(String) }
+        attr_accessor :call_id
+
+        # Optional textual output returned by the apply patch tool.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :output
+
+        # The status of the apply patch tool call output. One of `completed` or `failed`.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The type of the item. Always `apply_patch_call_output`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The ID of the entity that created this tool call output.
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_by
+
+        sig { params(created_by: String).void }
+        attr_writer :created_by
+
+        # The output emitted by an apply patch tool call.
+        sig do
+          params(
+            id: String,
+            call_id: String,
+            output: T.nilable(String),
+            status:
+              OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::OrSymbol,
+            created_by: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the apply patch tool call output. Populated when this item is
+          # returned via API.
+          id:,
+          # The unique ID of the apply patch tool call generated by the model.
+          call_id:,
+          # Optional textual output returned by the apply patch tool.
+          output:,
+          # The status of the apply patch tool call output. One of `completed` or `failed`.
+          status:,
+          # The ID of the entity that created this tool call output.
+          created_by: nil,
+          # The type of the item. Always `apply_patch_call_output`.
+          type: :apply_patch_call_output
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              call_id: String,
+              output: T.nilable(String),
+              status:
+                OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::TaggedSymbol,
+              type: Symbol,
+              created_by: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the apply patch tool call output. One of `completed` or `failed`.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end