openai 0.114.0 → 0.115.0

data/lib/openai/helpers/responses_websocket/connection_resources.rb

@@ -14,7 +14,7 @@ module OpenAI
         # @return [nil]
         def create(**params)
           event_params = params.reject { |key, _value| key == :type || key == "type" }
-          @connection.send_event(**event_params, type: :"response.create")
+          @connection.send_response_create(**event_params, type: :"response.create")
         end
       end
     end

data/lib/openai/helpers/structured_output/response_parser.rb

@@ -136,6 +136,7 @@ module OpenAI
           else
           end
 
+          model = parsed.text_model if parsed.is_a?(RequestWithFormatUpdate)
           [model, tool_models]
         end
 

data/lib/openai/helpers/structured_output.rb

@@ -11,6 +11,64 @@ module OpenAI
     #
     # Supported types: {NilClass} {String} {Symbol} {Integer} {Float} {OpenAI::Boolean}, {OpenAI::EnumOf}, {OpenAI::UnionOf}, {OpenAI::ArrayOf}, {OpenAI::BaseModel}
     module StructuredOutput
+      # Carries a visible format update's local parser without adding a wire field.
+      # A nil model means the update explicitly cleared typed parsing.
+      # @api private
+      module RequestWithFormatUpdate
+        attr_accessor :text_model
+      end
+
+      private_constant :RequestWithFormatUpdate
+
+      # Convert schemas in input items after the SDK has copied the request or event.
+      #
+      # @api private
+      def self.prepare_configuration_updates!(request)
+        input = request[:input] || request["input"]
+        items = request[:items] || request["items"]
+        if input.is_a?(Array)
+          input.each do |item|
+            prepare_configuration_update!(item) do |model|
+              request.extend(RequestWithFormatUpdate) unless request.is_a?(RequestWithFormatUpdate)
+              request.text_model = model
+            end
+          end
+        end
+
+        items.each { |item| prepare_configuration_update!(item) } if items.is_a?(Array)
+        prepare_configuration_update!(request[:item] || request["item"])
+        request
+      end
+
+      def self.prepare_configuration_update!(item)
+        return unless item.is_a?(Hash)
+        type = item[:type] || item["type"]
+        return unless type == :configuration_update || type == "configuration_update"
+
+        text = item[:text] || item["text"]
+        return unless text.is_a?(Hash)
+        unless text.key?(:format) || text.key?("format")
+          key = text.key?(:format_) ? :format_ : "format_"
+          text[:format] = text.delete(key) if text.key?(key)
+        end
+
+        format = text[:format] || text["format"]
+        return unless format.is_a?(Hash)
+        type = format[:type] || format["type"]
+        model = nil
+        if type == :json_schema || type == "json_schema"
+          key = format.key?(:schema) ? :schema : "schema"
+          schema = format[key]
+          if schema.is_a?(JsonSchemaConverter)
+            model = schema
+            format[key] = JsonSchemaConverter.to_json_schema(schema)
+          end
+        end
+
+        yield model if block_given?
+      end
+
+      private_class_method :prepare_configuration_update!
     end
   end
 end

data/lib/openai/helpers/websocket/connection_manager.rb

@@ -20,6 +20,7 @@ module OpenAI
 
       # @api private
       def initialize(
+        client:,
         transport:,
         transport_options:,
         default_transport:,
@@ -32,6 +33,7 @@ module OpenAI
         reserved_options_error_message: nil,
         connection_options: {}
       )
+        @client = client
         @transport = transport
         @default_transport = default_transport
         @connection_class = connection_class
@@ -52,6 +54,15 @@ module OpenAI
         transport = @transport || @default_transport.call
         raise ArgumentError, @transport_error_message unless transport.respond_to?(:open)
 
+        requester = @client.requester
+        unless @transport || (requester.instance_of?(OpenAI::NetHTTPClient) && requester.default_configuration?)
+          raise(
+            ArgumentError,
+            "This HTTP transport's connection policy cannot be used by the default WebSocket " \
+              "transport. Pass a compatible WebSocket transport with its own connection settings."
+          )
+        end
+
         @request.call do |request, mark_handshake_completed|
           block_error = nil
           transport

