openai 0.92.0 → 0.93.0

data/sig/openai/models/admin/organization/projects/project_spend_alert_deleted.rbs

@@ -13,12 +13,21 @@ module OpenAI
             }
 
           class ProjectSpendAlertDeleted < OpenAI::Internal::Type::BaseModel
+            # The deleted spend alert ID.
             attr_accessor id: String
 
+            # Whether the spend alert was deleted.
             attr_accessor deleted: bool
 
+            # Always `project.spend_alert.deleted`.
             attr_accessor object: :"project.spend_alert.deleted"
 
+            # @param id
+            #   The deleted spend alert ID.
+            # @param deleted
+            #   Whether the spend alert was deleted.
+            # @param object
+            #   Always `project.spend_alert.deleted`.
             def initialize: (
               id: String,
               deleted: bool,

data/sig/openai/models/admin/organization/projects/project_spend_limit.rbs

@@ -15,16 +15,33 @@ module OpenAI
             }
 
           class ProjectSpendLimit < OpenAI::Internal::Type::BaseModel
+            # The currency for the threshold amount. Currently, only `USD` is supported.
             attr_accessor currency: OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::currency
 
+            # The current enforcement state of the hard spend limit.
             attr_accessor enforcement: OpenAI::Admin::Organization::Projects::ProjectSpendLimit::Enforcement
 
+            # The time interval for evaluating spend against the threshold. Currently, only
+            # `month` is supported.
             attr_accessor interval: OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::interval
 
+            # The object type, which is always `project.spend_limit`.
             attr_accessor object: :"project.spend_limit"
 
+            # The hard spend limit amount, in cents.
             attr_accessor threshold_amount: Integer
 
+            # @param currency
+            #   The currency for the threshold amount. Currently, only `USD` is supported.
+            # @param enforcement
+            #   The current enforcement state of the hard spend limit.
+            # @param interval
+            #   The time interval for evaluating spend against the threshold. Currently, only
+            #   `month` is supported.
+            # @param threshold_amount
+            #   The hard spend limit amount, in cents.
+            # @param object
+            #   The object type, which is always `project.spend_limit`.
             def initialize: (
               currency: OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::currency,
               enforcement: OpenAI::Admin::Organization::Projects::ProjectSpendLimit::Enforcement,
@@ -57,8 +74,11 @@ module OpenAI
               }
 
             class Enforcement < OpenAI::Internal::Type::BaseModel
+              # Whether the hard spend limit is currently enforcing.
               attr_accessor status: OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Enforcement::status
 
+              # @param status
+              #   Whether the hard spend limit is currently enforcing.
               def initialize: (
                 status: OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit::Enforcement::status
               ) -> void

data/sig/openai/models/admin/organization/projects/project_spend_limit_deleted.rbs

@@ -9,10 +9,16 @@ module OpenAI
             { deleted: bool, ?object: :"project.spend_limit.deleted" }
 
           class ProjectSpendLimitDeleted < OpenAI::Internal::Type::BaseModel
+            # Whether the hard spend limit was deleted.
             attr_accessor deleted: bool
 
+            # The object type, which is always `project.spend_limit.deleted`.
             attr_accessor object: :"project.spend_limit.deleted"
 
+            # @param deleted
+            #   Whether the hard spend limit was deleted.
+            # @param object
+            #   The object type, which is always `project.spend_limit.deleted`.
             def initialize: (
               deleted: bool,
               ?object: :"project.spend_limit.deleted"

data/sig/openai/models/admin/organization/projects/project_user.rbs

@@ -16,18 +16,36 @@ module OpenAI
             }
 
           class ProjectUser < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_accessor id: String
 
+            # The Unix timestamp (in seconds) of when the project was added.
             attr_accessor added_at: Integer
 
+            # The object type, which is always `organization.project.user`
             attr_accessor object: :"organization.project.user"
 
+            # `owner` or `member`
             attr_accessor role: String
 
+            # The email address of the user
             attr_accessor email: String?
 
