openai 0.59.0 → 0.61.0

data/rbi/openai/resources/admin/organization/users.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Users
+          sig { returns(OpenAI::Resources::Admin::Organization::Users::Roles) }
+          attr_reader :roles
+
+          # Retrieves a user by their identifier.
+          sig do
+            params(
+              user_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::OrganizationUser)
+          end
+          def retrieve(
+            # The ID of the user.
+            user_id,
+            request_options: {}
+          )
+          end
+
+          # Modifies a user's role in the organization.
+          sig do
+            params(
+              user_id: String,
+              developer_persona: T.nilable(String),
+              role: T.nilable(String),
+              role_id: T.nilable(String),
+              technical_level: T.nilable(String),
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::OrganizationUser)
+          end
+          def update(
+            # The ID of the user.
+            user_id,
+            # Developer persona metadata.
+            developer_persona: nil,
+            # `owner` or `reader`
+            role: nil,
+            # Role ID to assign to the user.
+            role_id: nil,
+            # Technical level metadata.
+            technical_level: nil,
+            request_options: {}
+          )
+          end
+
+          # Lists all of the users in the organization.
+          sig do
+            params(
+              after: String,
+              emails: T::Array[String],
+              limit: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Admin::Organization::OrganizationUser
+              ]
+            )
+          end
+          def list(
+            # A cursor for use in pagination. `after` is an object ID that defines your place
+            # in the list. For instance, if you make a list request and receive 100 objects,
+            # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+            # fetch the next page of the list.
+            after: nil,
+            # Filter by the email address of users.
+            emails: nil,
+            # A limit on the number of objects to be returned. Limit can range between 1 and
+            # 100, and the default is 20.
+            limit: nil,
+            request_options: {}
+          )
+          end
+
+          # Deletes a user from the organization.
+          sig do
+            params(
+              user_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Models::Admin::Organization::UserDeleteResponse)
+          end
+          def delete(
+            # The ID of the user.
+            user_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: OpenAI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/admin/organization.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        # List user actions and configuration changes within this organization.
+        sig { returns(OpenAI::Resources::Admin::Organization::AuditLogs) }
+        attr_reader :audit_logs
+
+        sig { returns(OpenAI::Resources::Admin::Organization::AdminAPIKeys) }
+        attr_reader :admin_api_keys
+
+        sig { returns(OpenAI::Resources::Admin::Organization::Usage) }
+        attr_reader :usage
+
+        sig { returns(OpenAI::Resources::Admin::Organization::Invites) }
+        attr_reader :invites
+
+        sig { returns(OpenAI::Resources::Admin::Organization::Users) }
+        attr_reader :users
+
+        sig { returns(OpenAI::Resources::Admin::Organization::Groups) }
+        attr_reader :groups
+
+        sig { returns(OpenAI::Resources::Admin::Organization::Roles) }
+        attr_reader :roles
+
+        sig { returns(OpenAI::Resources::Admin::Organization::Certificates) }
+        attr_reader :certificates
+
+        sig { returns(OpenAI::Resources::Admin::Organization::Projects) }
+        attr_reader :projects
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/admin.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      sig { returns(OpenAI::Resources::Admin::Organization) }
+      attr_reader :organization
+
+      # @api private
+      sig { params(client: OpenAI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/openai/resources/files.rbi

@@ -7,7 +7,8 @@ module OpenAI
     class Files
       # Upload a file that can be used across various endpoints. Individual files can be
       # up to 512 MB, and each project can store up to 2.5 TB of files in total. There
-      # is no organization-wide storage limit.
+      # is no organization-wide storage limit. Uploads to this endpoint are rate-limited
+      # to 1,000 requests per minute per authenticated user.
       #
       # - The Assistants API supports files up to 2 million tokens and of specific file
       #   types. See the
@@ -22,6 +23,12 @@ module OpenAI
       # - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
       #   also has a specific required
       #   [format](https://platform.openai.com/docs/api-reference/batch/request-input).
+      # - For Retrieval or `file_search` ingestion, upload files here first. If you need
+      #   to attach multiple uploaded files to the same vector store, use
+      #   [`/vector_stores/{vector_store_id}/file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+      #   instead of attaching them one by one. Vector store attachment has separate
+      #   limits from file upload, including 2,000 attached files per minute per
+      #   organization.
       #
       # Please [contact us](https://help.openai.com/) if you need to increase these
       # storage limits.

data/rbi/openai/resources/responses.rbi

@@ -988,6 +988,10 @@ module OpenAI
           instructions: T.nilable(String),
           previous_response_id: T.nilable(String),
           prompt_cache_key: T.nilable(String),
+          prompt_cache_retention:
+            T.nilable(
+              OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
+            ),
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Responses::CompactedResponse)
       end
@@ -1012,6 +1016,8 @@ module OpenAI
         previous_response_id: nil,
         # A key to use when reading from or writing to the prompt cache.
         prompt_cache_key: nil,
+        # How long to retain a prompt cache entry created by this request.
+        prompt_cache_retention: nil,
         request_options: {}
       )
       end

data/sig/openai/client.rbs

@@ -8,7 +8,11 @@ module OpenAI
 
     DEFAULT_MAX_RETRY_DELAY: Float
 
-    attr_reader api_key: String
+    attr_reader api_key: String?
+
+    attr_reader admin_api_key: String?
+
+    attr_reader workload_identity_auth: untyped?
 
     attr_reader organization: String?
 
@@ -46,6 +50,8 @@ module OpenAI
 
     attr_reader uploads: OpenAI::Resources::Uploads
 
+    attr_reader admin: OpenAI::Resources::Admin
+
     attr_reader responses: OpenAI::Resources::Responses
 
     attr_reader realtime: OpenAI::Resources::Realtime
@@ -60,10 +66,18 @@ module OpenAI
 
     attr_reader videos: OpenAI::Resources::Videos
 
-    private def auth_headers: -> ::Hash[String, String]
+    private def auth_headers: (
+      security: { bearer_auth?: bool, admin_api_key_auth?: bool }
+    ) -> ::Hash[String, String]
+
+    private def bearer_auth: -> ::Hash[String, String]
+
+    private def admin_api_key_auth: -> ::Hash[String, String]
 
     def initialize: (
       ?api_key: String?,
+      ?admin_api_key: String?,
+      ?workload_identity: untyped?,
       ?organization: String?,
       ?project: String?,
       ?webhook_secret: String?,

data/sig/openai/internal/next_cursor_page.rbs

@@ -0,0 +1,15 @@
+module OpenAI
+  module Internal
+    class NextCursorPage[Elem]
+      include OpenAI::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor has_more: bool
+
+      attr_accessor next_: String?
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/openai/internal/transport/base_client.rbs

@@ -20,6 +20,7 @@ module OpenAI
             page: Class?,
             stream: Class?,
             model: OpenAI::Internal::Type::Converter::input?,
+            security: { bearer_auth?: bool, admin_api_key_auth?: bool }?,
             options: OpenAI::request_opts?
           }
         type request_input =
@@ -123,6 +124,7 @@ module OpenAI
           ?page: Class?,
           ?stream: Class?,
           ?model: OpenAI::Internal::Type::Converter::input?,
+          ?security: { bearer_auth?: bool, admin_api_key_auth?: bool }?,
           ?options: OpenAI::request_opts?
         ) -> top
 