data/lib/openai/helpers/websocket/resource.rb

@@ -21,6 +21,7 @@ module OpenAI
         error_factory = -> (url:, **options) { BindingConnectionError.new(url: url, **options) }
         ConnectionManager
           .new(
+            client: @client,
             transport: transport,
             transport_options: transport_options,
             default_transport: lambda do

data/lib/openai/helpers/websocket/typed_connection.rb

@@ -38,6 +38,7 @@ module OpenAI
           raise ArgumentError, client_event_error_message
         end
 
+        OpenAI::Helpers::StructuredOutput.prepare_configuration_updates!(payload) if @client_event
         payload = coerce_client_event(payload) if @client_event
         payload = OpenAI::Internal::Type::Converter.dump(@client_event, payload) if @client_event
         validate_event_tree!(payload, json_only: true)

data/lib/openai/internal/type/array_of.rb

@@ -146,7 +146,7 @@ module OpenAI
         # @api private
         #
         # @return [generic<Elem>]
-        protected def item_type = @item_type_fn.call
+        def item_type = @item_type_fn.call
 
         # @api private
         #

data/lib/openai/internal/type/hash_of.rb

@@ -153,7 +153,7 @@ module OpenAI
         # @api private
         #
         # @return [generic<Elem>]
-        protected def item_type = @item_type_fn.call
+        def item_type = @item_type_fn.call
 
         # @api private
         #

data/lib/openai/internal/type/request_parameters.rb

@@ -30,7 +30,8 @@ module OpenAI
             in Hash
               options = OpenAI::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
               request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
-              [dumped.except(:request_options), request_options]
+              body = OpenAI::Helpers::StructuredOutput.prepare_configuration_updates!(dumped.except(:request_options))
+              [body, request_options]
             else
               [dumped, nil]
             end

data/lib/openai/internal/type/union.rb

@@ -216,6 +216,23 @@ module OpenAI
           state[:strictness] = strictness
         end
 
+        # @api private
+        #
+        # @param value [Object]
+        #
+        # @return [OpenAI::Internal::Type::Converter, Class, nil]
+        def variant_for_dump(value)
+          target = resolve_variant(value)
+          return target if target
+
+          known_variants.each do
+            target = _2.call
+            return target if target === value
+          end
+
+          nil
+        end
+
         # @api private
         #
         # @param value [Object]
@@ -226,15 +243,10 @@ module OpenAI
         #
         # @return [Object]
         def dump(value, state:)
-          if (target = resolve_variant(value))
+          if (target = variant_for_dump(value))
             return OpenAI::Internal::Type::Converter.dump(target, value, state: state)
           end
 
-          known_variants.each do
-            target = _2.call
-            return OpenAI::Internal::Type::Converter.dump(target, value, state: state) if target === value
-          end
-
           super
         end
 

data/lib/openai/models/admin/organization/external_key.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalKeys#create
+        class ExternalKey < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute api_project_ids
+          #
+          #   @return [Array<String>]
+          required :api_project_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute created_at
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute object
+          #
+          #   @return [String]
+          required :object, String
+
+          # @!attribute type
+          #
+          #   @return [String]
+          required :type, String
+
+          # @!attribute workspace_id
+          #
+          #   @return [String]
+          required :workspace_id, String
+
+          # @!attribute audience
+          #
+          #   @return [String, nil]
+          optional :audience, String
+
+          # @!attribute external_id
+          #
+          #   @return [String, nil]
+          optional :external_id, String
+
+          # @!attribute key_name
+          #
+          #   @return [String, nil]
+          optional :key_name, String
+
+          # @!attribute key_version
+          #
+          #   @return [String, nil]
+          optional :key_version, String
+
+          # @!attribute kms_arn
+          #
+          #   @return [String, nil]
+          optional :kms_arn, String
+
+          # @!attribute kms_key_location
+          #
+          #   @return [String, nil]
+          optional :kms_key_location, String
+
+          # @!attribute kms_key_name
+          #
+          #   @return [String, nil]
+          optional :kms_key_name, String
+
+          # @!attribute kms_key_ring_name
+          #
+          #   @return [String, nil]
+          optional :kms_key_ring_name, String
+
+          # @!attribute kms_key_version
+          #
+          #   @return [String, nil]
+          optional :kms_key_version, String
+
+          # @!attribute kms_project_id
+          #
+          #   @return [String, nil]
+          optional :kms_project_id, String
+
+          # @!attribute purpose
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKey::Purpose, nil]
+          optional :purpose, enum: -> { OpenAI::Admin::Organization::ExternalKey::Purpose }
+
+          # @!attribute role_arn
+          #
+          #   @return [String, nil]
+          optional :role_arn, String
+
+          # @!attribute tenant_id
+          #
+          #   @return [String, nil]
+          optional :tenant_id, String
+
+          # @!attribute vault_uri
+          #
+          #   @return [String, nil]
+          optional :vault_uri, String
+
+          # @!attribute workload_identity_pool_id
+          #
+          #   @return [String, nil]
+          optional :workload_identity_pool_id, String
+
+          # @!attribute workload_identity_project_number
+          #
+          #   @return [String, nil]
+          optional :workload_identity_project_number, String
+
+          # @!attribute workload_identity_provider_id
+          #
+          #   @return [String, nil]
+          optional :workload_identity_provider_id, String
+
+          # @!method initialize(id:, api_project_ids:, created_at:, name:, object:, type:, workspace_id:, audience: nil, external_id: nil, key_name: nil, key_version: nil, kms_arn: nil, kms_key_location: nil, kms_key_name: nil, kms_key_ring_name: nil, kms_key_version: nil, kms_project_id: nil, purpose: nil, role_arn: nil, tenant_id: nil, vault_uri: nil, workload_identity_pool_id: nil, workload_identity_project_number: nil, workload_identity_provider_id: nil)
+          #   @param id [String]
+          #   @param api_project_ids [Array<String>]
+          #   @param created_at [Integer]
+          #   @param name [String]
+          #   @param object [String]
+          #   @param type [String]
+          #   @param workspace_id [String]
+          #   @param audience [String]
+          #   @param external_id [String]
+          #   @param key_name [String]
+          #   @param key_version [String]
+          #   @param kms_arn [String]
+          #   @param kms_key_location [String]
+          #   @param kms_key_name [String]
+          #   @param kms_key_ring_name [String]
+          #   @param kms_key_version [String]
+          #   @param kms_project_id [String]
+          #   @param purpose [Symbol, OpenAI::Models::Admin::Organization::ExternalKey::Purpose]
+          #   @param role_arn [String]
+          #   @param tenant_id [String]
+          #   @param vault_uri [String]
+          #   @param workload_identity_pool_id [String]
+          #   @param workload_identity_project_number [String]
+          #   @param workload_identity_provider_id [String]
+
+          # @see OpenAI::Models::Admin::Organization::ExternalKey#purpose
+          module Purpose
+            extend OpenAI::Internal::Type::Enum
+
+            EKM = :ekm
+            PSP_DECRYPTION = :psp_decryption
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/external_key_create_params.rb

