openai 0.3.0 → 0.4.0.pre.beta.1

data/rbi/openai/models/completion_usage.rbi

@@ -0,0 +1,215 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class CompletionUsage < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::CompletionUsage, OpenAI::Internal::AnyHash)
+        end
+
+      # Number of tokens in the generated completion.
+      sig { returns(Integer) }
+      attr_accessor :completion_tokens
+
+      # Number of tokens in the prompt.
+      sig { returns(Integer) }
+      attr_accessor :prompt_tokens
+
+      # Total number of tokens used in the request (prompt + completion).
+      sig { returns(Integer) }
+      attr_accessor :total_tokens
+
+      # Breakdown of tokens used in a completion.
+      sig do
+        returns(T.nilable(OpenAI::CompletionUsage::CompletionTokensDetails))
+      end
+      attr_reader :completion_tokens_details
+
+      sig do
+        params(
+          completion_tokens_details:
+            OpenAI::CompletionUsage::CompletionTokensDetails::OrHash
+        ).void
+      end
+      attr_writer :completion_tokens_details
+
+      # Breakdown of tokens used in the prompt.
+      sig { returns(T.nilable(OpenAI::CompletionUsage::PromptTokensDetails)) }
+      attr_reader :prompt_tokens_details
+
+      sig do
+        params(
+          prompt_tokens_details:
+            OpenAI::CompletionUsage::PromptTokensDetails::OrHash
+        ).void
+      end
+      attr_writer :prompt_tokens_details
+
+      # Usage statistics for the completion request.
+      sig do
+        params(
+          completion_tokens: Integer,
+          prompt_tokens: Integer,
+          total_tokens: Integer,
+          completion_tokens_details:
+            OpenAI::CompletionUsage::CompletionTokensDetails::OrHash,
+          prompt_tokens_details:
+            OpenAI::CompletionUsage::PromptTokensDetails::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Number of tokens in the generated completion.
+        completion_tokens:,
+        # Number of tokens in the prompt.
+        prompt_tokens:,
+        # Total number of tokens used in the request (prompt + completion).
+        total_tokens:,
+        # Breakdown of tokens used in a completion.
+        completion_tokens_details: nil,
+        # Breakdown of tokens used in the prompt.
+        prompt_tokens_details: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            completion_tokens: Integer,
+            prompt_tokens: Integer,
+            total_tokens: Integer,
+            completion_tokens_details:
+              OpenAI::CompletionUsage::CompletionTokensDetails,
+            prompt_tokens_details: OpenAI::CompletionUsage::PromptTokensDetails
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CompletionTokensDetails < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::CompletionUsage::CompletionTokensDetails,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # When using Predicted Outputs, the number of tokens in the prediction that
+        # appeared in the completion.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :accepted_prediction_tokens
+
+        sig { params(accepted_prediction_tokens: Integer).void }
+        attr_writer :accepted_prediction_tokens
+
+        # Audio input tokens generated by the model.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :audio_tokens
+
+        sig { params(audio_tokens: Integer).void }
+        attr_writer :audio_tokens
+
+        # Tokens generated by the model for reasoning.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :reasoning_tokens
+
+        sig { params(reasoning_tokens: Integer).void }
+        attr_writer :reasoning_tokens
+
+        # When using Predicted Outputs, the number of tokens in the prediction that did
+        # not appear in the completion. However, like reasoning tokens, these tokens are
+        # still counted in the total completion tokens for purposes of billing, output,
+        # and context window limits.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :rejected_prediction_tokens
+
+        sig { params(rejected_prediction_tokens: Integer).void }
+        attr_writer :rejected_prediction_tokens
+
+        # Breakdown of tokens used in a completion.
+        sig do
+          params(
+            accepted_prediction_tokens: Integer,
+            audio_tokens: Integer,
+            reasoning_tokens: Integer,
+            rejected_prediction_tokens: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # When using Predicted Outputs, the number of tokens in the prediction that
+          # appeared in the completion.
+          accepted_prediction_tokens: nil,
+          # Audio input tokens generated by the model.
+          audio_tokens: nil,
+          # Tokens generated by the model for reasoning.
+          reasoning_tokens: nil,
+          # When using Predicted Outputs, the number of tokens in the prediction that did
+          # not appear in the completion. However, like reasoning tokens, these tokens are
+          # still counted in the total completion tokens for purposes of billing, output,
+          # and context window limits.
+          rejected_prediction_tokens: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              accepted_prediction_tokens: Integer,
+              audio_tokens: Integer,
+              reasoning_tokens: Integer,
+              rejected_prediction_tokens: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class PromptTokensDetails < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::CompletionUsage::PromptTokensDetails,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Audio input tokens present in the prompt.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :audio_tokens
+
+        sig { params(audio_tokens: Integer).void }
+        attr_writer :audio_tokens
+
+        # Cached tokens present in the prompt.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :cached_tokens
+
+        sig { params(cached_tokens: Integer).void }
+        attr_writer :cached_tokens
+
+        # Breakdown of tokens used in the prompt.
+        sig do
+          params(audio_tokens: Integer, cached_tokens: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Audio input tokens present in the prompt.
+          audio_tokens: nil,
+          # Cached tokens present in the prompt.
+          cached_tokens: nil
+        )
+        end
+
+        sig do
+          override.returns({ audio_tokens: Integer, cached_tokens: Integer })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/compound_filter.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class CompoundFilter < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::CompoundFilter, OpenAI::Internal::AnyHash)
+        end
+
+      # Array of filters to combine. Items can be `ComparisonFilter` or
+      # `CompoundFilter`.
+      sig { returns(T::Array[T.any(OpenAI::ComparisonFilter, T.anything)]) }
+      attr_accessor :filters
+
+      # Type of operation: `and` or `or`.
+      sig { returns(OpenAI::CompoundFilter::Type::OrSymbol) }
+      attr_accessor :type
+
+      # Combine multiple filters using `and` or `or`.
+      sig do
+        params(
+          filters:
+            T::Array[T.any(OpenAI::ComparisonFilter::OrHash, T.anything)],
+          type: OpenAI::CompoundFilter::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of filters to combine. Items can be `ComparisonFilter` or
+        # `CompoundFilter`.
+        filters:,
+        # Type of operation: `and` or `or`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            filters: T::Array[T.any(OpenAI::ComparisonFilter, T.anything)],
+            type: OpenAI::CompoundFilter::Type::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # A filter used to compare a specified attribute key to a given value using a
+      # defined comparison operation.
+      module Filter
+        extend OpenAI::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(OpenAI::ComparisonFilter, T.anything) }
+
+        sig do
+          override.returns(T::Array[OpenAI::CompoundFilter::Filter::Variants])
+        end
+        def self.variants
+        end
+      end
+
+      # Type of operation: `and` or `or`.
+      module Type
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::CompoundFilter::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AND = T.let(:and, OpenAI::CompoundFilter::Type::TaggedSymbol)
+        OR = T.let(:or, OpenAI::CompoundFilter::Type::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[OpenAI::CompoundFilter::Type::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/container_create_params.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ContainerCreateParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::ContainerCreateParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Name of the container to create.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Container expiration time in seconds relative to the 'anchor' time.
+      sig { returns(T.nilable(OpenAI::ContainerCreateParams::ExpiresAfter)) }
+      attr_reader :expires_after
+
+      sig do
+        params(
+          expires_after: OpenAI::ContainerCreateParams::ExpiresAfter::OrHash
+        ).void
+      end
+      attr_writer :expires_after
+
+      # IDs of files to copy to the container.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :file_ids
+
+      sig { params(file_ids: T::Array[String]).void }
+      attr_writer :file_ids
+
+      sig do
+        params(
+          name: String,
+          expires_after: OpenAI::ContainerCreateParams::ExpiresAfter::OrHash,
+          file_ids: T::Array[String],
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Name of the container to create.
+        name:,
+        # Container expiration time in seconds relative to the 'anchor' time.
+        expires_after: nil,
+        # IDs of files to copy to the container.
+        file_ids: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            expires_after: OpenAI::ContainerCreateParams::ExpiresAfter,
+            file_ids: T::Array[String],
+            request_options: OpenAI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::ContainerCreateParams::ExpiresAfter,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Time anchor for the expiration time. Currently only 'last_active_at' is
+        # supported.
+        sig do
+          returns(OpenAI::ContainerCreateParams::ExpiresAfter::Anchor::OrSymbol)
+        end
+        attr_accessor :anchor
+
+        sig { returns(Integer) }
+        attr_accessor :minutes
+
+        # Container expiration time in seconds relative to the 'anchor' time.
+        sig do
+          params(
+            anchor:
+              OpenAI::ContainerCreateParams::ExpiresAfter::Anchor::OrSymbol,
+            minutes: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Time anchor for the expiration time. Currently only 'last_active_at' is
+          # supported.
+          anchor:,
+          minutes:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              anchor:
+                OpenAI::ContainerCreateParams::ExpiresAfter::Anchor::OrSymbol,
+              minutes: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Time anchor for the expiration time. Currently only 'last_active_at' is
+        # supported.
+        module Anchor
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::ContainerCreateParams::ExpiresAfter::Anchor)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LAST_ACTIVE_AT =
+            T.let(
+              :last_active_at,
+              OpenAI::ContainerCreateParams::ExpiresAfter::Anchor::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::ContainerCreateParams::ExpiresAfter::Anchor::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/container_create_response.rbi

@@ -0,0 +1,192 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ContainerCreateResponse < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            OpenAI::Models::ContainerCreateResponse,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for the container.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Unix timestamp (in seconds) when the container was created.
+      sig { returns(Integer) }
+      attr_accessor :created_at
+
+      # Name of the container.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The type of this object.
+      sig { returns(String) }
+      attr_accessor :object
+
+      # Status of the container (e.g., active, deleted).
+      sig { returns(String) }
+      attr_accessor :status
+
+      # The container will expire after this time period. The anchor is the reference
+      # point for the expiration. The minutes is the number of minutes after the anchor
+      # before the container expires.
+      sig do
+        returns(
+          T.nilable(OpenAI::Models::ContainerCreateResponse::ExpiresAfter)
+        )
+      end
+      attr_reader :expires_after
+
+      sig do
+        params(
+          expires_after:
+            OpenAI::Models::ContainerCreateResponse::ExpiresAfter::OrHash
+        ).void
+      end
+      attr_writer :expires_after
+
+      sig do
+        params(
+          id: String,
+          created_at: Integer,
+          name: String,
+          object: String,
+          status: String,
+          expires_after:
+            OpenAI::Models::ContainerCreateResponse::ExpiresAfter::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the container.
+        id:,
+        # Unix timestamp (in seconds) when the container was created.
+        created_at:,
+        # Name of the container.
+        name:,
+        # The type of this object.
+        object:,
+        # Status of the container (e.g., active, deleted).
+        status:,
+        # The container will expire after this time period. The anchor is the reference
+        # point for the expiration. The minutes is the number of minutes after the anchor
+        # before the container expires.
+        expires_after: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Integer,
+            name: String,
+            object: String,
+            status: String,
+            expires_after: OpenAI::Models::ContainerCreateResponse::ExpiresAfter
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Models::ContainerCreateResponse::ExpiresAfter,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The reference point for the expiration.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :anchor
+
+        sig do
+          params(
+            anchor:
+              OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor::OrSymbol
+          ).void
+        end
+        attr_writer :anchor
+
+        # The number of minutes after the anchor before the container expires.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :minutes
+
+        sig { params(minutes: Integer).void }
+        attr_writer :minutes
+
+        # The container will expire after this time period. The anchor is the reference
+        # point for the expiration. The minutes is the number of minutes after the anchor
+        # before the container expires.
+        sig do
+          params(
+            anchor:
+              OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor::OrSymbol,
+            minutes: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The reference point for the expiration.
+          anchor: nil,
+          # The number of minutes after the anchor before the container expires.
+          minutes: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              anchor:
+                OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor::TaggedSymbol,
+              minutes: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The reference point for the expiration.
+        module Anchor
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LAST_ACTIVE_AT =
+            T.let(
+              :last_active_at,
+              OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Models::ContainerCreateResponse::ExpiresAfter::Anchor::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/container_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ContainerDeleteParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::ContainerDeleteParams, OpenAI::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: OpenAI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end