openai 0.63.0 → 0.65.0

data/rbi/openai/models/admin/organization/spend_alert_update_params.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class SpendAlertUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::SpendAlertUpdateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :alert_id
+
+          # The currency for the threshold amount.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendAlertUpdateParams::Currency::OrSymbol
+            )
+          end
+          attr_accessor :currency
+
+          # The time interval for evaluating spend against the threshold.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendAlertUpdateParams::Interval::OrSymbol
+            )
+          end
+          attr_accessor :interval
+
+          # Email notification settings for a spend alert.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendAlertUpdateParams::NotificationChannel
+            )
+          end
+          attr_reader :notification_channel
+
+          sig do
+            params(
+              notification_channel:
+                OpenAI::Admin::Organization::SpendAlertUpdateParams::NotificationChannel::OrHash
+            ).void
+          end
+          attr_writer :notification_channel
+
+          # The alert threshold amount, in cents.
+          sig { returns(Integer) }
+          attr_accessor :threshold_amount
+
+          sig do
+            params(
+              alert_id: String,
+              currency:
+                OpenAI::Admin::Organization::SpendAlertUpdateParams::Currency::OrSymbol,
+              interval:
+                OpenAI::Admin::Organization::SpendAlertUpdateParams::Interval::OrSymbol,
+              notification_channel:
+                OpenAI::Admin::Organization::SpendAlertUpdateParams::NotificationChannel::OrHash,
+              threshold_amount: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            alert_id:,
+            # The currency for the threshold amount.
+            currency:,
+            # The time interval for evaluating spend against the threshold.
+            interval:,
+            # Email notification settings for a spend alert.
+            notification_channel:,
+            # The alert threshold amount, in cents.
+            threshold_amount:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                alert_id: String,
+                currency:
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::Currency::OrSymbol,
+                interval:
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::Interval::OrSymbol,
+                notification_channel:
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::NotificationChannel,
+                threshold_amount: Integer,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The currency for the threshold amount.
+          module Currency
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::Currency
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USD =
+              T.let(
+                :USD,
+                OpenAI::Admin::Organization::SpendAlertUpdateParams::Currency::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::Currency::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The time interval for evaluating spend against the threshold.
+          module Interval
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::Interval
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MONTH =
+              T.let(
+                :month,
+                OpenAI::Admin::Organization::SpendAlertUpdateParams::Interval::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::Interval::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class NotificationChannel < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::SpendAlertUpdateParams::NotificationChannel,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Email addresses that receive the spend alert notification.
+            sig { returns(T::Array[String]) }
+            attr_accessor :recipients
+
+            # The notification channel type. Currently only `email` is supported.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Optional subject prefix for alert emails.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :subject_prefix
+
+            # Email notification settings for a spend alert.
+            sig do
+              params(
+                recipients: T::Array[String],
+                subject_prefix: T.nilable(String),
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Email addresses that receive the spend alert notification.
+              recipients:,
+              # Optional subject prefix for alert emails.
+              subject_prefix: nil,
+              # The notification channel type. Currently only `email` is supported.
+              type: :email
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  recipients: T::Array[String],
+                  type: Symbol,
+                  subject_prefix: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi

@@ -102,6 +102,8 @@ module OpenAI
                       OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageVectorStoresResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult::OrHash,
+                      OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageFileSearchesResult::OrHash,
+                      OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageWebSearchesResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationCostsResult::OrHash
                     )
                   ],
@@ -143,6 +145,8 @@ module OpenAI
                     OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult,
                     OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageVectorStoresResult,
                     OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult,
+                    OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageFileSearchesResult,
+                    OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageWebSearchesResult,
                     OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationCostsResult
                   )
                 end
@@ -881,6 +885,188 @@ module OpenAI
                 end
               end
 
+              class OrganizationUsageFileSearchesResult < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageFileSearchesResult,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # The count of file search calls.
+                sig { returns(Integer) }
+                attr_accessor :num_requests
+
+                sig { returns(Symbol) }
+                attr_accessor :object
+
+                # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :api_key_id
+
+                # When `group_by=project_id`, this field provides the project ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :project_id
+
+                # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                # result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :user_id
+
+                # When `group_by=vector_store_id`, this field provides the vector store ID of the
+                # grouped usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :vector_store_id
+
+                # The aggregated file search calls usage details of the specific time bucket.
+                sig do
+                  params(
+                    num_requests: Integer,
+                    api_key_id: T.nilable(String),
+                    project_id: T.nilable(String),
+                    user_id: T.nilable(String),
+                    vector_store_id: T.nilable(String),
+                    object: Symbol
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # The count of file search calls.
+                  num_requests:,
+                  # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                  # usage result.
+                  api_key_id: nil,
+                  # When `group_by=project_id`, this field provides the project ID of the grouped
+                  # usage result.
+                  project_id: nil,
+                  # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                  # result.
+                  user_id: nil,
+                  # When `group_by=vector_store_id`, this field provides the vector store ID of the
+                  # grouped usage result.
+                  vector_store_id: nil,
+                  object: :"organization.usage.file_searches.result"
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      num_requests: Integer,
+                      object: Symbol,
+                      api_key_id: T.nilable(String),
+                      project_id: T.nilable(String),
+                      user_id: T.nilable(String),
+                      vector_store_id: T.nilable(String)
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
+
+              class OrganizationUsageWebSearchesResult < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Models::Admin::Organization::UsageAudioSpeechesResponse::Data::Result::OrganizationUsageWebSearchesResult,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # The count of model requests.
+                sig { returns(Integer) }
+                attr_accessor :num_model_requests
+
+                # The count of web search calls.
+                sig { returns(Integer) }
+                attr_accessor :num_requests
+
+                sig { returns(Symbol) }
+                attr_accessor :object
+
+                # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :api_key_id
+
+                # When `group_by=context_level`, this field provides the search context size of
+                # the grouped usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :context_level
+
+                # When `group_by=model`, this field provides the model name of the grouped usage
+                # result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :model
+
+                # When `group_by=project_id`, this field provides the project ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :project_id
+
+                # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                # result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :user_id
+
+                # The aggregated web search calls usage details of the specific time bucket.
+                sig do
+                  params(
+                    num_model_requests: Integer,
+                    num_requests: Integer,
+                    api_key_id: T.nilable(String),
+                    context_level: T.nilable(String),
+                    model: T.nilable(String),
+                    project_id: T.nilable(String),
+                    user_id: T.nilable(String),
+                    object: Symbol
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # The count of model requests.
+                  num_model_requests:,
+                  # The count of web search calls.
+                  num_requests:,
+                  # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                  # usage result.
+                  api_key_id: nil,
+                  # When `group_by=context_level`, this field provides the search context size of
+                  # the grouped usage result.
+                  context_level: nil,
+                  # When `group_by=model`, this field provides the model name of the grouped usage
+                  # result.
+                  model: nil,
+                  # When `group_by=project_id`, this field provides the project ID of the grouped
+                  # usage result.
+                  project_id: nil,
+                  # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                  # result.
+                  user_id: nil,
+                  object: :"organization.usage.web_searches.result"
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      num_model_requests: Integer,
+                      num_requests: Integer,
+                      object: Symbol,
+                      api_key_id: T.nilable(String),
+                      context_level: T.nilable(String),
+                      model: T.nilable(String),
+                      project_id: T.nilable(String),
+                      user_id: T.nilable(String)
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
+
               class OrganizationCostsResult < OpenAI::Internal::Type::BaseModel
                 OrHash =
                   T.type_alias do

data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi

@@ -102,6 +102,8 @@ module OpenAI
                       OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageVectorStoresResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult::OrHash,
+                      OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageFileSearchesResult::OrHash,
+                      OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageWebSearchesResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationCostsResult::OrHash
                     )
                   ],
@@ -143,6 +145,8 @@ module OpenAI
                     OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult,
                     OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageVectorStoresResult,
                     OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult,
+                    OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageFileSearchesResult,
+                    OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageWebSearchesResult,
                     OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationCostsResult
                   )
                 end
