openai 0.63.0 → 0.65.0

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

@@ -102,6 +102,8 @@ module OpenAI
                       OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageVectorStoresResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult::OrHash,
+                      OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageFileSearchesResult::OrHash,
+                      OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageWebSearchesResult::OrHash,
                       OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationCostsResult::OrHash
                     )
                   ],
@@ -143,6 +145,8 @@ module OpenAI
                     OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult,
                     OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageVectorStoresResult,
                     OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult,
+                    OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageFileSearchesResult,
+                    OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageWebSearchesResult,
                     OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::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::UsageEmbeddingsResponse::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::UsageEmbeddingsResponse::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_file_search_calls_params.rbi

@@ -0,0 +1,284 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class UsageFileSearchCallsParams < 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::UsageFileSearchCallsParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Start time (Unix seconds) of the query time range, inclusive.
+          sig { returns(Integer) }
+          attr_accessor :start_time
+
+          # Return only usage for these API keys.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :api_key_ids
+
+          sig { params(api_key_ids: T::Array[String]).void }
+          attr_writer :api_key_ids
+
+          # Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+          # supported, default to `1d`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::OrSymbol
+              )
+            )
+          end
+          attr_reader :bucket_width
+
+          sig do
+            params(
+              bucket_width:
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::OrSymbol
+            ).void
+          end
+          attr_writer :bucket_width
+
+          # End time (Unix seconds) of the query time range, exclusive.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :end_time
+
+          sig { params(end_time: Integer).void }
+          attr_writer :end_time
+
+          # Group the usage data by the specified fields. Support fields include
+          # `project_id`, `user_id`, `api_key_id`, `vector_store_id` or any combination of
+          # them.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::OrSymbol
+                ]
+              )
+            )
+          end
+          attr_reader :group_by
+
+          sig do
+            params(
+              group_by:
+                T::Array[
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::OrSymbol
+                ]
+            ).void
+          end
+          attr_writer :group_by
+
+          # 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
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          # A cursor for use in pagination. Corresponding to the `next_page` field from the
+          # previous response.
+          sig { returns(T.nilable(String)) }
+          attr_reader :page
+
+          sig { params(page: String).void }
+          attr_writer :page
+
+          # Return only usage for these projects.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :project_ids
+
+          sig { params(project_ids: T::Array[String]).void }
+          attr_writer :project_ids
+
+          # Return only usage for these users.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :user_ids
+
+          sig { params(user_ids: T::Array[String]).void }
+          attr_writer :user_ids
+
+          # Return only usage for these vector stores.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :vector_store_ids
+
+          sig { params(vector_store_ids: T::Array[String]).void }
+          attr_writer :vector_store_ids
+
+          sig do
+            params(
+              start_time: Integer,
+              api_key_ids: T::Array[String],
+              bucket_width:
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::OrSymbol,
+              end_time: Integer,
+              group_by:
+                T::Array[
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::OrSymbol
+                ],
+              limit: Integer,
+              page: String,
+              project_ids: T::Array[String],
+              user_ids: T::Array[String],
+              vector_store_ids: T::Array[String],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Start time (Unix seconds) of the query time range, inclusive.
+            start_time:,
+            # Return only usage for these API keys.
+            api_key_ids: 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`, `vector_store_id` or any combination of
+            # them.
+            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,
+            # 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,
+            # Return only usage for these vector stores.
+            vector_store_ids: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                start_time: Integer,
+                api_key_ids: T::Array[String],
+                bucket_width:
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::OrSymbol,
+                end_time: Integer,
+                group_by:
+                  T::Array[
+                    OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::OrSymbol
+                  ],
+                limit: Integer,
+                page: String,
+                project_ids: T::Array[String],
+                user_ids: T::Array[String],
+                vector_store_ids: T::Array[String],
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+          # supported, default to `1d`.
+          module BucketWidth
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            BUCKET_WIDTH_1M =
+              T.let(
+                :"1m",
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::TaggedSymbol
+              )
+            BUCKET_WIDTH_1H =
+              T.let(
+                :"1h",
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::TaggedSymbol
+              )
+            BUCKET_WIDTH_1D =
+              T.let(
+                :"1d",
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module GroupBy
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PROJECT_ID =
+              T.let(
+                :project_id,
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::TaggedSymbol
+              )
+            USER_ID =
+              T.let(
+                :user_id,
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::TaggedSymbol
+              )
+            API_KEY_ID =
+              T.let(
+                :api_key_id,
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::TaggedSymbol
+              )
+            VECTOR_STORE_ID =
+              T.let(
+                :vector_store_id,
+                OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end