RubyGems - openai - Versions diffs - 0.92.0 → 0.93.0 - Mend

openai 0.92.0 → 0.93.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1311) hide show

data/sig/openai/models/admin/organization/projects/spend_alert_update_params.rbs CHANGED Viewed

@@ -22,14 +22,26 @@ module OpenAI
             attr_accessor alert_id: String
+            # The currency for the threshold amount.
             attr_accessor currency: OpenAI::Models::Admin::Organization::Projects::SpendAlertUpdateParams::currency
+            # The time interval for evaluating spend against the threshold.
             attr_accessor interval: OpenAI::Models::Admin::Organization::Projects::SpendAlertUpdateParams::interval
+            # Email notification settings for a spend alert.
             attr_accessor notification_channel: OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::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,
               alert_id: String,
@@ -78,12 +90,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_limit_update_params.rbs CHANGED Viewed

@@ -18,12 +18,23 @@ module OpenAI
             attr_accessor project_id: String
+            # The currency for the threshold amount. Currently, only `USD` is supported.
             attr_accessor currency: OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams::currency
+            # The time interval for evaluating spend against the threshold. Currently, only
+            # `month` is supported.
             attr_accessor interval: OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams::interval
+            # 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 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.
             def initialize: (
               project_id: String,
               currency: OpenAI::Models::Admin::Organization::Projects::SpendLimitUpdateParams::currency,

data/sig/openai/models/admin/organization/projects/user_create_params.rbs CHANGED Viewed

@@ -18,12 +18,21 @@ module OpenAI
             attr_accessor project_id: String
+            # `owner` or `member`
             attr_accessor role: String
+            # Email of the user to add.
             attr_accessor email: String?
+            # The ID of the user.
             attr_accessor user_id: String?
+            # @param role
+            #   `owner` or `member`
+            # @param email
+            #   Email of the user to add.
+            # @param user_id
+            #   The ID of the user.
             def initialize: (
               project_id: String,
               role: String,

data/sig/openai/models/admin/organization/projects/user_list_params.rbs CHANGED Viewed

@@ -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/user_update_params.rbs CHANGED Viewed

@@ -19,8 +19,11 @@ module OpenAI
             attr_accessor user_id: String
+            # `owner` or `member`
             attr_accessor role: String?
+            # @param role
+            #   `owner` or `member`
             def initialize: (
               project_id: String,
               user_id: String,

data/sig/openai/models/admin/organization/projects/users/role_create_params.rbs CHANGED Viewed

@@ -20,8 +20,11 @@ module OpenAI
               attr_accessor user_id: String
+              # Identifier of the role to assign.
               attr_accessor role_id: String
+              # @param role_id
+              #   Identifier of the role to assign.
               def initialize: (
                 project_id: String,
                 user_id: String,

data/sig/openai/models/admin/organization/projects/users/role_create_response.rbs CHANGED Viewed

@@ -12,12 +12,21 @@ module OpenAI
               }
             class RoleCreateResponse < OpenAI::Internal::Type::BaseModel
+              # Always `user.role`.
               attr_accessor object: :"user.role"
+              # Details about a role that can be assigned through the public Roles API.
               attr_accessor role: OpenAI::Admin::Organization::Role
+              # Represents an individual `user` within an organization.
               attr_accessor user: OpenAI::Admin::Organization::OrganizationUser
+              # @param role
+              #   Details about a role that can be assigned through the public Roles API.
+              # @param user
+              #   Represents an individual `user` within an organization.
+              # @param object
+              #   Always `user.role`.
               def initialize: (
                 role: OpenAI::Admin::Organization::Role,
                 user: OpenAI::Admin::Organization::OrganizationUser,

data/sig/openai/models/admin/organization/projects/users/role_delete_response.rbs CHANGED Viewed

@@ -7,10 +7,18 @@ module OpenAI
             type role_delete_response = { deleted: bool, object: String }
             class RoleDeleteResponse < OpenAI::Internal::Type::BaseModel
+              # Whether the assignment was removed.
               attr_accessor deleted: bool
+              # Identifier for the deleted assignment, such as `group.role.deleted` or
+              # `user.role.deleted`.
               attr_accessor object: String
+              # @param deleted
+              #   Whether the assignment was removed.
+              # @param object
+              #   Identifier for the deleted assignment, such as `group.role.deleted` or
+              #   `user.role.deleted`.
               def initialize: (deleted: bool, object: String) -> void
               def to_hash: -> { deleted: bool, object: String }

data/sig/openai/models/admin/organization/projects/users/role_list_params.rbs CHANGED Viewed

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

data/sig/openai/models/admin/organization/projects/users/role_list_response.rbs CHANGED Viewed

@@ -21,30 +21,66 @@ module OpenAI
               }
             class RoleListResponse < OpenAI::Internal::Type::BaseModel
+              # Identifier for the role.
               attr_accessor id: String
+              # Principals from which the role assignment is inherited, when available.
               attr_accessor assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Projects::Users::RoleListResponse::AssignmentSource]?
+              # When the role was created.
               attr_accessor created_at: Integer?
+              # Identifier of the actor who created the role.
               attr_accessor created_by: String?
+              # User details for the actor that created the role, when available.
               attr_accessor created_by_user_obj: ::Hash[Symbol, top]?
+              # Description of the role.
               attr_accessor description: String?
+              # Arbitrary metadata stored on the role.
               attr_accessor metadata: ::Hash[Symbol, top]?
+              # Name of the role.
               attr_accessor name: String
+              # Permissions associated with the role.
               attr_accessor permissions: ::Array[String]
+              # Whether the role is predefined by OpenAI.
               attr_accessor predefined_role: bool
+              # Resource type the role applies to.
               attr_accessor resource_type: String
+              # When the role was last updated.
               attr_accessor updated_at: Integer?
+              # @param id
+              #   Identifier for the role.
+              # @param assignment_sources
+              #   Principals from which the role assignment is inherited, when available.
+              # @param created_at
+              #   When the role was created.
+              # @param created_by
+              #   Identifier of the actor who created the role.
+              # @param created_by_user_obj
+              #   User details for the actor that created the role, when available.
+              # @param description
+              #   Description of the role.
+              # @param metadata
+              #   Arbitrary metadata stored on the role.
+              # @param name
+              #   Name of the role.
+              # @param permissions
+              #   Permissions associated with the role.
+              # @param predefined_role
+              #   Whether the role is predefined by OpenAI.
+              # @param resource_type
+              #   Resource type the role applies to.
+              # @param updated_at
+              #   When the role was last updated.
               def initialize: (
                 id: String,
                 assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Projects::Users::RoleListResponse::AssignmentSource]?,

data/sig/openai/models/admin/organization/projects/users/role_retrieve_response.rbs CHANGED Viewed

@@ -21,30 +21,66 @@ module OpenAI
               }
             class RoleRetrieveResponse < OpenAI::Internal::Type::BaseModel
+              # Identifier for the role.
               attr_accessor id: String
+              # Principals from which the role assignment is inherited, when available.
               attr_accessor assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource]?
