openai 0.10.0 → 0.12.0

data/lib/openai/models/webhooks/response_cancelled_webhook_event.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseCancelledWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) of when the model response was cancelled.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #   Event data payload.
+        #
+        #   @return [OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::ResponseCancelledWebhookEvent::Data }
+
+        # @!attribute type
+        #   The type of the event. Always `response.cancelled`.
+        #
+        #   @return [Symbol, :"response.cancelled"]
+        required :type, const: :"response.cancelled"
+
+        # @!attribute object
+        #   The object of the event. Always `event`.
+        #
+        #   @return [Symbol, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent::Object, nil]
+        optional :object, enum: -> { OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object }
+
+        # @!method initialize(id:, created_at:, data:, object: nil, type: :"response.cancelled")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent} for more details.
+        #
+        #   Sent when a background response has been cancelled.
+        #
+        #   @param id [String] The unique ID of the event.
+        #
+        #   @param created_at [Integer] The Unix timestamp (in seconds) of when the model response was cancelled.
+        #
+        #   @param data [OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent::Data] Event data payload.
+        #
+        #   @param object [Symbol, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent::Object] The object of the event. Always `event`.
+        #
+        #   @param type [Symbol, :"response.cancelled"] The type of the event. Always `response.cancelled`.
+
+        # @see OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique ID of the model response.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent::Data} for more
+          #   details.
+          #
+          #   Event data payload.
+          #
+          #   @param id [String] The unique ID of the model response.
+        end
+
+        # The object of the event. Always `event`.
+        #
+        # @see OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/response_completed_webhook_event.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseCompletedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) of when the model response was completed.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #   Event data payload.
+        #
+        #   @return [OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::ResponseCompletedWebhookEvent::Data }
+
+        # @!attribute type
+        #   The type of the event. Always `response.completed`.
+        #
+        #   @return [Symbol, :"response.completed"]
+        required :type, const: :"response.completed"
+
+        # @!attribute object
+        #   The object of the event. Always `event`.
+        #
+        #   @return [Symbol, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent::Object, nil]
+        optional :object, enum: -> { OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object }
+
+        # @!method initialize(id:, created_at:, data:, object: nil, type: :"response.completed")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent} for more details.
+        #
+        #   Sent when a background response has been completed.
+        #
+        #   @param id [String] The unique ID of the event.
+        #
+        #   @param created_at [Integer] The Unix timestamp (in seconds) of when the model response was completed.
+        #
+        #   @param data [OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent::Data] Event data payload.
+        #
+        #   @param object [Symbol, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent::Object] The object of the event. Always `event`.
+        #
+        #   @param type [Symbol, :"response.completed"] The type of the event. Always `response.completed`.
+
+        # @see OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique ID of the model response.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent::Data} for more
+          #   details.
+          #
+          #   Event data payload.
+          #
+          #   @param id [String] The unique ID of the model response.
+        end
+
+        # The object of the event. Always `event`.
+        #
+        # @see OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/response_failed_webhook_event.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) of when the model response failed.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #   Event data payload.
+        #
+        #   @return [OpenAI::Models::Webhooks::ResponseFailedWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::ResponseFailedWebhookEvent::Data }
+
+        # @!attribute type
+        #   The type of the event. Always `response.failed`.
+        #
+        #   @return [Symbol, :"response.failed"]
+        required :type, const: :"response.failed"
+
+        # @!attribute object
+        #   The object of the event. Always `event`.
+        #
+        #   @return [Symbol, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent::Object, nil]
+        optional :object, enum: -> { OpenAI::Webhooks::ResponseFailedWebhookEvent::Object }
+
+        # @!method initialize(id:, created_at:, data:, object: nil, type: :"response.failed")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Webhooks::ResponseFailedWebhookEvent} for more details.
+        #
+        #   Sent when a background response has failed.
+        #
+        #   @param id [String] The unique ID of the event.
+        #
+        #   @param created_at [Integer] The Unix timestamp (in seconds) of when the model response failed.
+        #
+        #   @param data [OpenAI::Models::Webhooks::ResponseFailedWebhookEvent::Data] Event data payload.
+        #
+        #   @param object [Symbol, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent::Object] The object of the event. Always `event`.
+        #
+        #   @param type [Symbol, :"response.failed"] The type of the event. Always `response.failed`.
+
+        # @see OpenAI::Models::Webhooks::ResponseFailedWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique ID of the model response.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Webhooks::ResponseFailedWebhookEvent::Data} for more details.
+          #
+          #   Event data payload.
+          #
+          #   @param id [String] The unique ID of the model response.
+        end
+
+        # The object of the event. Always `event`.
+        #
+        # @see OpenAI::Models::Webhooks::ResponseFailedWebhookEvent#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/response_incomplete_webhook_event.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseIncompleteWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) of when the model response was interrupted.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #   Event data payload.
+        #
+        #   @return [OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Data }
+
+        # @!attribute type
+        #   The type of the event. Always `response.incomplete`.
+        #
+        #   @return [Symbol, :"response.incomplete"]
+        required :type, const: :"response.incomplete"
+
+        # @!attribute object
+        #   The object of the event. Always `event`.
+        #
+        #   @return [Symbol, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent::Object, nil]
+        optional :object, enum: -> { OpenAI::Webhooks::ResponseIncompleteWebhookEvent::Object }
+
+        # @!method initialize(id:, created_at:, data:, object: nil, type: :"response.incomplete")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent} for more details.
+        #
+        #   Sent when a background response has been interrupted.
+        #
+        #   @param id [String] The unique ID of the event.
+        #
+        #   @param created_at [Integer] The Unix timestamp (in seconds) of when the model response was interrupted.
+        #
+        #   @param data [OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent::Data] Event data payload.
+        #
+        #   @param object [Symbol, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent::Object] The object of the event. Always `event`.
+        #
+        #   @param type [Symbol, :"response.incomplete"] The type of the event. Always `response.incomplete`.
+
+        # @see OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique ID of the model response.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent::Data} for more
+          #   details.
+          #
+          #   Event data payload.
+          #
+          #   @param id [String] The unique ID of the model response.
+        end
+
+        # The object of the event. Always `event`.
+        #
+        # @see OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/unwrap_webhook_event.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # Sent when a batch API request has been cancelled.
+      module UnwrapWebhookEvent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Sent when a batch API request has been cancelled.
+        variant :"batch.cancelled", -> { OpenAI::Webhooks::BatchCancelledWebhookEvent }
+
+        # Sent when a batch API request has been completed.
+        variant :"batch.completed", -> { OpenAI::Webhooks::BatchCompletedWebhookEvent }
+
+        # Sent when a batch API request has expired.
+        variant :"batch.expired", -> { OpenAI::Webhooks::BatchExpiredWebhookEvent }
+
+        # Sent when a batch API request has failed.
+        variant :"batch.failed", -> { OpenAI::Webhooks::BatchFailedWebhookEvent }
+
+        # Sent when an eval run has been canceled.
+        variant :"eval.run.canceled", -> { OpenAI::Webhooks::EvalRunCanceledWebhookEvent }
+
+        # Sent when an eval run has failed.
+        variant :"eval.run.failed", -> { OpenAI::Webhooks::EvalRunFailedWebhookEvent }
+
+        # Sent when an eval run has succeeded.
+        variant :"eval.run.succeeded", -> { OpenAI::Webhooks::EvalRunSucceededWebhookEvent }
+
+        # Sent when a fine-tuning job has been cancelled.
+        variant :"fine_tuning.job.cancelled", -> { OpenAI::Webhooks::FineTuningJobCancelledWebhookEvent }
+
+        # Sent when a fine-tuning job has failed.
+        variant :"fine_tuning.job.failed", -> { OpenAI::Webhooks::FineTuningJobFailedWebhookEvent }
+
+        # Sent when a fine-tuning job has succeeded.
+        variant :"fine_tuning.job.succeeded", -> { OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent }
+
+        # Sent when a background response has been cancelled.
+        variant :"response.cancelled", -> { OpenAI::Webhooks::ResponseCancelledWebhookEvent }
+
+        # Sent when a background response has been completed.
+        variant :"response.completed", -> { OpenAI::Webhooks::ResponseCompletedWebhookEvent }
+
+        # Sent when a background response has failed.
+        variant :"response.failed", -> { OpenAI::Webhooks::ResponseFailedWebhookEvent }
+
+        # Sent when a background response has been interrupted.
+        variant :"response.incomplete", -> { OpenAI::Webhooks::ResponseIncompleteWebhookEvent }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent)]
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/webhook_unwrap_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # @see OpenAI::Resources::Webhooks#unwrap
+      class WebhookUnwrapParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openai/models.rb

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