@@ -0,0 +1,311 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalKeys#create
+        class ExternalKeyCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute body
+          #
+          #   @return [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure]
+          required :body, union: -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body }
+
+          # @!method initialize(body:, request_options: {})
+          #   @param body [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure]
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          module Body
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            variant :aws, -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Aws }
+
+            variant :gcp, -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Gcp }
+
+            variant :azure, -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Azure }
+
+            class Aws < OpenAI::Internal::Type::BaseModel
+              # @!attribute external_id
+              #   The ExternalID that OpenAI will pass in the AssumeRole call for the customer's
+              #   AWS account. This must be the OpenAI organization ID or an API project ID that
+              #   belongs to the organization.
+              #
+              #   @return [String]
+              required :external_id, String
+
+              # @!attribute kms_arn
+              #   The Key Management System ARN for the master key you manage
+              #
+              #   @return [String]
+              required :kms_arn, String
+
+              # @!attribute name
+              #   A friendly name to identify this config
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute role_arn
+              #   The Role ARN that OpenAI will assume to call your KMS
+              #
+              #   @return [String]
+              required :role_arn, String
+
+              # @!attribute type
+              #
+              #   @return [Symbol, :aws]
+              required :type, const: :aws
+
+              # @!attribute purpose
+              #
+              #   @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws::Purpose, nil]
+              optional :purpose, enum: -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Aws::Purpose }
+
+              # @!method initialize(external_id:, kms_arn:, name:, role_arn:, purpose: nil, type: :aws)
+              #   @param external_id [String]
+              #     The ExternalID that OpenAI will pass in the AssumeRole call for the customer's
+              #     AWS account. This must be the OpenAI organization ID or an API project ID that
+              #     belongs to the organization.
+              #
+              #   @param kms_arn [String]
+              #     The Key Management System ARN for the master key you manage
+              #
+              #   @param name [String]
+              #     A friendly name to identify this config
+              #
+              #   @param role_arn [String]
+              #     The Role ARN that OpenAI will assume to call your KMS
+              #
+              #   @param purpose [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws::Purpose]
+              #
+              #   @param type [Symbol, :aws]
+
+              # @see OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws#purpose
+              module Purpose
+                extend OpenAI::Internal::Type::Enum
+
+                EKM = :ekm
+                PSP_DECRYPTION = :psp_decryption
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class Gcp < OpenAI::Internal::Type::BaseModel
+              # @!attribute audience
+              #   The aud field in the identity token OpenAI will pass in the call to the
+              #   customer's GCP STS. This must be the OpenAI organization ID or an API project ID
+              #   that belongs to the organization.
+              #
+              #   @return [String]
+              required :audience, String
+
+              # @!attribute kms_key_location
+              #   The region where your Key Management System master key is located
+              #
+              #   @return [String]
+              required :kms_key_location, String
+
+              # @!attribute kms_key_name
+              #   The name of the Key Management System master key you manage
+              #
+              #   @return [String]
+              required :kms_key_name, String
+
+              # @!attribute kms_key_ring_name
+              #   The Key Management System key ring for the master key you manage
+              #
+              #   @return [String]
+              required :kms_key_ring_name, String
+
+              # @!attribute kms_project_id
+              #   The string GCP project name where your KMS resides
+              #
+              #   @return [String]
+              required :kms_project_id, String
+
+              # @!attribute name
+              #   A friendly name to identify this config
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute type
+              #
+              #   @return [Symbol, :gcp]
+              required :type, const: :gcp
+
+              # @!attribute workload_identity_pool_id
+              #   The pool containing the Workload Identity provider that you registered for
+              #   OpenAI
+              #
+              #   @return [String]
+              required :workload_identity_pool_id, String
+
+              # @!attribute workload_identity_project_number
+              #   The numeric GCP project number where you registered OpenAI's workload identity
+              #
+              #   @return [String]
+              required :workload_identity_project_number, String
+
+              # @!attribute workload_identity_provider_id
+              #   The Workload Identity provider that you registered for OpenAI
+              #
+              #   @return [String]
+              required :workload_identity_provider_id, String
+
+              # @!attribute kms_key_version
+              #   An exact CryptoKeyVersion number. Required for PSP decryption; not accepted for
+              #   EKM.
+              #
+              #   @return [String, nil]
+              optional :kms_key_version, String
+
+              # @!attribute purpose
+              #
+              #   @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp::Purpose, nil]
+              optional :purpose, enum: -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Gcp::Purpose }
+
+              # @!method initialize(audience:, kms_key_location:, kms_key_name:, kms_key_ring_name:, kms_project_id:, name:, workload_identity_pool_id:, workload_identity_project_number:, workload_identity_provider_id:, kms_key_version: nil, purpose: nil, type: :gcp)
+              #   @param audience [String]
+              #     The aud field in the identity token OpenAI will pass in the call to the
+              #     customer's GCP STS. This must be the OpenAI organization ID or an API project ID
+              #     that belongs to the organization.
+              #
+              #   @param kms_key_location [String]
+              #     The region where your Key Management System master key is located
+              #
+              #   @param kms_key_name [String]
+              #     The name of the Key Management System master key you manage
+              #
+              #   @param kms_key_ring_name [String]
+              #     The Key Management System key ring for the master key you manage
+              #
+              #   @param kms_project_id [String]
+              #     The string GCP project name where your KMS resides
+              #
+              #   @param name [String]
+              #     A friendly name to identify this config
+              #
+              #   @param workload_identity_pool_id [String]
+              #     The pool containing the Workload Identity provider that you registered for
+              #     OpenAI
+              #
+              #   @param workload_identity_project_number [String]
+              #     The numeric GCP project number where you registered OpenAI's workload identity
+              #
+              #   @param workload_identity_provider_id [String]
+              #     The Workload Identity provider that you registered for OpenAI
+              #
+              #   @param kms_key_version [String]
+              #     An exact CryptoKeyVersion number. Required for PSP decryption; not accepted for
+              #     EKM.
+              #
+              #   @param purpose [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp::Purpose]
+              #
+              #   @param type [Symbol, :gcp]
+
+              # @see OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp#purpose
+              module Purpose
+                extend OpenAI::Internal::Type::Enum
+
+                EKM = :ekm
+                PSP_DECRYPTION = :psp_decryption
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class Azure < OpenAI::Internal::Type::BaseModel
+              # @!attribute key_name
+              #   The name of the Azure Key Vault master key that you manage
+              #
+              #   @return [String]
+              required :key_name, String
+
+              # @!attribute name
+              #   A friendly name to identify this config
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute tenant_id
+              #   Your Azure tenant UUID
+              #
+              #   @return [String]
+              required :tenant_id, String
+
+              # @!attribute type
+              #
+              #   @return [Symbol, :azure]
+              required :type, const: :azure
+
+              # @!attribute vault_uri
+              #   The URI of the Azure vault containing the master key you manage
+              #
+              #   @return [String]
+              required :vault_uri, String
+
+              # @!attribute key_version
+              #   An exact Azure Key Vault key version. Required for PSP decryption; not accepted
+              #   for EKM.
+              #
+              #   @return [String, nil]
+              optional :key_version, String
+
+              # @!attribute purpose
+              #
+              #   @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure::Purpose, nil]
+              optional(
+                :purpose,
+                enum: -> { OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Azure::Purpose }
+              )
+
+              # @!method initialize(key_name:, name:, tenant_id:, vault_uri:, key_version: nil, purpose: nil, type: :azure)
+              #   @param key_name [String]
+              #     The name of the Azure Key Vault master key that you manage
+              #
+              #   @param name [String]
+              #     A friendly name to identify this config
+              #
+              #   @param tenant_id [String]
+              #     Your Azure tenant UUID
+              #
+              #   @param vault_uri [String]
+              #     The URI of the Azure vault containing the master key you manage
+              #
+              #   @param key_version [String]
+              #     An exact Azure Key Vault key version. Required for PSP decryption; not accepted
+              #     for EKM.
+              #
+              #   @param purpose [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure::Purpose]
+              #
+              #   @param type [Symbol, :azure]
+
+              # @see OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure#purpose
+              module Purpose
+                extend OpenAI::Internal::Type::Enum
+
+                EKM = :ekm
+                PSP_DECRYPTION = :psp_decryption
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure)]
+          end
+        end
+      end
+    end
+  end
+end