+              # When the role was created.
               attr_accessor created_at: Integer?
+              # Identifier of the actor who created the role.
               attr_accessor created_by: String?
+              # User details for the actor that created the role, when available.
               attr_accessor created_by_user_obj: ::Hash[Symbol, top]?
+              # Description of the role.
               attr_accessor description: String?
+              # Arbitrary metadata stored on the role.
               attr_accessor metadata: ::Hash[Symbol, top]?
+              # Name of the role.
               attr_accessor name: String
+              # Permissions associated with the role.
               attr_accessor permissions: ::Array[String]
+              # Whether the role is predefined by OpenAI.
               attr_accessor predefined_role: bool
+              # Resource type the role applies to.
               attr_accessor resource_type: String
+              # When the role was last updated.
               attr_accessor updated_at: Integer?
+              # @param id
+              #   Identifier for the role.
+              # @param assignment_sources
+              #   Principals from which the role assignment is inherited, when available.
+              # @param created_at
+              #   When the role was created.
+              # @param created_by
+              #   Identifier of the actor who created the role.
+              # @param created_by_user_obj
+              #   User details for the actor that created the role, when available.
+              # @param description
+              #   Description of the role.
+              # @param metadata
+              #   Arbitrary metadata stored on the role.
+              # @param name
+              #   Name of the role.
+              # @param permissions
+              #   Permissions associated with the role.
+              # @param predefined_role
+              #   Whether the role is predefined by OpenAI.
+              # @param resource_type
+              #   Resource type the role applies to.
+              # @param updated_at
+              #   When the role was last updated.
               def initialize: (
                 id: String,
                 assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource]?,

