openai 0.62.0 → 0.64.0

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

@@ -314,6 +314,61 @@ module OpenAI
           )
           end
 
+          # Get file search calls usage details for the organization.
+          sig do
+            params(
+              start_time: Integer,
+              api_key_ids: T::Array[String],
+              bucket_width:
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::OrSymbol,
+              end_time: Integer,
+              group_by:
+                T::Array[
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::OrSymbol
+                ],
+              limit: Integer,
+              page: String,
+              project_ids: T::Array[String],
+              user_ids: T::Array[String],
+              vector_store_ids: T::Array[String],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse
+            )
+          end
+          def file_search_calls(
+            # Start time (Unix seconds) of the query time range, inclusive.
+            start_time:,
+            # Return only usage for these API keys.
+            api_key_ids: nil,
+            # Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+            # supported, default to `1d`.
+            bucket_width: nil,
+            # End time (Unix seconds) of the query time range, exclusive.
+            end_time: nil,
+            # Group the usage data by the specified fields. Support fields include
+            # `project_id`, `user_id`, `api_key_id`, `vector_store_id` or any combination of
+            # them.
+            group_by: nil,
+            # Specifies the number of buckets to return.
+            #
+            # - `bucket_width=1d`: default: 7, max: 31
+            # - `bucket_width=1h`: default: 24, max: 168
+            # - `bucket_width=1m`: default: 60, max: 1440
+            limit: nil,
+            # A cursor for use in pagination. Corresponding to the `next_page` field from the
+            # previous response.
+            page: nil,
+            # Return only usage for these projects.
+            project_ids: nil,
+            # Return only usage for these users.
+            user_ids: nil,
+            # Return only usage for these vector stores.
+            vector_store_ids: nil,
+            request_options: {}
+          )
+          end
+
           # Get images usage details for the organization.
           sig do
             params(
@@ -480,6 +535,67 @@ module OpenAI
           )
           end
 
+          # Get web search calls usage details for the organization.
+          sig do
+            params(
+              start_time: Integer,
+              api_key_ids: T::Array[String],
+              bucket_width:
+                OpenAI::Admin::Organization::UsageWebSearchCallsParams::BucketWidth::OrSymbol,
+              context_levels:
+                T::Array[
+                  OpenAI::Admin::Organization::UsageWebSearchCallsParams::ContextLevel::OrSymbol
+                ],
+              end_time: Integer,
+              group_by:
+                T::Array[
+                  OpenAI::Admin::Organization::UsageWebSearchCallsParams::GroupBy::OrSymbol
+                ],
+              limit: Integer,
+              models: T::Array[String],
+              page: String,
+              project_ids: T::Array[String],
+              user_ids: T::Array[String],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse
+            )
+          end
+          def web_search_calls(
+            # Start time (Unix seconds) of the query time range, inclusive.
+            start_time:,
+            # Return only usage for these API keys.
+            api_key_ids: nil,
+            # Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+            # supported, default to `1d`.
+            bucket_width: nil,
+            # Return only web search usage for these context levels.
+            context_levels: nil,
+            # End time (Unix seconds) of the query time range, exclusive.
+            end_time: nil,
+            # Group the usage data by the specified fields. Support fields include
+            # `project_id`, `user_id`, `api_key_id`, `model`, `context_level` or any
+            # combination of them.
+            group_by: nil,
+            # Specifies the number of buckets to return.
+            #
+            # - `bucket_width=1d`: default: 7, max: 31
+            # - `bucket_width=1h`: default: 24, max: 168
+            # - `bucket_width=1m`: default: 60, max: 1440
+            limit: nil,
+            # Return only usage for these models.
+            models: nil,
+            # A cursor for use in pagination. Corresponding to the `next_page` field from the
+            # previous response.
+            page: nil,
+            # Return only usage for these projects.
+            project_ids: nil,
+            # Return only usage for these users.
+            user_ids: nil,
+            request_options: {}
+          )
+          end
+
           # @api private
           sig { params(client: OpenAI::Client).returns(T.attached_class) }
           def self.new(client:)

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

@@ -25,6 +25,25 @@ module OpenAI
             )
             end
 
