openai 0.92.0 → 0.93.0

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

@@ -18,14 +18,26 @@ module OpenAI
 
           attr_accessor user_id: String
 
+          # Developer persona metadata.
           attr_accessor developer_persona: String?
 
+          # `owner` or `reader`
           attr_accessor role: String?
 
+          # Role ID to assign to the user.
           attr_accessor role_id: String?
 
+          # Technical level metadata.
           attr_accessor technical_level: String?
 
+          # @param developer_persona
+          #   Developer persona metadata.
+          # @param role
+          #   `owner` or `reader`
+          # @param role_id
+          #   Role ID to assign to the user.
+          # @param technical_level
+          #   Technical level metadata.
           def initialize: (
             user_id: String,
             ?developer_persona: String?,

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

@@ -16,8 +16,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: (
               user_id: String,
               role_id: String,

data/sig/openai/models/admin/organization/users/role_create_response.rbs

@@ -11,12 +11,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/users/role_delete_response.rbs

@@ -6,10 +6,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/users/role_list_params.rbs

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

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

@@ -20,30 +20,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::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::Users::RoleListResponse::AssignmentSource]?,

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

@@ -20,30 +20,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::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::Users::RoleRetrieveResponse::AssignmentSource]?,

data/sig/openai/models/audio/speech_create_params.rbs

@@ -17,32 +17,83 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        # The text to generate audio for. The maximum length is 4096 characters.
         attr_accessor input: String
 
+        # One of the available
+        # [TTS models](https://developers.openai.com/api/docs/guides/text-to-speech):
+        # `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.
         attr_accessor model: OpenAI::Models::Audio::SpeechCreateParams::model
 
+        # The voice to use when generating the audio. Supported built-in voices are
+        # `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
+        # `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+        # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+        # voices are available in the
+        # [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
         attr_accessor voice: OpenAI::Models::Audio::SpeechCreateParams::voice
 
+        # Control the voice of your generated audio with additional instructions. Does not
+        # work with `tts-1` or `tts-1-hd`.
         attr_reader instructions: String?
 
+        # Control the voice of your generated audio with additional instructions. Does not
+        # work with `tts-1` or `tts-1-hd`.
         def instructions=: (String) -> String
 
+        # The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`,
+        # `wav`, and `pcm`.
         attr_reader response_format: OpenAI::Models::Audio::SpeechCreateParams::response_format?
 
+        # The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`,
+        # `wav`, and `pcm`.
         def response_format=: (
           OpenAI::Models::Audio::SpeechCreateParams::response_format
         ) -> OpenAI::Models::Audio::SpeechCreateParams::response_format
 
+        # The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
+        # the default.
         attr_reader speed: Float?
 
+        # The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
+        # the default.
         def speed=: (Float) -> Float
 
+        # The format to stream the audio in. Supported formats are `sse` and `audio`.
+        # `sse` is not supported for `tts-1` or `tts-1-hd`.
         attr_reader stream_format: OpenAI::Models::Audio::SpeechCreateParams::stream_format?
 
+        # The format to stream the audio in. Supported formats are `sse` and `audio`.
+        # `sse` is not supported for `tts-1` or `tts-1-hd`.
         def stream_format=: (
           OpenAI::Models::Audio::SpeechCreateParams::stream_format
         ) -> OpenAI::Models::Audio::SpeechCreateParams::stream_format
 
+        # @param input
+        #   The text to generate audio for. The maximum length is 4096 characters.
+        # @param model
+        #   One of the available
+        #   [TTS models](https://developers.openai.com/api/docs/guides/text-to-speech):
+        #   `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.
+        # @param voice
+        #   The voice to use when generating the audio. Supported built-in voices are
+        #   `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
+        #   `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+        #   object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+        #   voices are available in the
+        #   [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
+        # @param instructions
+        #   Control the voice of your generated audio with additional instructions. Does not
+        #   work with `tts-1` or `tts-1-hd`.
+        # @param response_format
+        #   The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`,
+        #   `wav`, and `pcm`.
+        # @param speed
+        #   The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
+        #   the default.
+        # @param stream_format
+        #   The format to stream the audio in. Supported formats are `sse` and `audio`.
+        #   `sse` is not supported for `tts-1` or `tts-1-hd`.
         def initialize: (
           input: String,
           model: OpenAI::Models::Audio::SpeechCreateParams::model,
@@ -93,8 +144,11 @@ module OpenAI
           type id = { id: String }
 
           class ID < OpenAI::Internal::Type::BaseModel
+            # The custom voice ID, e.g. `voice_1234`.
             attr_accessor id: String
 
+            # @param id
+            #   The custom voice ID, e.g. `voice_1234`.
             def initialize: (id: String) -> void
 
             def to_hash: -> { id: String }

data/sig/openai/models/audio/transcription.rbs

@@ -10,26 +10,50 @@ module OpenAI
         }
 
       class Transcription < OpenAI::Internal::Type::BaseModel