data/sig/openai/models/admin/organization/role.rbs CHANGED Viewed

@@ -14,20 +14,43 @@ module OpenAI
           }
         class Role < OpenAI::Internal::Type::BaseModel
+          # Identifier for the role.
           attr_accessor id: String
+          # Optional description of the role.
           attr_accessor description: String?
+          # Unique name for the role.
           attr_accessor name: String
+          # Always `role`.
           attr_accessor object: :role
+          # Permissions granted by the role.
           attr_accessor permissions: ::Array[String]
+          # Whether the role is predefined and managed by OpenAI.
           attr_accessor predefined_role: bool
+          # Resource type the role is bound to (for example `api.organization` or
+          # `api.project`).
           attr_accessor resource_type: String
+          # @param id
+          #   Identifier for the role.
+          # @param description
+          #   Optional description of the role.
+          # @param name
+          #   Unique name for the role.
+          # @param permissions
+          #   Permissions granted by the role.
+          # @param predefined_role
+          #   Whether the role is predefined and managed by OpenAI.
+          # @param resource_type
+          #   Resource type the role is bound to (for example `api.organization` or
+          #   `api.project`).
+          # @param object
+          #   Always `role`.
           def initialize: (
             id: String,
             description: String?,

data/sig/openai/models/admin/organization/role_create_params.rbs CHANGED Viewed

@@ -14,12 +14,21 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # 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: (
             permissions: ::Array[String],
             role_name: String,

data/sig/openai/models/admin/organization/role_delete_response.rbs CHANGED Viewed

@@ -6,12 +6,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/role_list_params.rbs CHANGED Viewed

@@ -14,20 +14,35 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # 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::RoleListParams::order?
+          # Sort order for the returned roles.
           def order=: (
             OpenAI::Models::Admin::Organization::RoleListParams::order
           ) -> OpenAI::Models::Admin::Organization::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: (
             ?after: String,
             ?limit: Integer,

data/sig/openai/models/admin/organization/role_update_params.rbs CHANGED Viewed

@@ -17,12 +17,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: (
             role_id: String,
             ?description: String?,

data/sig/openai/models/admin/organization/spend_alert_create_params.rbs CHANGED Viewed

@@ -15,14 +15,26 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # The currency for the threshold amount.
           attr_accessor currency: OpenAI::Models::Admin::Organization::SpendAlertCreateParams::currency
+          # The time interval for evaluating spend against the threshold.
           attr_accessor interval: OpenAI::Models::Admin::Organization::SpendAlertCreateParams::interval
+          # Email notification settings for a spend alert.
           attr_accessor notification_channel: OpenAI::Admin::Organization::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: (
             currency: OpenAI::Models::Admin::Organization::SpendAlertCreateParams::currency,
             interval: OpenAI::Models::Admin::Organization::SpendAlertCreateParams::interval,
@@ -67,12 +79,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/spend_alert_list_params.rbs CHANGED Viewed

@@ -15,24 +15,46 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # 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::SpendAlertListParams::order?
+          # Sort order for the returned spend alerts.
           def order=: (
             OpenAI::Models::Admin::Organization::SpendAlertListParams::order
           ) -> OpenAI::Models::Admin::Organization::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: (
             ?after: String,
             ?before: String,

data/sig/openai/models/admin/organization/spend_alert_update_params.rbs CHANGED Viewed

@@ -18,14 +18,26 @@ module OpenAI
           attr_accessor alert_id: String
+          # The currency for the threshold amount.
           attr_accessor currency: OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::currency
+          # The time interval for evaluating spend against the threshold.
           attr_accessor interval: OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::interval
+          # Email notification settings for a spend alert.
           attr_accessor notification_channel: OpenAI::Admin::Organization::SpendAlertUpdateParams::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: (
             alert_id: String,
             currency: OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::currency,
@@ -72,12 +84,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?,