+            # Retrieves an organization role assigned to a user.
+            sig do
+              params(
+                role_id: String,
+                user_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Users::RoleRetrieveResponse
+              )
+            end
+            def retrieve(
+              # The ID of the organization role to retrieve for the user.
+              role_id,
+              # The ID of the user to inspect.
+              user_id:,
+              request_options: {}
+            )
+            end
+
             # Lists the organization roles assigned to a user within the organization.
             sig do
               params(

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

@@ -26,6 +26,12 @@ module OpenAI
         sig { returns(OpenAI::Resources::Admin::Organization::Roles) }
         attr_reader :roles
 
+        sig { returns(OpenAI::Resources::Admin::Organization::DataRetention) }
+        attr_reader :data_retention
+
+        sig { returns(OpenAI::Resources::Admin::Organization::SpendAlerts) }
+        attr_reader :spend_alerts
+
         sig { returns(OpenAI::Resources::Admin::Organization::Certificates) }
         attr_reader :certificates
 

data/rbi/openai/resources/conversations/items.rbi

@@ -39,6 +39,7 @@ module OpenAI
                   OpenAI::Responses::ResponseInputItem::McpCall::OrHash,
                   OpenAI::Responses::ResponseCustomToolCallOutput::OrHash,
                   OpenAI::Responses::ResponseCustomToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::CompactionTrigger::OrHash,
                   OpenAI::Responses::ResponseInputItem::ItemReference::OrHash
                 )
               ],

data/rbi/openai/resources/conversations.rbi

@@ -42,6 +42,7 @@ module OpenAI
                   OpenAI::Responses::ResponseInputItem::McpCall::OrHash,
                   OpenAI::Responses::ResponseCustomToolCallOutput::OrHash,
                   OpenAI::Responses::ResponseCustomToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::CompactionTrigger::OrHash,
                   OpenAI::Responses::ResponseInputItem::ItemReference::OrHash
                 )
               ]

data/rbi/openai/resources/responses.rbi

@@ -994,6 +994,10 @@ module OpenAI
             T.nilable(
               OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
             ),
+          service_tier:
+            T.nilable(
+              OpenAI::Responses::ResponseCompactParams::ServiceTier::OrSymbol
+            ),
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Responses::CompactedResponse)
       end
@@ -1020,6 +1024,8 @@ module OpenAI
         prompt_cache_key: nil,
         # How long to retain a prompt cache entry created by this request.
         prompt_cache_retention: nil,
+        # The service tier to use for this request.
+        service_tier: nil,
         request_options: {}
       )
       end

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

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

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

@@ -0,0 +1,47 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type data_retention_update_params =
+          {
+            retention_type: OpenAI::Models::Admin::Organization::DataRetentionUpdateParams::retention_type
+          }
+          & OpenAI::Internal::Type::request_parameters
+
+        class DataRetentionUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor retention_type: OpenAI::Models::Admin::Organization::DataRetentionUpdateParams::retention_type
+
+          def initialize: (
+            retention_type: OpenAI::Models::Admin::Organization::DataRetentionUpdateParams::retention_type,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            retention_type: OpenAI::Models::Admin::Organization::DataRetentionUpdateParams::retention_type,
+            request_options: OpenAI::RequestOptions
+          }
+
+          type retention_type =
+            :zero_data_retention
+            | :modified_abuse_monitoring
+            | :enhanced_zero_data_retention
+            | :enhanced_modified_abuse_monitoring
+
+          module RetentionType
+            extend OpenAI::Internal::Type::Enum
+
+            ZERO_DATA_RETENTION: :zero_data_retention
+            MODIFIED_ABUSE_MONITORING: :modified_abuse_monitoring
+            ENHANCED_ZERO_DATA_RETENTION: :enhanced_zero_data_retention
+            ENHANCED_MODIFIED_ABUSE_MONITORING: :enhanced_modified_abuse_monitoring
+
+            def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::DataRetentionUpdateParams::retention_type]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module OpenAI
           {
             id: String,
             created_at: Integer,
-            group_type: String,
+            group_type: OpenAI::Models::Admin::Organization::Group::group_type,
             is_scim_managed: bool,
             name: String
           }