+            # The name of the user
             attr_accessor name: String?
 
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param added_at
+            #   The Unix timestamp (in seconds) of when the project was added.
+            # @param role
+            #   `owner` or `member`
+            # @param email
+            #   The email address of the user
+            # @param name
+            #   The name of the user
+            # @param object
+            #   The object type, which is always `organization.project.user`
             def initialize: (
               id: String,
               added_at: Integer,

data/sig/openai/models/admin/organization/projects/rate_limit_list_rate_limits_params.rbs

@@ -18,18 +18,48 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # 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.
             attr_reader after: String?
 
+            # 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.
             def after=: (String) -> String
 
+            # A cursor for use in pagination. `before` is an object ID that defines your place
+            # in the list. For instance, if you make a list request and receive 100 objects,
+            # beginning with obj_foo, your subsequent call can include before=obj_foo in order
+            # to fetch the previous page of the list.
             attr_reader before: String?
 
+            # A cursor for use in pagination. `before` is an object ID that defines your place
+            # in the list. For instance, if you make a list request and receive 100 objects,
+            # beginning with obj_foo, your subsequent call can include before=obj_foo in order
+            # to fetch the previous page of the list.
             def before=: (String) -> String
 
+            # A limit on the number of objects to be returned. The default is 100.
             attr_reader limit: Integer?
 
+            # A limit on the number of objects to be returned. The default is 100.
             def limit=: (Integer) -> Integer
 
+            # @param after
+            #   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.
+            # @param before
+            #   A cursor for use in pagination. `before` is an object ID that defines your place
+            #   in the list. For instance, if you make a list request and receive 100 objects,
+            #   beginning with obj_foo, your subsequent call can include before=obj_foo in order
+            #   to fetch the previous page of the list.
+            # @param limit
+            #   A limit on the number of objects to be returned. The default is 100.
             def initialize: (
               project_id: String,
               ?after: String,

data/sig/openai/models/admin/organization/projects/rate_limit_update_rate_limit_params.rbs

@@ -24,30 +24,54 @@ module OpenAI
 
             attr_accessor rate_limit_id: String
 
+            # The maximum batch input tokens per day. Only relevant for certain models.
             attr_reader batch_1_day_max_input_tokens: Integer?
 
+            # The maximum batch input tokens per day. Only relevant for certain models.
             def batch_1_day_max_input_tokens=: (Integer) -> Integer
 
+            # The maximum audio megabytes per minute. Only relevant for certain models.
             attr_reader max_audio_megabytes_per_1_minute: Integer?
 
+            # The maximum audio megabytes per minute. Only relevant for certain models.
             def max_audio_megabytes_per_1_minute=: (Integer) -> Integer
 
+            # The maximum images per minute. Only relevant for certain models.
             attr_reader max_images_per_1_minute: Integer?
 
+            # The maximum images per minute. Only relevant for certain models.
             def max_images_per_1_minute=: (Integer) -> Integer
 
+            # The maximum requests per day. Only relevant for certain models.
             attr_reader max_requests_per_1_day: Integer?
 
+            # The maximum requests per day. Only relevant for certain models.
             def max_requests_per_1_day=: (Integer) -> Integer
 
+            # The maximum requests per minute.
             attr_reader max_requests_per_1_minute: Integer?
 
+            # The maximum requests per minute.
             def max_requests_per_1_minute=: (Integer) -> Integer
 
+            # The maximum tokens per minute.
             attr_reader max_tokens_per_1_minute: Integer?
 
+            # The maximum tokens per minute.
             def max_tokens_per_1_minute=: (Integer) -> Integer
 
+            # @param batch_1_day_max_input_tokens
+            #   The maximum batch input tokens per day. Only relevant for certain models.
+            # @param max_audio_megabytes_per_1_minute
+            #   The maximum audio megabytes per minute. Only relevant for certain models.
+            # @param max_images_per_1_minute
+            #   The maximum images per minute. Only relevant for certain models.
+            # @param max_requests_per_1_day
+            #   The maximum requests per day. Only relevant for certain models.
+            # @param max_requests_per_1_minute
+            #   The maximum requests per minute.
+            # @param max_tokens_per_1_minute
+            #   The maximum tokens per minute.
             def initialize: (
               project_id: String,
               rate_limit_id: String,

data/sig/openai/models/admin/organization/projects/role_create_params.rbs

@@ -18,12 +18,21 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # Permissions to grant to the role.
             attr_accessor permissions: ::Array[String]
 
+            # Unique name for the role.
             attr_accessor role_name: String
 
+            # Optional description of the role.
             attr_accessor description: String?
 
+            # @param permissions
+            #   Permissions to grant to the role.
+            # @param role_name
+            #   Unique name for the role.
+            # @param description
+            #   Optional description of the role.
             def initialize: (
               project_id: String,
               permissions: ::Array[String],

data/sig/openai/models/admin/organization/projects/role_delete_response.rbs

@@ -7,12 +7,21 @@ module OpenAI
             { id: String, deleted: bool, ?object: :"role.deleted" }
 
           class RoleDeleteResponse < OpenAI::Internal::Type::BaseModel
+            # Identifier of the deleted role.
             attr_accessor id: String
 
+            # Whether the role was deleted.
             attr_accessor deleted: bool
 
+            # Always `role.deleted`.
             attr_accessor object: :"role.deleted"
 
+            # @param id
+            #   Identifier of the deleted role.
+            # @param deleted
+            #   Whether the role was deleted.
+            # @param object
+            #   Always `role.deleted`.
             def initialize: (
               id: String,
               deleted: bool,

data/sig/openai/models/admin/organization/projects/role_list_params.rbs

@@ -18,20 +18,35 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # Cursor for pagination. Provide the value from the previous response's `next`
+            # field to continue listing roles.
             attr_reader after: String?
 
+            # Cursor for pagination. Provide the value from the previous response's `next`
+            # field to continue listing roles.
             def after=: (String) -> String
 
+            # A limit on the number of roles to return. Defaults to 1000.
             attr_reader limit: Integer?
 
+            # A limit on the number of roles to return. Defaults to 1000.
             def limit=: (Integer) -> Integer
 
+            # Sort order for the returned roles.
             attr_reader order: OpenAI::Models::Admin::Organization::Projects::RoleListParams::order?
 
+            # Sort order for the returned roles.
             def order=: (
               OpenAI::Models::Admin::Organization::Projects::RoleListParams::order
             ) -> OpenAI::Models::Admin::Organization::Projects::RoleListParams::order
 
+            # @param after
+            #   Cursor for pagination. Provide the value from the previous response's `next`
+            #   field to continue listing roles.
+            # @param limit
+            #   A limit on the number of roles to return. Defaults to 1000.
+            # @param order
+            #   Sort order for the returned roles.
             def initialize: (
               project_id: String,
               ?after: String,

data/sig/openai/models/admin/organization/projects/role_update_params.rbs

@@ -21,12 +21,21 @@ module OpenAI
 
             attr_accessor role_id: String
 
+            # New description for the role.
             attr_accessor description: String?
 
+            # Updated set of permissions for the role.
             attr_accessor permissions: ::Array[String]?
 
+            # New name for the role.
             attr_accessor role_name: String?
 
+            # @param description
+            #   New description for the role.
+            # @param permissions
+            #   Updated set of permissions for the role.
+            # @param role_name
+            #   New name for the role.
             def initialize: (
               project_id: String,
               role_id: String,

data/sig/openai/models/admin/organization/projects/service_account_create_params.rbs

@@ -18,12 +18,29 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # The name of the service account being created.
             attr_accessor name: String
 
+            # Create the service account without default roles or an API key.
             attr_accessor create_service_account_only: bool?
 
+            # Number of seconds until the initial API key expires. If omitted or null, the key
+            # does not expire unless the effective organization or project policy requires an
+            # expiration. When a policy sets a maximum lifetime, this value must be provided
+            # and must not exceed that limit. A non-null value cannot be used when
+            # `create_service_account_only` is true.
             attr_accessor expires_in_seconds: Integer?
 
+            # @param name
+            #   The name of the service account being created.
+            # @param create_service_account_only
+            #   Create the service account without default roles or an API key.
+            # @param expires_in_seconds
+            #   Number of seconds until the initial API key expires. If omitted or null, the key
+            #   does not expire unless the effective organization or project policy requires an
+            #   expiration. When a policy sets a maximum lifetime, this value must be provided
+            #   and must not exceed that limit. A non-null value cannot be used when
+            #   `create_service_account_only` is true.
             def initialize: (
               project_id: String,
               name: String,

data/sig/openai/models/admin/organization/projects/service_account_create_response.rbs

@@ -24,8 +24,13 @@ module OpenAI
 
             attr_accessor object: :"organization.project.service_account"
 
+            # Service accounts created with default project membership have role `member`.
+            # Accounts created with `create_service_account_only` have role `none`.
             attr_accessor role: OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateResponse::role
 
+            # @param role
+            #   Service accounts created with default project membership have role `member`.
+            #   Accounts created with `create_service_account_only` have role `none`.
             def initialize: (
               id: String,
               api_key: OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateResponse::APIKey?,
@@ -61,12 +66,20 @@ module OpenAI
 
               attr_accessor name: String
 
+              # The object type, which is always `organization.project.service_account.api_key`
               attr_accessor object: :"organization.project.service_account.api_key"
 
               attr_accessor value: String
 
+              # The Unix timestamp (in seconds) when the API key expires, or null if it does not
+              # expire.
               attr_accessor expires_at: Integer?
 
+              # @param expires_at
+              #   The Unix timestamp (in seconds) when the API key expires, or null if it does not
+              #   expire.
+              # @param object
+              #   The object type, which is always `organization.project.service_account.api_key`
               def initialize: (
                 id: String,
                 created_at: Integer,

data/sig/openai/models/admin/organization/projects/service_account_list_params.rbs

@@ -17,14 +17,34 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # 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.
             attr_reader after: String?
 
+            # 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.
             def after=: (String) -> String
 
+            # A limit on the number of objects to be returned. Limit can range between 1 and
+            # 100, and the default is 20.
             attr_reader limit: Integer?
 
+            # A limit on the number of objects to be returned. Limit can range between 1 and
+            # 100, and the default is 20.
             def limit=: (Integer) -> Integer
 
+            # @param after
+            #   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.
+            # @param limit
+            #   A limit on the number of objects to be returned. Limit can range between 1 and
+            #   100, and the default is 20.
             def initialize: (
               project_id: String,
               ?after: String,

data/sig/openai/models/admin/organization/projects/service_account_update_params.rbs

@@ -20,16 +20,24 @@ module OpenAI
 
             attr_accessor service_account_id: String
 
+            # The updated service account name.
             attr_reader name: String?
 
+            # The updated service account name.
             def name=: (String) -> String
 
+            # The updated service account role.
             attr_reader role: OpenAI::Models::Admin::Organization::Projects::ServiceAccountUpdateParams::role?
 
+            # The updated service account role.
             def role=: (
               OpenAI::Models::Admin::Organization::Projects::ServiceAccountUpdateParams::role
             ) -> OpenAI::Models::Admin::Organization::Projects::ServiceAccountUpdateParams::role
 
+            # @param name
+            #   The updated service account name.
+            # @param role
+            #   The updated service account role.
             def initialize: (
               project_id: String,
               service_account_id: String,

data/sig/openai/models/admin/organization/projects/service_accounts/api_key_create_params.rbs

@@ -18,20 +18,37 @@ module OpenAI
               extend OpenAI::Internal::Type::RequestParameters::Converter
               include OpenAI::Internal::Type::RequestParameters
 
+              # The ID of the project.
               attr_accessor project_id: String
 
+              # The ID of the service account.
               attr_accessor service_account_id: String
 
+              # Number of seconds until the API key expires.
               attr_accessor expires_in_seconds: Integer?
 
+              # API key name.
               attr_reader name: String?
 
+              # API key name.
               def name=: (String) -> String
 
+              # API key scopes.
               attr_reader scopes: ::Array[String]?
 
+              # API key scopes.
               def scopes=: (::Array[String]) -> ::Array[String]
 
+              # @param project_id
+              #   The ID of the project.
+              # @param service_account_id
+              #   The ID of the service account.
+              # @param expires_in_seconds
+              #   Number of seconds until the API key expires.
+              # @param name
+              #   API key name.
+              # @param scopes
+              #   API key scopes.
               def initialize: (
                 project_id: String,
                 service_account_id: String,

data/sig/openai/models/admin/organization/projects/service_accounts/api_key_create_response.rbs

@@ -15,18 +15,38 @@ module OpenAI
               }
 
             class APIKeyCreateResponse < OpenAI::Internal::Type::BaseModel
+              # The identifier of the API key.
               attr_accessor id: String
 
+              # The Unix timestamp (in seconds) when the API key was created.
               attr_accessor created_at: Integer
 
+              # The name of the API key.
               attr_accessor name: String
 
+              # The object type, which is always `organization.project.service_account.api_key`
               attr_accessor object: :"organization.project.service_account.api_key"
 
+              # The unredacted API key value.
               attr_accessor value: String
 
+              # The Unix timestamp (in seconds) when the API key expires, or null if it does not
+              # expire.
               attr_accessor expires_at: Integer?
 
+              # @param id
+              #   The identifier of the API key.
+              # @param created_at
+              #   The Unix timestamp (in seconds) when the API key was created.
+              # @param name
+              #   The name of the API key.
+              # @param value
+              #   The unredacted API key value.
+              # @param expires_at
+              #   The Unix timestamp (in seconds) when the API key expires, or null if it does not
+              #   expire.
+              # @param object
+              #   The object type, which is always `organization.project.service_account.api_key`
               def initialize: (
                 id: String,
                 created_at: Integer,

data/sig/openai/models/admin/organization/projects/spend_alert_create_params.rbs

@@ -19,14 +19,26 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # The currency for the threshold amount.
             attr_accessor currency: OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::currency
 
+            # The time interval for evaluating spend against the threshold.
             attr_accessor interval: OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::interval
 
+            # Email notification settings for a spend alert.
             attr_accessor notification_channel: OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel
 
+            # The alert threshold amount, in cents.
             attr_accessor threshold_amount: Integer
 
+            # @param currency
+            #   The currency for the threshold amount.
+            # @param interval
+            #   The time interval for evaluating spend against the threshold.
+            # @param notification_channel
+            #   Email notification settings for a spend alert.
+            # @param threshold_amount
+            #   The alert threshold amount, in cents.
             def initialize: (
               project_id: String,
               currency: OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::currency,
@@ -73,12 +85,21 @@ module OpenAI
               }
 
             class NotificationChannel < OpenAI::Internal::Type::BaseModel
+              # Email addresses that receive the spend alert notification.
               attr_accessor recipients: ::Array[String]
 
+              # The notification channel type. Currently only `email` is supported.
               attr_accessor type: :email
 
+              # Optional subject prefix for alert emails.
               attr_accessor subject_prefix: String?
 
+              # @param recipients
+              #   Email addresses that receive the spend alert notification.
+              # @param subject_prefix
+              #   Optional subject prefix for alert emails.
+              # @param type
+              #   The notification channel type. Currently only `email` is supported.
               def initialize: (
                 recipients: ::Array[String],
                 ?subject_prefix: String?,

data/sig/openai/models/admin/organization/projects/spend_alert_list_params.rbs

@@ -19,24 +19,46 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # Cursor for pagination. Provide the ID of the last spend alert from the previous
+            # response to fetch the next page.
             attr_reader after: String?
 
+            # Cursor for pagination. Provide the ID of the last spend alert from the previous
+            # response to fetch the next page.
             def after=: (String) -> String
 
+            # Cursor for pagination. Provide the ID of the first spend alert from the previous
+            # response to fetch the previous page.
             attr_reader before: String?
 
+            # Cursor for pagination. Provide the ID of the first spend alert from the previous
+            # response to fetch the previous page.
             def before=: (String) -> String
 
+            # A limit on the number of spend alerts to return. Defaults to 20.
             attr_reader limit: Integer?
 
+            # A limit on the number of spend alerts to return. Defaults to 20.
             def limit=: (Integer) -> Integer
 
+            # Sort order for the returned spend alerts.
             attr_reader order: OpenAI::Models::Admin::Organization::Projects::SpendAlertListParams::order?
 
+            # Sort order for the returned spend alerts.
             def order=: (
               OpenAI::Models::Admin::Organization::Projects::SpendAlertListParams::order
             ) -> OpenAI::Models::Admin::Organization::Projects::SpendAlertListParams::order
 
+            # @param after
+            #   Cursor for pagination. Provide the ID of the last spend alert from the previous
+            #   response to fetch the next page.
+            # @param before
+            #   Cursor for pagination. Provide the ID of the first spend alert from the previous
+            #   response to fetch the previous page.
+            # @param limit
+            #   A limit on the number of spend alerts to return. Defaults to 20.
+            # @param order
+            #   Sort order for the returned spend alerts.
             def initialize: (
               project_id: String,
               ?after: String,