data/lib/openai/resources/chat/completions.rb

@@ -70,7 +70,7 @@ module OpenAI
         #
         # @param seed [Integer, nil] This feature is in Beta.
         #
-        # @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
+        # @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
         #
         # @param stop [String, Array<String>, nil] Not supported with latest reasoning models `o3` and `o4-mini`.
         #
@@ -104,7 +104,6 @@ module OpenAI
             raise ArgumentError.new(message)
           end
 
-          # rubocop:disable Layout/LineLength
           model = nil
           tool_models = {}
           case parsed
@@ -157,11 +156,16 @@ module OpenAI
           else
           end
 
+          # rubocop:disable Metrics/BlockLength
           unwrap = ->(raw) do
             if model.is_a?(OpenAI::StructuredOutput::JsonSchemaConverter)
               raw[:choices]&.each do |choice|
                 message = choice.fetch(:message)
-                parsed = JSON.parse(message.fetch(:content), symbolize_names: true)
+                begin
+                  parsed = JSON.parse(message.fetch(:content), symbolize_names: true)
+                rescue JSON::ParserError => e
+                  parsed = e
+                end
                 coerced = OpenAI::Internal::Type::Converter.coerce(model, parsed)
                 message.store(:parsed, coerced)
               end
@@ -171,7 +175,11 @@ module OpenAI
                 func = tool_call.fetch(:function)
                 next if (model = tool_models[func.fetch(:name)]).nil?
 
-                parsed = JSON.parse(func.fetch(:arguments), symbolize_names: true)
+                begin
+                  parsed = JSON.parse(func.fetch(:arguments), symbolize_names: true)
+                rescue JSON::ParserError => e
+                  parsed = e
+                end
                 coerced = OpenAI::Internal::Type::Converter.coerce(model, parsed)
                 func.store(:parsed, coerced)
               end
@@ -179,7 +187,7 @@ module OpenAI
 
             raw
           end
-          # rubocop:enable Layout/LineLength
+          # rubocop:enable Metrics/BlockLength
 
           @client.request(
             method: :post,
@@ -258,7 +266,7 @@ module OpenAI
         #
         # @param seed [Integer, nil] This feature is in Beta.
         #
-        # @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
+        # @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
         #
         # @param stop [String, Array<String>, nil] Not supported with latest reasoning models `o3` and `o4-mini`.
         #