@@ -16,7 +16,7 @@ module OpenAI
 
           attr_accessor created_at: Integer
 
-          attr_accessor group_type: String
+          attr_accessor group_type: OpenAI::Models::Admin::Organization::Group::group_type
 
           attr_accessor is_scim_managed: bool
 
@@ -25,7 +25,7 @@ module OpenAI
           def initialize: (
             id: String,
             created_at: Integer,
-            group_type: String,
+            group_type: OpenAI::Models::Admin::Organization::Group::group_type,
             is_scim_managed: bool,
             name: String
           ) -> void
@@ -33,10 +33,21 @@ module OpenAI
           def to_hash: -> {
             id: String,
             created_at: Integer,
-            group_type: String,
+            group_type: OpenAI::Models::Admin::Organization::Group::group_type,
             is_scim_managed: bool,
             name: String
           }
+
+          type group_type = :group | :tenant_group
+
+          module GroupType
+            extend OpenAI::Internal::Type::Enum
+
+            GROUP: :group
+            TENANT_GROUP: :tenant_group
+
+            def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::Group::group_type]
+          end
         end
       end
     end

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

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

data/sig/openai/models/admin/organization/groups/role_list_response.rbs

@@ -6,6 +6,7 @@ module OpenAI
           type role_list_response =
             {
               id: String,
+              assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleListResponse::AssignmentSource]?,
               created_at: Integer?,
               created_by: String?,
               created_by_user_obj: ::Hash[Symbol, top]?,
@@ -21,6 +22,8 @@ module OpenAI
           class RoleListResponse < OpenAI::Internal::Type::BaseModel
             attr_accessor id: String
 
+            attr_accessor assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleListResponse::AssignmentSource]?
+
             attr_accessor created_at: Integer?
 
             attr_accessor created_by: String?
@@ -43,6 +46,7 @@ module OpenAI
 
             def initialize: (
               id: String,
+              assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleListResponse::AssignmentSource]?,
               created_at: Integer?,
               created_by: String?,
               created_by_user_obj: ::Hash[Symbol, top]?,
@@ -57,6 +61,7 @@ module OpenAI
 
             def to_hash: -> {
               id: String,
+              assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleListResponse::AssignmentSource]?,
               created_at: Integer?,
               created_by: String?,
               created_by_user_obj: ::Hash[Symbol, top]?,
@@ -68,6 +73,22 @@ module OpenAI
               resource_type: String,
               updated_at: Integer?
             }
+
+            type assignment_source =
+              { principal_id: String, principal_type: String }
+
+            class AssignmentSource < OpenAI::Internal::Type::BaseModel
+              attr_accessor principal_id: String
+
+              attr_accessor principal_type: String
+
+              def initialize: (
+                principal_id: String,
+                principal_type: String
+              ) -> void
+
+              def to_hash: -> { principal_id: String, principal_type: String }
+            end
           end
         end
       end

data/sig/openai/models/admin/organization/groups/role_retrieve_params.rbs

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

data/sig/openai/models/admin/organization/groups/role_retrieve_response.rbs

