openai 0.35.1 → 0.36.0

data/rbi/openai/models/responses/response_create_params.rbi

@@ -173,6 +173,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::ResponseCreateParams::PromptCacheRetention::OrSymbol
+            )
+          )
+        end
+        attr_accessor :prompt_cache_retention
+
         # **gpt-5 and o-series models only**
         #
         # Configuration options for
@@ -279,7 +292,9 @@ module OpenAI
                 OpenAI::Responses::ToolChoiceTypes,
                 OpenAI::Responses::ToolChoiceFunction,
                 OpenAI::Responses::ToolChoiceMcp,
-                OpenAI::Responses::ToolChoiceCustom
+                OpenAI::Responses::ToolChoiceCustom,
+                OpenAI::Responses::ToolChoiceApplyPatch,
+                OpenAI::Responses::ToolChoiceShell
               )
             )
           )
@@ -295,7 +310,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
               )
           ).void
         end
@@ -332,7 +349,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
                 )
@@ -354,7 +373,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
                 )
@@ -432,6 +453,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::ResponseCreateParams::PromptCacheRetention::OrSymbol
+              ),
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
             safety_identifier: String,
             service_tier:
@@ -452,7 +477,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[
@@ -464,7 +491,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
                 )
@@ -559,6 +588,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
@@ -680,6 +714,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::ResponseCreateParams::PromptCacheRetention::OrSymbol
+                ),
               reasoning: T.nilable(OpenAI::Reasoning),
               safety_identifier: String,
               service_tier:
@@ -700,7 +738,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:
                 T::Array[
@@ -712,7 +752,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
                   )
@@ -783,6 +825,44 @@ 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::ResponseCreateParams::PromptCacheRetention
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_MEMORY =
+            T.let(
+              :"in-memory",
+              OpenAI::Responses::ResponseCreateParams::PromptCacheRetention::TaggedSymbol
+            )
+          PROMPT_CACHE_RETENTION_24H =
+            T.let(
+              :"24h",
+              OpenAI::Responses::ResponseCreateParams::PromptCacheRetention::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseCreateParams::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
@@ -903,7 +983,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_function_shell_call_output_content.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseFunctionShellCallOutputContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseFunctionShellCallOutputContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The exit or timeout outcome associated with this chunk.
+        sig do
+          returns(
+            T.any(
+              OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout,
+              OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit
+            )
+          )
+        end
+        attr_accessor :outcome
+
+        # Captured stderr output for this chunk of the shell call.
+        sig { returns(String) }
+        attr_accessor :stderr
+
+        # Captured stdout output for this chunk of the shell call.
+        sig { returns(String) }
+        attr_accessor :stdout
+
+        # Captured stdout and stderr for a portion of a function shell tool call output.
+        sig do
+          params(
+            outcome:
+              T.any(
+                OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout::OrHash,
+                OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit::OrHash
+              ),
+            stderr: String,
+            stdout: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The exit or timeout outcome associated with this chunk.
+          outcome:,
+          # Captured stderr output for this chunk of the shell call.
+          stderr:,
+          # Captured stdout output for this chunk of the shell call.
+          stdout:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              outcome:
+                T.any(
+                  OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout,
+                  OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit
+                ),
+              stderr: String,
+              stdout: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The exit or timeout outcome associated with this chunk.
+        module Outcome
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout,
+                OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit
+              )
+            end
+
+          class Timeout < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The outcome type. Always `timeout`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Indicates that the function shell call exceeded its configured time limit.
+            sig { params(type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # The outcome type. Always `timeout`.
+              type: :timeout
+            )
+            end
+
+            sig { override.returns({ type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          class Exit < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The exit code returned by the shell process.
+            sig { returns(Integer) }
+            attr_accessor :exit_code
+
+            # The outcome type. Always `exit`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Indicates that the shell commands finished and returned an exit code.
+            sig do
+              params(exit_code: Integer, type: Symbol).returns(T.attached_class)
+            end
+            def self.new(
+              # The exit code returned by the shell process.
+              exit_code:,
+              # The outcome type. Always `exit`.
+              type: :exit
+            )
+            end
+
+            sig { override.returns({ exit_code: Integer, type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/responses/response_function_shell_tool_call.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseFunctionShellToolCall < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseFunctionShellToolCall,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the function shell tool call. Populated when this item is
+        # returned via API.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The shell commands and limits that describe how to run the tool call.
+        sig do
+          returns(OpenAI::Responses::ResponseFunctionShellToolCall::Action)
+        end
+        attr_reader :action
+
+        sig do
+          params(
+            action:
+              OpenAI::Responses::ResponseFunctionShellToolCall::Action::OrHash
+          ).void
+        end
+        attr_writer :action
+
+        # The unique ID of the function shell tool call generated by the model.
+        sig { returns(String) }
+        attr_accessor :call_id
+
+        # The status of the shell call. One of `in_progress`, `completed`, or
+        # `incomplete`.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseFunctionShellToolCall::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The type of the item. Always `shell_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
+
+        # A tool call that executes one or more shell commands in a managed environment.
+        sig do
+          params(
+            id: String,
+            action:
+              OpenAI::Responses::ResponseFunctionShellToolCall::Action::OrHash,
+            call_id: String,
+            status:
+              OpenAI::Responses::ResponseFunctionShellToolCall::Status::OrSymbol,
+            created_by: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the function shell tool call. Populated when this item is
+          # returned via API.
+          id:,
+          # The shell commands and limits that describe how to run the tool call.
+          action:,
+          # The unique ID of the function shell tool call generated by the model.
+          call_id:,
+          # The status of the shell call. One of `in_progress`, `completed`, or
+          # `incomplete`.
+          status:,
+          # The ID of the entity that created this tool call.
+          created_by: nil,
+          # The type of the item. Always `shell_call`.
+          type: :shell_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              action: OpenAI::Responses::ResponseFunctionShellToolCall::Action,
+              call_id: String,
+              status:
+                OpenAI::Responses::ResponseFunctionShellToolCall::Status::TaggedSymbol,
+              type: Symbol,
+              created_by: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Action < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseFunctionShellToolCall::Action,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :commands
+
+          # Optional maximum number of characters to return from each command.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :max_output_length
+
+          # Optional timeout in milliseconds for the commands.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :timeout_ms
+
+          # The shell commands and limits that describe how to run the tool call.
+          sig do
+            params(
+              commands: T::Array[String],
+              max_output_length: T.nilable(Integer),
+              timeout_ms: T.nilable(Integer)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            commands:,
+            # Optional maximum number of characters to return from each command.
+            max_output_length:,
+            # Optional timeout in milliseconds for the commands.
+            timeout_ms:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                commands: T::Array[String],
+                max_output_length: T.nilable(Integer),
+                timeout_ms: T.nilable(Integer)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # The status of the shell call. One of `in_progress`, `completed`, or
+        # `incomplete`.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseFunctionShellToolCall::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Responses::ResponseFunctionShellToolCall::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Responses::ResponseFunctionShellToolCall::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Responses::ResponseFunctionShellToolCall::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseFunctionShellToolCall::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end