openai 0.9.0 → 0.11.0

data/rbi/openai/models/webhooks/response_incomplete_webhook_event.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseIncompleteWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::ResponseIncompleteWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the model response was interrupted.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `response.incomplete`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a background response has been interrupted.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data:
+              OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the event.
+          id:,
+          # The Unix timestamp (in seconds) of when the model response was interrupted.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `response.incomplete`.
+          type: :"response.incomplete"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the model response.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Event data payload.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID of the model response.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        # The object of the event. Always `event`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      # Sent when a batch API request has been cancelled.
+      module UnwrapWebhookEvent
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::BatchCancelledWebhookEvent,
+              OpenAI::Webhooks::BatchCompletedWebhookEvent,
+              OpenAI::Webhooks::BatchExpiredWebhookEvent,
+              OpenAI::Webhooks::BatchFailedWebhookEvent,
+              OpenAI::Webhooks::EvalRunCanceledWebhookEvent,
+              OpenAI::Webhooks::EvalRunFailedWebhookEvent,
+              OpenAI::Webhooks::EvalRunSucceededWebhookEvent,
+              OpenAI::Webhooks::FineTuningJobCancelledWebhookEvent,
+              OpenAI::Webhooks::FineTuningJobFailedWebhookEvent,
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent,
+              OpenAI::Webhooks::ResponseCancelledWebhookEvent,
+              OpenAI::Webhooks::ResponseCompletedWebhookEvent,
+              OpenAI::Webhooks::ResponseFailedWebhookEvent,
+              OpenAI::Webhooks::ResponseIncompleteWebhookEvent
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::Webhooks::UnwrapWebhookEvent::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/webhooks/webhook_unwrap_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class WebhookUnwrapParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::WebhookUnwrapParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: OpenAI::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models.rbi

@@ -199,4 +199,6 @@ module OpenAI
   VectorStoreSearchParams = OpenAI::Models::VectorStoreSearchParams
 
   VectorStoreUpdateParams = OpenAI::Models::VectorStoreUpdateParams
+
+  Webhooks = OpenAI::Models::Webhooks
 end

data/rbi/openai/resources/audio/speech.rbi

@@ -15,6 +15,8 @@ module OpenAI
             response_format:
               OpenAI::Audio::SpeechCreateParams::ResponseFormat::OrSymbol,
             speed: Float,
+            stream_format:
+              OpenAI::Audio::SpeechCreateParams::StreamFormat::OrSymbol,
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(StringIO)
         end
@@ -36,8 +38,11 @@ module OpenAI
           # `wav`, and `pcm`.
           response_format: nil,
           # The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
-          # the default. Does not work with `gpt-4o-mini-tts`.
+          # the default.
           speed: nil,
+          # The format to stream the audio in. Supported formats are `sse` and `audio`.
+          # `sse` is not supported for `tts-1` or `tts-1-hd`.
+          stream_format: nil,
           request_options: {}
         )
         end

data/rbi/openai/resources/chat/completions.rbi

@@ -228,23 +228,23 @@ module OpenAI
           # should refer to the `system_fingerprint` response parameter to monitor changes
           # in the backend.
           seed: nil,
-          # Specifies the latency tier to use for processing the request. This parameter is
-          # relevant for customers subscribed to the scale tier service:
-          #
-          # - If set to 'auto', and the Project is Scale tier enabled, the system will
-          #   utilize scale tier credits until they are exhausted.
-          # - If set to 'auto', and the Project is not Scale tier enabled, the request will
-          #   be processed using the default service tier with a lower uptime SLA and no
-          #   latency guarantee.
-          # - If set to 'default', the request will be processed using the default service
-          #   tier with a lower uptime SLA and no latency guarantee.
-          # - If set to 'flex', the request will be processed with the Flex Processing
-          #   service tier.
-          #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
+          # Specifies the processing type used for serving the request.
+          #
+          # - If set to 'auto', then the request will be processed with the service tier
+          #   configured in the Project settings. Unless otherwise configured, the Project
+          #   will use 'default'.
+          # - If set to 'default', then the requset will be processed with the standard
+          #   pricing and performance for the selected model.
+          # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
+          #   'priority', then the request will be processed with the corresponding service
+          #   tier. [Contact sales](https://openai.com/contact-sales) to learn more about
+          #   Priority processing.
           # - When not set, the default behavior is 'auto'.
           #
-          # When this parameter is set, the response body will include the `service_tier`
-          # utilized.
+          # When the `service_tier` parameter is set, the response body will include the
+          # `service_tier` value based on the processing mode actually used to serve the
+          # request. This response value may be different from the value set in the
+          # parameter.
           service_tier: nil,
           # Not supported with latest reasoning models `o3` and `o4-mini`.
           #
@@ -254,6 +254,8 @@ module OpenAI
           # Whether or not to store the output of this chat completion request for use in
           # our [model distillation](https://platform.openai.com/docs/guides/distillation)
           # or [evals](https://platform.openai.com/docs/guides/evals) products.
+          #
+          # Supports text and image inputs. Note: image inputs over 10MB will be dropped.
           store: nil,
           # Options for streaming response. Only set this when you set `stream: true`.
           stream_options: nil,
@@ -515,23 +517,23 @@ module OpenAI
           # should refer to the `system_fingerprint` response parameter to monitor changes
           # in the backend.
           seed: nil,
-          # Specifies the latency tier to use for processing the request. This parameter is
-          # relevant for customers subscribed to the scale tier service:
-          #
-          # - If set to 'auto', and the Project is Scale tier enabled, the system will
-          #   utilize scale tier credits until they are exhausted.
-          # - If set to 'auto', and the Project is not Scale tier enabled, the request will
-          #   be processed using the default service tier with a lower uptime SLA and no
-          #   latency guarantee.
-          # - If set to 'default', the request will be processed using the default service
-          #   tier with a lower uptime SLA and no latency guarantee.
-          # - If set to 'flex', the request will be processed with the Flex Processing
-          #   service tier.
-          #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
+          # Specifies the processing type used for serving the request.
+          #
+          # - If set to 'auto', then the request will be processed with the service tier
+          #   configured in the Project settings. Unless otherwise configured, the Project
+          #   will use 'default'.
+          # - If set to 'default', then the requset will be processed with the standard
+          #   pricing and performance for the selected model.
+          # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
+          #   'priority', then the request will be processed with the corresponding service
+          #   tier. [Contact sales](https://openai.com/contact-sales) to learn more about
+          #   Priority processing.
           # - When not set, the default behavior is 'auto'.
           #
-          # When this parameter is set, the response body will include the `service_tier`
-          # utilized.
+          # When the `service_tier` parameter is set, the response body will include the
+          # `service_tier` value based on the processing mode actually used to serve the
+          # request. This response value may be different from the value set in the
+          # parameter.
           service_tier: nil,
           # Not supported with latest reasoning models `o3` and `o4-mini`.
           #
@@ -541,6 +543,8 @@ module OpenAI
           # Whether or not to store the output of this chat completion request for use in
           # our [model distillation](https://platform.openai.com/docs/guides/distillation)
           # or [evals](https://platform.openai.com/docs/guides/evals) products.
+          #
+          # Supports text and image inputs. Note: image inputs over 10MB will be dropped.
           store: nil,
           # Options for streaming response. Only set this when you set `stream: true`.
           stream_options: nil,

data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi

@@ -43,9 +43,7 @@ module OpenAI
               project_id: String,
               request_options: OpenAI::RequestOptions::OrHash
             ).returns(
-              OpenAI::Internal::CursorPage[
-                OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse
-              ]
+              OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse
             )
           end
           def retrieve(