@@ -0,0 +1,97 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          type role_retrieve_response =
+            {
+              id: String,
+              assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleRetrieveResponse::AssignmentSource]?,
+              created_at: Integer?,
+              created_by: String?,
+              created_by_user_obj: ::Hash[Symbol, top]?,
+              description: String?,
+              metadata: ::Hash[Symbol, top]?,
+              name: String,
+              permissions: ::Array[String],
+              predefined_role: bool,
+              resource_type: String,
+              updated_at: Integer?
+            }
+
+          class RoleRetrieveResponse < OpenAI::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            attr_accessor assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleRetrieveResponse::AssignmentSource]?
+
+            attr_accessor created_at: Integer?
+
+            attr_accessor created_by: String?
+
+            attr_accessor created_by_user_obj: ::Hash[Symbol, top]?
+
+            attr_accessor description: String?
+
+            attr_accessor metadata: ::Hash[Symbol, top]?
+
+            attr_accessor name: String
+
+            attr_accessor permissions: ::Array[String]
+
+            attr_accessor predefined_role: bool
+
+            attr_accessor resource_type: String
+
+            attr_accessor updated_at: Integer?
+
+            def initialize: (
+              id: String,
+              assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleRetrieveResponse::AssignmentSource]?,
+              created_at: Integer?,
+              created_by: String?,
+              created_by_user_obj: ::Hash[Symbol, top]?,
+              description: String?,
+              metadata: ::Hash[Symbol, top]?,
+              name: String,
+              permissions: ::Array[String],
+              predefined_role: bool,
+              resource_type: String,
+              updated_at: Integer?
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Groups::RoleRetrieveResponse::AssignmentSource]?,
+              created_at: Integer?,
+              created_by: String?,
+              created_by_user_obj: ::Hash[Symbol, top]?,
+              description: String?,
+              metadata: ::Hash[Symbol, top]?,
+              name: String,
+              permissions: ::Array[String],
+              predefined_role: bool,
+              resource_type: String,
+              updated_at: Integer?
+            }
+
+            type assignment_source =
+              { principal_id: String, principal_type: String }
+
+            class AssignmentSource < OpenAI::Internal::Type::BaseModel
+              attr_accessor principal_id: String
+
+              attr_accessor principal_type: String
+
+              def initialize: (
+                principal_id: String,
+                principal_type: String
+              ) -> void
+
+              def to_hash: -> { principal_id: String, principal_type: String }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/groups/user_retrieve_params.rbs

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

data/sig/openai/models/admin/organization/groups/user_retrieve_response.rbs

@@ -0,0 +1,62 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          type user_retrieve_response =
+            {
+              id: String,
+              email: String?,
+              is_service_account: bool?,
+              name: String,
+              picture: String?,
+              user_type: OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::user_type
+            }
+
+          class UserRetrieveResponse < OpenAI::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            attr_accessor email: String?
+
+            attr_accessor is_service_account: bool?
+
+            attr_accessor name: String
+
+            attr_accessor picture: String?
+
+            attr_accessor user_type: OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::user_type
+
+            def initialize: (
+              id: String,
+              email: String?,
+              is_service_account: bool?,
+              name: String,
+              picture: String?,
+              user_type: OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::user_type
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              email: String?,
+              is_service_account: bool?,
+              name: String,
+              picture: String?,
+              user_type: OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::user_type
+            }
+
+            type user_type = :user | :tenant_user
+
+            module UserType
+              extend OpenAI::Internal::Type::Enum
+
+              USER: :user
+              TENANT_USER: :tenant_user
+
+              def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::user_type]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module OpenAI
+  module Models
+    module Admin
+      class OrganizationDataRetention = Organization::OrganizationDataRetention
+
+      module Organization
+        type organization_data_retention =
+          {
+            object: :"organization.data_retention",
+            type: OpenAI::Models::Admin::Organization::OrganizationDataRetention::type_
+          }
+
+        class OrganizationDataRetention < OpenAI::Internal::Type::BaseModel
+          attr_accessor object: :"organization.data_retention"
+
+          attr_accessor type: OpenAI::Models::Admin::Organization::OrganizationDataRetention::type_
+
+          def initialize: (
+            type: OpenAI::Models::Admin::Organization::OrganizationDataRetention::type_,
+            ?object: :"organization.data_retention"
+          ) -> void
+
+          def to_hash: -> {
+            object: :"organization.data_retention",
+            type: OpenAI::Models::Admin::Organization::OrganizationDataRetention::type_
+          }
+
+          type type_ =
+            :zero_data_retention
+            | :modified_abuse_monitoring
+            | :enhanced_zero_data_retention
+            | :enhanced_modified_abuse_monitoring
+
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            ZERO_DATA_RETENTION: :zero_data_retention
+            MODIFIED_ABUSE_MONITORING: :modified_abuse_monitoring
+            ENHANCED_ZERO_DATA_RETENTION: :enhanced_zero_data_retention
+            ENHANCED_MODIFIED_ABUSE_MONITORING: :enhanced_modified_abuse_monitoring
+
+            def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::OrganizationDataRetention::type_]
+          end
+        end
+      end
+    end
+  end
+end