openai 0.103.0 → 0.104.0

data/rbi/openai/models/responses/response_output_item.rbi

@@ -357,6 +357,13 @@ module OpenAI
           }
           attr_accessor :background
 
+          # Details of a moderation failure, when available.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error)) }
+          attr_reader :error
+
+          sig { params(error: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::OrHash).void }
+          attr_writer :error
+
           # The output format used for generation.
           sig {
             returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol))
@@ -390,6 +397,8 @@ module OpenAI
 
               background: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::OrSymbol),
 
+              error: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::OrHash,
+
               output_format: T.nilable(
                 OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::OrSymbol
               ),
@@ -421,6 +430,9 @@ module OpenAI
             # The background setting used for generation.
             background: nil,
 
+            # Details of a moderation failure, when available.
+            error: nil,
+
             # The output format used for generation.
             output_format: nil,
 
@@ -451,6 +463,7 @@ module OpenAI
                 background: T.nilable(
                   OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::TaggedSymbol
                 ),
+                error: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error,
                 output_format: T.nilable(
                   OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol
                 ),
@@ -548,6 +561,184 @@ module OpenAI
             end
           end
 
+          class Error < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The error code.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :code
+
+            # A description of the error.
+            sig { returns(String) }
+            attr_accessor :message
+
+            # The related request parameter.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :param
+
+            # The error type.
+            sig { returns(String) }
+            attr_accessor :type
+
+            # Public details for a `moderation_blocked` error, when available.
+            sig {
+              returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails))
+            }
+            attr_reader :moderation_details
+
+            sig {
+              params(
+                moderation_details: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::OrHash
+              )
+                .void
+            }
+            attr_writer :moderation_details
+
+            # Details of a moderation failure, when available.
+            sig do
+              params(
+
+                code: T.nilable(String),
+
+                message: String,
+
+                param: T.nilable(String),
+
+                type: String,
+
+                moderation_details: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::OrHash
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The error code.
+              code:,
+
+              # A description of the error.
+              message:,
+
+              # The related request parameter.
+              param:,
+
+              # The error type.
+              type:,
+
+              # Public details for a `moderation_blocked` error, when available.
+
+              moderation_details: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  code: T.nilable(String),
+                  message: String,
+                  param: T.nilable(String),
+                  type: String,
+                  moderation_details: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class ModerationDetails < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              # Public moderation categories. New category values may be added over time.
+              sig { returns(T::Array[String]) }
+              attr_accessor :categories
+
+              # The stage where moderation blocked the image generation call.
+              sig {
+                returns(
+                  OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+              }
+              attr_accessor :moderation_stage
+
+              # Public details for a `moderation_blocked` error, when available.
+              sig do
+                params(
+
+                  categories: T::Array[String],
+
+                  moderation_stage: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::OrSymbol
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # Public moderation categories. New category values may be added over time.
+                categories:,
+
+                # The stage where moderation blocked the image generation call.
+
+                moderation_stage:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    categories: T::Array[String],
+                    moderation_stage: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # The stage where moderation blocked the image generation call.
+              module ModerationStage
+                extend OpenAI::Internal::Type::Enum
+
+                TaggedSymbol = T.type_alias {
+                  T.all(
+                    Symbol,
+                    OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage
+                  )
+                }
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                INPUT = T.let(
+                  :input,
+                  OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+                OUTPUT = T.let(
+                  :output,
+                  OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+                UNKNOWN = T.let(
+                  :unknown,
+                  OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+
+                sig {
+                  override.returns(
+                    T::Array[
+                      OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                    ]
+                  )
+                }
+                def self.values
+                end
+              end
+            end
+          end
+
           # The output format used for generation.
           module OutputFormat
             extend OpenAI::Internal::Type::Enum

data/rbi/openai/models/responses/response_output_text.rbi

@@ -33,10 +33,6 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :text
 
-        # The parsed contents of the output, if JSON schema is specified.
-        sig { returns(T.anything) }
-        attr_accessor :parsed
-
         # The type of the output text. Always `output_text`.
         sig { returns(Symbol) }
         attr_accessor :type

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -231,7 +231,7 @@ module OpenAI
 
           # A stable identifier used to help detect users of your application that may be
           # violating OpenAI's usage policies. The IDs should be a string that uniquely
-          # identifies each user, with a maximum length of 64 characters. We recommend
+          # identifies each user, with a maximum length of 128 characters. We recommend
           # hashing their username or email address, in order to avoid sending us any
           # identifying information.
           # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -728,7 +728,7 @@ module OpenAI
 
             # A stable identifier used to help detect users of your application that may be
             # violating OpenAI's usage policies. The IDs should be a string that uniquely
-            # identifies each user, with a maximum length of 64 characters. We recommend
+            # identifies each user, with a maximum length of 128 characters. We recommend
             # hashing their username or email address, in order to avoid sending us any
             # identifying information.
             # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).

data/rbi/openai/models/safety/safety_alert.rbi

@@ -47,6 +47,11 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :response_id
 
+        # A generated explanation, temporarily available for eligible zero data retention
+        # alerts. Omitted when unavailable.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :detailed_explanation
+
         sig do
           params(
 
@@ -66,6 +71,8 @@ module OpenAI
 
             response_id: String,
 
+            detailed_explanation: T.nilable(String),
+
             object: Symbol
           )
             .returns(T.attached_class)
@@ -92,6 +99,10 @@ module OpenAI
 
           response_id:,
 
+          # A generated explanation, temporarily available for eligible zero data retention
+          # alerts. Omitted when unavailable.
+          detailed_explanation: nil,
+
           object: :"safety.alert"
         )
         end
@@ -107,7 +118,8 @@ module OpenAI
               reason: T.nilable(String),
               request_id: String,
               request_paused: T::Boolean,
-              response_id: String
+              response_id: String,
+              detailed_explanation: T.nilable(String)
             }
           )
         end

data/rbi/openai/models/video_create_error.rbi

@@ -34,6 +34,14 @@ module OpenAI
       sig { params(misalignment: OpenAI::VideoCreateError::Misalignment::OrHash).void }
       attr_writer :misalignment
 
+      # The request parameter associated with the error, or null if none was recorded.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :param
+
+      # The original error type, or null if it was not recorded.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :type
+
       # An error that occurred while generating the response.
       sig do
         params(
@@ -44,7 +52,11 @@ module OpenAI
 
           headers: T::Hash[Symbol, String],
 
-          misalignment: OpenAI::VideoCreateError::Misalignment::OrHash
+          misalignment: OpenAI::VideoCreateError::Misalignment::OrHash,
+
+          param: T.nilable(String),
+
+          type: T.nilable(String)
         )
           .returns(T.attached_class)
       end
@@ -60,7 +72,14 @@ module OpenAI
         # any.
         headers: nil,
 
-        misalignment: nil
+        misalignment: nil,
+
+        # The request parameter associated with the error, or null if none was recorded.
+        param: nil,
+
+        # The original error type, or null if it was not recorded.
+
+        type: nil
       )
       end
 
@@ -70,7 +89,9 @@ module OpenAI
             code: String,
             message: String,
             headers: T::Hash[Symbol, String],
-            misalignment: OpenAI::VideoCreateError::Misalignment
+            misalignment: OpenAI::VideoCreateError::Misalignment,
+            param: T.nilable(String),
+            type: T.nilable(String)
           }
         )
       end