+        # The transcribed text.
         attr_accessor text: String
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
         attr_reader languages: ::Array[OpenAI::Audio::TranscriptionLanguage]?
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
         def languages=: (
           ::Array[OpenAI::Audio::TranscriptionLanguage]
         ) -> ::Array[OpenAI::Audio::TranscriptionLanguage]
 
+        # The log probabilities of the tokens in the transcription. Only returned with the
+        # models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added
+        # to the `include` array.
         attr_reader logprobs: ::Array[OpenAI::Audio::Transcription::Logprob]?
 
+        # The log probabilities of the tokens in the transcription. Only returned with the
+        # models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added
+        # to the `include` array.
         def logprobs=: (
           ::Array[OpenAI::Audio::Transcription::Logprob]
         ) -> ::Array[OpenAI::Audio::Transcription::Logprob]
 
+        # Token usage statistics for the request.
         attr_reader usage: OpenAI::Models::Audio::Transcription::usage?
 
+        # Token usage statistics for the request.
         def usage=: (
           OpenAI::Models::Audio::Transcription::usage
         ) -> OpenAI::Models::Audio::Transcription::usage
 
+        # @param text
+        #   The transcribed text.
+        # @param languages
+        #   The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        #   array indicates that no language could be reliably detected.
+        # @param logprobs
+        #   The log probabilities of the tokens in the transcription. Only returned with the
+        #   models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added
+        #   to the `include` array.
+        # @param usage
+        #   Token usage statistics for the request.
         def initialize: (
           text: String,
           ?languages: ::Array[OpenAI::Audio::TranscriptionLanguage],
@@ -48,18 +72,30 @@ module OpenAI
           { ?token: String, ?bytes: ::Array[Float], ?logprob: Float }
 
         class Logprob < OpenAI::Internal::Type::BaseModel
+          # The token in the transcription.
           attr_reader token: String?
 
+          # The token in the transcription.
           def token=: (String) -> String
 
+          # The bytes of the token.
           attr_reader bytes: ::Array[Float]?
 
+          # The bytes of the token.
           def bytes=: (::Array[Float]) -> ::Array[Float]
 
+          # The log probability of the token.
           attr_reader logprob: Float?
 
+          # The log probability of the token.
           def logprob=: (Float) -> Float
 
+          # @param token
+          #   The token in the transcription.
+          # @param bytes
+          #   The bytes of the token.
+          # @param logprob
+          #   The log probability of the token.
           def initialize: (
             ?token: String,
             ?bytes: ::Array[Float],
@@ -90,20 +126,36 @@ module OpenAI
             }
 
           class Tokens < OpenAI::Internal::Type::BaseModel
+            # Number of input tokens billed for this request.
             attr_accessor input_tokens: Integer
 
+            # Number of output tokens generated.
             attr_accessor output_tokens: Integer
 
+            # Total number of tokens used (input + output).
             attr_accessor total_tokens: Integer
 
+            # The type of the usage object. Always `tokens` for this variant.
             attr_accessor type: :tokens
 
+            # Details about the input tokens billed for this request.
             attr_reader input_token_details: OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails?
 
+            # Details about the input tokens billed for this request.
             def input_token_details=: (
               OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
             ) -> OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
 
+            # @param input_tokens
+            #   Number of input tokens billed for this request.
+            # @param output_tokens
+            #   Number of output tokens generated.
+            # @param total_tokens
+            #   Total number of tokens used (input + output).
+            # @param input_token_details
+            #   Details about the input tokens billed for this request.
+            # @param type
+            #   The type of the usage object. Always `tokens` for this variant.
             def initialize: (
               input_tokens: Integer,
               output_tokens: Integer,
@@ -124,14 +176,22 @@ module OpenAI
               { ?audio_tokens: Integer, ?text_tokens: Integer }
 
             class InputTokenDetails < OpenAI::Internal::Type::BaseModel
+              # Number of audio tokens billed for this request.
               attr_reader audio_tokens: Integer?
 
+              # Number of audio tokens billed for this request.
               def audio_tokens=: (Integer) -> Integer
 
+              # Number of text tokens billed for this request.
               attr_reader text_tokens: Integer?
 
+              # Number of text tokens billed for this request.
               def text_tokens=: (Integer) -> Integer
 
+              # @param audio_tokens
+              #   Number of audio tokens billed for this request.
+              # @param text_tokens
+              #   Number of text tokens billed for this request.
               def initialize: (
                 ?audio_tokens: Integer,
                 ?text_tokens: Integer
@@ -144,10 +204,16 @@ module OpenAI
           type duration = { seconds: Float, ?type: :duration }
 
           class Duration < OpenAI::Internal::Type::BaseModel
+            # Duration of the input audio in seconds.
             attr_accessor seconds: Float
 
+            # The type of the usage object. Always `duration` for this variant.
             attr_accessor type: :duration
 
+            # @param seconds
+            #   Duration of the input audio in seconds.
+            # @param type
+            #   The type of the usage object. Always `duration` for this variant.
             def initialize: (seconds: Float, ?type: :duration) -> void
 
             def to_hash: -> { seconds: Float, ?type: :duration }