data/sig/openai/models/admin/organization/admin_api_key.rbs

@@ -0,0 +1,108 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type admin_api_key =
+          {
+            id: String,
+            created_at: Integer,
+            object: :"organization.admin_api_key",
+            owner: OpenAI::Admin::Organization::AdminAPIKey::Owner,
+            redacted_value: String,
+            last_used_at: Integer?,
+            name: String?
+          }
+
+        class AdminAPIKey < OpenAI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor created_at: Integer
+
+          attr_accessor object: :"organization.admin_api_key"
+
+          attr_accessor owner: OpenAI::Admin::Organization::AdminAPIKey::Owner
+
+          attr_accessor redacted_value: String
+
+          attr_accessor last_used_at: Integer?
+
+          attr_accessor name: String?
+
+          def initialize: (
+            id: String,
+            created_at: Integer,
+            owner: OpenAI::Admin::Organization::AdminAPIKey::Owner,
+            redacted_value: String,
+            ?last_used_at: Integer?,
+            ?name: String?,
+            ?object: :"organization.admin_api_key"
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: Integer,
+            object: :"organization.admin_api_key",
+            owner: OpenAI::Admin::Organization::AdminAPIKey::Owner,
+            redacted_value: String,
+            last_used_at: Integer?,
+            name: String?
+          }
+
+          type owner =
+            {
+              id: String,
+              created_at: Integer,
+              name: String,
+              object: String,
+              role: String,
+              type: String
+            }
+
+          class Owner < OpenAI::Internal::Type::BaseModel
+            attr_reader id: String?
+
+            def id=: (String) -> String
+
+            attr_reader created_at: Integer?
+
+            def created_at=: (Integer) -> Integer
+
+            attr_reader name: String?
+
+            def name=: (String) -> String
+
+            attr_reader object: String?
+
+            def object=: (String) -> String
+
+            attr_reader role: String?
+
+            def role=: (String) -> String
+
+            attr_reader type: String?
+
+            def type=: (String) -> String
+
+            def initialize: (
+              ?id: String,
+              ?created_at: Integer,
+              ?name: String,
+              ?object: String,
+              ?role: String,
+              ?type: String
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              created_at: Integer,
+              name: String,
+              object: String,
+              role: String,
+              type: String
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/admin_api_key_create_params.rbs

@@ -0,0 +1,27 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type admin_api_key_create_params =
+          { name: String } & OpenAI::Internal::Type::request_parameters
+
+        class AdminAPIKeyCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor name: String
+
+          def initialize: (
+            name: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            name: String,
+            request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/admin_api_key_create_response.rbs

@@ -0,0 +1,19 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type admin_api_key_create_response = { value: String }
+
+        class AdminAPIKeyCreateResponse < OpenAI::Models::Admin::Organization::AdminAPIKey
+          def value: -> String
+
+          def value=: (String _) -> String
+
+          def initialize: (value: String) -> void
+
+          def to_hash: -> { value: String }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/admin_api_key_delete_params.rbs

@@ -0,0 +1,27 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type admin_api_key_delete_params =
+          { key_id: String } & OpenAI::Internal::Type::request_parameters
+
+        class AdminAPIKeyDeleteParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor key_id: String
+
+          def initialize: (
+            key_id: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            key_id: String,
+            request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/admin_api_key_delete_response.rbs

@@ -0,0 +1,34 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type admin_api_key_delete_response =
+          {
+            id: String,
+            deleted: bool,
+            object: :"organization.admin_api_key.deleted"
+          }
+
+        class AdminAPIKeyDeleteResponse < OpenAI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor deleted: bool
+
+          attr_accessor object: :"organization.admin_api_key.deleted"
+
+          def initialize: (
+            id: String,
+            deleted: bool,
+            ?object: :"organization.admin_api_key.deleted"
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            deleted: bool,
+            object: :"organization.admin_api_key.deleted"
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/admin_api_key_list_params.rbs

@@ -0,0 +1,57 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type admin_api_key_list_params =
+          {
+            after: String?,
+            limit: Integer,
+            order: OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order
+          }
+          & OpenAI::Internal::Type::request_parameters
+
+        class AdminAPIKeyListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor after: String?
+
+          attr_reader limit: Integer?
+
+          def limit=: (Integer) -> Integer
+
+          attr_reader order: OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order?
+
+          def order=: (
+            OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order
+          ) -> OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order
+
+          def initialize: (
+            ?after: String?,
+            ?limit: Integer,
+            ?order: OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            after: String?,
+            limit: Integer,
+            order: OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order,
+            request_options: OpenAI::RequestOptions
+          }
+
+          type order = :asc | :desc
+
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            ASC: :asc
+            DESC: :desc
+
+            def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/admin_api_key_retrieve_params.rbs

@@ -0,0 +1,27 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type admin_api_key_retrieve_params =
+          { key_id: String } & OpenAI::Internal::Type::request_parameters
+
+        class AdminAPIKeyRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor key_id: String
+
+          def initialize: (
+            key_id: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            key_id: String,
+            request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end