data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi

@@ -12,9 +12,9 @@ module OpenAI
         Variants = T.type_alias do
           T.any(
             OpenAI::Webhooks::AgentEnvironmentExpiredWebhookEvent,
-            OpenAI::Webhooks::AgentEnvironmentSuspendedWebhookEvent,
             OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent,
             OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent,
+            OpenAI::Webhooks::AgentEnvironmentSuspendedWebhookEvent,
             OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent,
             OpenAI::Webhooks::AgentSessionCreatedWebhookEvent,
             OpenAI::Webhooks::AgentSessionFailedWebhookEvent,

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

@@ -16,7 +16,8 @@ module OpenAI
               provider: T.any(
                 OpenAI::Admin::Organization::ExternalStorageCreateParams::Provider::Aws::OrHash,
                 OpenAI::Admin::Organization::ExternalStorageCreateParams::Provider::Azure::OrHash,
-                OpenAI::Admin::Organization::ExternalStorageCreateParams::Provider::Gcp::OrHash
+                OpenAI::Admin::Organization::ExternalStorageCreateParams::Provider::Gcp::OrHash,
+                OpenAI::Admin::Organization::ExternalStorageCreateParams::Provider::Oci::OrHash
               ),
               request_options: OpenAI::RequestOptions::OrHash
             )

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

@@ -26,6 +26,54 @@ module OpenAI
             )
             end
 