@@ -881,6 +885,188 @@ module OpenAI
                 end
               end
 
+              class OrganizationUsageFileSearchesResult < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageFileSearchesResult,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # The count of file search calls.
+                sig { returns(Integer) }
+                attr_accessor :num_requests
+
+                sig { returns(Symbol) }
+                attr_accessor :object
+
+                # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :api_key_id
+
+                # When `group_by=project_id`, this field provides the project ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :project_id
+
+                # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                # result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :user_id
+
+                # When `group_by=vector_store_id`, this field provides the vector store ID of the
+                # grouped usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :vector_store_id
+
+                # The aggregated file search calls usage details of the specific time bucket.
+                sig do
+                  params(
+                    num_requests: Integer,
+                    api_key_id: T.nilable(String),
+                    project_id: T.nilable(String),
+                    user_id: T.nilable(String),
+                    vector_store_id: T.nilable(String),
+                    object: Symbol
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # The count of file search calls.
+                  num_requests:,
+                  # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                  # usage result.
+                  api_key_id: nil,
+                  # When `group_by=project_id`, this field provides the project ID of the grouped
+                  # usage result.
+                  project_id: nil,
+                  # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                  # result.
+                  user_id: nil,
+                  # When `group_by=vector_store_id`, this field provides the vector store ID of the
+                  # grouped usage result.
+                  vector_store_id: nil,
+                  object: :"organization.usage.file_searches.result"
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      num_requests: Integer,
+                      object: Symbol,
+                      api_key_id: T.nilable(String),
+                      project_id: T.nilable(String),
+                      user_id: T.nilable(String),
+                      vector_store_id: T.nilable(String)
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
+
+              class OrganizationUsageWebSearchesResult < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Models::Admin::Organization::UsageAudioTranscriptionsResponse::Data::Result::OrganizationUsageWebSearchesResult,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # The count of model requests.
+                sig { returns(Integer) }
+                attr_accessor :num_model_requests
+
+                # The count of web search calls.
+                sig { returns(Integer) }
+                attr_accessor :num_requests
+
+                sig { returns(Symbol) }
+                attr_accessor :object
+
+                # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :api_key_id
+
+                # When `group_by=context_level`, this field provides the search context size of
+                # the grouped usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :context_level
+
+                # When `group_by=model`, this field provides the model name of the grouped usage
+                # result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :model
+
+                # When `group_by=project_id`, this field provides the project ID of the grouped
+                # usage result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :project_id
+
+                # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                # result.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :user_id
+
+                # The aggregated web search calls usage details of the specific time bucket.
+                sig do
+                  params(
+                    num_model_requests: Integer,
+                    num_requests: Integer,
+                    api_key_id: T.nilable(String),
+                    context_level: T.nilable(String),
+                    model: T.nilable(String),
+                    project_id: T.nilable(String),
+                    user_id: T.nilable(String),
+                    object: Symbol
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # The count of model requests.
+                  num_model_requests:,
+                  # The count of web search calls.
+                  num_requests:,
+                  # When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                  # usage result.
+                  api_key_id: nil,
+                  # When `group_by=context_level`, this field provides the search context size of
+                  # the grouped usage result.
+                  context_level: nil,
+                  # When `group_by=model`, this field provides the model name of the grouped usage
+                  # result.
+                  model: nil,
+                  # When `group_by=project_id`, this field provides the project ID of the grouped
+                  # usage result.
+                  project_id: nil,
+                  # When `group_by=user_id`, this field provides the user ID of the grouped usage
+                  # result.
+                  user_id: nil,
+                  object: :"organization.usage.web_searches.result"
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      num_model_requests: Integer,
+                      num_requests: Integer,
+                      object: Symbol,
+                      api_key_id: T.nilable(String),
+                      context_level: T.nilable(String),
+                      model: T.nilable(String),
+                      project_id: T.nilable(String),
+                      user_id: T.nilable(String)
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
+
               class OrganizationCostsResult < OpenAI::Internal::Type::BaseModel
                 OrHash =
                   T.type_alias do