+            # Updates the scopes and/or expiration of an existing API key in the project,
+            # including a service-account-owned key. Requires permission to write project API
+            # keys.
+            #
+            # Provide at least one of `scopes` or `expires_in_seconds`. Omitted fields stay
+            # unchanged; neither field accepts `null`. Both changes are saved together.
+            #
+            # `scopes` replaces the key's scope restrictions using the same scope identifiers
+            # as the dashboard. An empty array means All permissions, subject to the owner's
+            # effective access; it does not mean no access. Use `["api.all.read"]` for
+            # read-only access or specific scopes such as `["api.files.read"]` for restricted
+            # access. This does not change user or service-account roles or grant admin
+            # permissions. Scope changes follow the same authentication-cache propagation as
+            # dashboard edits.
+            #
+            # Provide `expires_in_seconds` to set the expiration relative to this request. The
+            # value must satisfy the organization's and project's expiry policies. Expired
+            # keys cannot be updated. Retrying resets the expiration relative to the new
+            # request. The response contains only the redacted key, not its secret.
+            sig {
+              params(
+                api_key_id: String,
+                project_id: String,
+                expires_in_seconds: Integer,
+                scopes: T::Array[String],
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Admin::Organization::Projects::ProjectAPIKey)
+            }
+            def update(
+              # Path param: The ID of the API key.
+              api_key_id,
+              # Path param: The ID of the project.
+              project_id:,
+              # Body param: Number of seconds from this request until the API key expires. Must
+              # comply with the organization and project expiry policies. Expired keys cannot be
+              # updated. Retrying resets the expiry relative to the new request. Omit to keep
+              # the current expiration.
+              expires_in_seconds: nil,
+              # Body param: Replace the API key scope restrictions. Omit to leave scopes
+              # unchanged. An empty array removes key restrictions (All permissions), subject to
+              # the owner's effective permissions. Use ["api.all.read"] for read-only access.
+              # Scopes do not change the owner's roles or grant administrative permissions.
+              scopes: nil,
+              request_options: {}
+            )
+            end
+
             # Returns a list of API keys in the project.
             sig {
               params(

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

@@ -252,6 +252,62 @@ module OpenAI
           )
           end
 
+          # Get Decisions API usage details for the organization.
+          sig {
+            params(
+              start_time: Integer,
+              api_key_ids: T.nilable(T::Array[String]),
+              batch: T.nilable(T::Boolean),
+              bucket_width: T.nilable(OpenAI::Admin::Organization::UsageDecisionsParams::BucketWidth::OrSymbol),
+              end_time: T.nilable(Integer),
+              group_by: T.nilable(T::Array[OpenAI::Admin::Organization::UsageDecisionsParams::GroupBy::OrSymbol]),
+              limit: T.nilable(Integer),
+              models: T.nilable(T::Array[String]),
+              page: T.nilable(String),
+              project_ids: T.nilable(T::Array[String]),
+              user_ids: T.nilable(T::Array[String]),
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Models::Admin::Organization::UsageDecisionsResponse)
+          }
+          def decisions(
+            # Start time (Unix seconds) of the query time range, inclusive.
+            start_time:,
+            # Return only usage for these API keys.
+            api_key_ids: nil,
+            # If `true`, return batch jobs only. If `false`, return non-batch jobs only. By
+            # default, return both.
+            batch: 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`, `model`, `batch`, `service_tier`,
+            # `api_source` or any combination of them. When grouped by `api_source`, results
+            # use `agents_api` for attributed Agents API activity and `unlabeled` for all
+            # other activity. Without source grouping, `api_source` is null.
+            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
+
           # Get embeddings usage details for the organization.
           sig {
             params(

data/rbi/openai/resources/audio/speech.rbi

@@ -41,7 +41,8 @@ module OpenAI
           # 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).
-          # Custom voices must be created from audio samples.
+          # Custom voices must be created from audio samples. Voices created from text
+          # prompts are supported only in Live.
           voice:,
           # Control the voice of your generated audio with additional instructions. Does not
           # work with `tts-1` or `tts-1-hd`.

data/rbi/openai/resources/audio/voices.rbi

@@ -8,20 +8,23 @@ module OpenAI
       # Turn audio into text or text into audio.
       class Voices
 
-        # Create a custom voice you can use for audio output (for example, in
-        # Text-to-Speech and the Realtime API). This requires an audio sample and a
-        # previously uploaded consent recording.
+        # Creates a voice from a text prompt or from a consent recording and an audio
+        # sample.
         #
-        # Send `name`, `audio_sample`, and the `consent` recording ID as multipart form
-        # data. The optional `type` defaults to `audio_sample`.
+        # For prompt-based creation, send `type: "prompt"` with a `name` and `prompt` as
+        # JSON or multipart form data. For creation from an audio sample, send
+        # `type: "audio_sample"` with a `name`, `audio_sample`, and `consent` recording ID
+        # as multipart form data. The type defaults to `audio_sample` when omitted.
         #
-        # Returns the saved voice's metadata. See the
-        # [custom voices guide](https://developers.openai.com/api/docs/guides/text-to-speech#custom-voices)
-        # for requirements and best practices. Custom voices are limited to eligible
-        # customers.
+        # Returns the saved voice's metadata. Voices created from text prompts are
+        # supported only in Live, not in Realtime or the speech endpoint. The response
+        # does not include preview audio.
         sig {
           params(
-            body: OpenAI::Audio::VoiceCreateParams::Body::AudioSample::OrHash,
+            body: T.any(
+              OpenAI::Audio::VoiceCreateParams::Body::AudioSample::OrHash,
+              OpenAI::Audio::VoiceCreateParams::Body::Prompt::OrHash
+            ),
             request_options: OpenAI::RequestOptions::OrHash
           )
             .returns(OpenAI::Audio::Voice)

data/rbi/openai/resources/beta/agents/environments/files.rbi

@@ -10,40 +10,10 @@ module OpenAI
         class Environments
 
           class Files
-            # Beta file helpers.
-            sig {
-              params(files: T::Hash[String, T.any(String, Pathname)], request_options: OpenAI::RequestOptions::OrHash)
-                .returns(OpenAI::Helpers::Beta::Agents::PreparedFiles)
-            }
-            def prepare(files, request_options: {})
-            end
-
-            sig {
-              params(
-                directory: T.any(String, Pathname),
-                destination: String,
-                include: T::Array[String],
-                request_options: OpenAI::RequestOptions::OrHash
-              )
-                .returns(OpenAI::Helpers::Beta::Agents::PreparedFiles)
-            }
-            def prepare_directory(directory, destination:, include:, request_options: {})
-            end
-
-            sig {
-              params(
-                environment_id: String,
-                file: T.any(String, Pathname),
-                path: String,
-                request_options: OpenAI::RequestOptions::OrHash
-              )
-                .returns(OpenAI::Helpers::Beta::Agents::PreparedFiles)
-            }
-            def upload(environment_id, file:, path:, request_options: {})
-            end
 
-            # Copies inline bytes or a Files API file into a connected execution environment.
-            # See
+            # Copies inline bytes or a Files API file into a connected execution environment,
+            # replacing an existing regular file at the same path. Upload between turns and
+            # wait for success before starting the next turn. See
             # [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).
             sig {
               params(

data/rbi/openai/resources/beta/agents/environments.rbi

@@ -71,11 +71,11 @@ module OpenAI
               .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::EnvironmentInfo])
           }
           def list(
-            # Return environments after this environment ID in the selected order.
+            # Return resources after this resource ID in the selected order.
             after: nil,
-            # The maximum number of environments to return, between 1 and 100. Defaults to 20.
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             limit: nil,
-            # The order in which environments are returned. Defaults to `desc`.
+            # The order in which resources are returned. Defaults to `desc`.
             order: nil,
             # The hosting type to list. Defaults to `openai_hosted`.
             type: nil,

data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi

@@ -10,14 +10,6 @@ module OpenAI
         class Sessions
 
           class Artifacts
-            # Beta result-scoped downloads.
-            sig {
-              params(result: OpenAI::Helpers::Beta::Agents::TurnResult).returns(
-                OpenAI::Helpers::Beta::Agents::ResultArtifacts
-              )
-            }
-            def for_result(result)
-            end
 
             # Retrieves immutable metadata for one durable session artifact. See
             # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
@@ -40,9 +32,9 @@ module OpenAI
             sig {
               params(
                 session_id: String,
-                after: T.nilable(String),
+                after: String,
                 environment_id: T.nilable(String),
-                limit: T.nilable(Integer),
+                limit: Integer,
                 order: OpenAI::Beta::Agents::Sessions::ArtifactListParams::Order::OrSymbol,
                 request_options: OpenAI::RequestOptions::OrHash
               )
@@ -51,13 +43,13 @@ module OpenAI
             def list(
               # The ID of the session.
               session_id,
-              # Return artifacts after this immutable artifact ID.
+              # Return resources after this resource ID in the selected order.
               after: nil,
               # Restrict the listing to artifacts produced by this environment.
               environment_id: nil,
-              # The maximum number of artifacts to return, between 1 and 100.
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
               limit: nil,
-              # Sort by creation time and ID. Defaults to descending.
+              # The order in which resources are returned. Defaults to `desc`.
               order: nil,
               request_options: {}
             )