openai 0.63.0 → 0.65.0

data/lib/openai/models/admin/organization/usage_embeddings_response.rb

@@ -46,7 +46,7 @@ module OpenAI
 
             # @!attribute results
             #
-            #   @return [Array<OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, 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::OrganizationCostsResult>]
+            #   @return [Array<OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, 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>]
             required :results,
                      -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result] }
 
@@ -57,7 +57,7 @@ module OpenAI
 
             # @!method initialize(end_time:, results:, start_time:, object: :bucket)
             #   @param end_time [Integer]
-            #   @param results [Array<OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, 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::OrganizationCostsResult>]
+            #   @param results [Array<OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, 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>]
             #   @param start_time [Integer]
             #   @param object [Symbol, :bucket]
 
@@ -99,6 +99,14 @@ module OpenAI
               variant :"organization.usage.code_interpreter_sessions.result",
                       -> { OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult }
 
+              # The aggregated file search calls usage details of the specific time bucket.
+              variant :"organization.usage.file_searches.result",
+                      -> { OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageFileSearchesResult }
+
+              # The aggregated web search calls usage details of the specific time bucket.
+              variant :"organization.usage.web_searches.result",
+                      -> { OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageWebSearchesResult }
+
               # The aggregated costs details of the specific time bucket.
               variant :"organization.costs.result",
                       -> { OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationCostsResult }
@@ -650,6 +658,143 @@ module OpenAI
                 #   @param object [Symbol, :"organization.usage.code_interpreter_sessions.result"]
               end
 
+              class OrganizationUsageFileSearchesResult < OpenAI::Internal::Type::BaseModel
+                # @!attribute num_requests
+                #   The count of file search calls.
+                #
+                #   @return [Integer]
+                required :num_requests, Integer
+
+                # @!attribute object
+                #
+                #   @return [Symbol, :"organization.usage.file_searches.result"]
+                required :object, const: :"organization.usage.file_searches.result"
+
+                # @!attribute api_key_id
+                #   When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                #   usage result.
+                #
+                #   @return [String, nil]
+                optional :api_key_id, String, nil?: true
+
+                # @!attribute project_id
+                #   When `group_by=project_id`, this field provides the project ID of the grouped
+                #   usage result.
+                #
+                #   @return [String, nil]
+                optional :project_id, String, nil?: true
+
+                # @!attribute user_id
+                #   When `group_by=user_id`, this field provides the user ID of the grouped usage
+                #   result.
+                #
+                #   @return [String, nil]
+                optional :user_id, String, nil?: true
+
+                # @!attribute vector_store_id
+                #   When `group_by=vector_store_id`, this field provides the vector store ID of the
+                #   grouped usage result.
+                #
+                #   @return [String, nil]
+                optional :vector_store_id, String, nil?: true
+
+                # @!method initialize(num_requests:, api_key_id: nil, project_id: nil, user_id: nil, vector_store_id: nil, object: :"organization.usage.file_searches.result")
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageFileSearchesResult}
+                #   for more details.
+                #
+                #   The aggregated file search calls usage details of the specific time bucket.
+                #
+                #   @param num_requests [Integer] The count of file search calls.
+                #
+                #   @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
+                #
+                #   @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
+                #
+                #   @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
+                #
+                #   @param vector_store_id [String, nil] When `group_by=vector_store_id`, this field provides the vector store ID of the
+                #
+                #   @param object [Symbol, :"organization.usage.file_searches.result"]
+              end
+
+              class OrganizationUsageWebSearchesResult < OpenAI::Internal::Type::BaseModel
+                # @!attribute num_model_requests
+                #   The count of model requests.
+                #
+                #   @return [Integer]
+                required :num_model_requests, Integer
+
+                # @!attribute num_requests
+                #   The count of web search calls.
+                #
+                #   @return [Integer]
+                required :num_requests, Integer
+
+                # @!attribute object
+                #
+                #   @return [Symbol, :"organization.usage.web_searches.result"]
+                required :object, const: :"organization.usage.web_searches.result"
+
+                # @!attribute api_key_id
+                #   When `group_by=api_key_id`, this field provides the API key ID of the grouped
+                #   usage result.
+                #
+                #   @return [String, nil]
+                optional :api_key_id, String, nil?: true
+
+                # @!attribute context_level
+                #   When `group_by=context_level`, this field provides the search context size of
+                #   the grouped usage result.
+                #
+                #   @return [String, nil]
+                optional :context_level, String, nil?: true
+
+                # @!attribute model
+                #   When `group_by=model`, this field provides the model name of the grouped usage
+                #   result.
+                #
+                #   @return [String, nil]
+                optional :model, String, nil?: true
+
+                # @!attribute project_id
+                #   When `group_by=project_id`, this field provides the project ID of the grouped
+                #   usage result.
+                #
+                #   @return [String, nil]
+                optional :project_id, String, nil?: true
+
+                # @!attribute user_id
+                #   When `group_by=user_id`, this field provides the user ID of the grouped usage
+                #   result.
+                #
+                #   @return [String, nil]
+                optional :user_id, String, nil?: true
+
+                # @!method initialize(num_model_requests:, num_requests:, api_key_id: nil, context_level: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.web_searches.result")
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageWebSearchesResult}
+                #   for more details.
+                #
+                #   The aggregated web search calls usage details of the specific time bucket.
+                #
+                #   @param num_model_requests [Integer] The count of model requests.
+                #
+                #   @param num_requests [Integer] The count of web search calls.
+                #
+                #   @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
+                #
+                #   @param context_level [String, nil] When `group_by=context_level`, this field provides the search context size of th
+                #
+                #   @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
+                #
+                #   @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
+                #
+                #   @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
+                #
+                #   @param object [Symbol, :"organization.usage.web_searches.result"]
+              end
+
               class OrganizationCostsResult < OpenAI::Internal::Type::BaseModel
                 # @!attribute object
                 #
@@ -734,7 +879,7 @@ module OpenAI
               end
 
               # @!method self.variants
-              #   @return [Array(OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, 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::OrganizationCostsResult)]
+              #   @return [Array(OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, 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
           end
         end

data/lib/openai/models/admin/organization/usage_file_search_calls_params.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Usage#file_search_calls
+        class UsageFileSearchCallsParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute start_time
+          #   Start time (Unix seconds) of the query time range, inclusive.
+          #
+          #   @return [Integer]
+          required :start_time, Integer
+
+          # @!attribute api_key_ids
+          #   Return only usage for these API keys.
+          #
+          #   @return [Array<String>, nil]
+          optional :api_key_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute bucket_width
+          #   Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+          #   supported, default to `1d`.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::UsageFileSearchCallsParams::BucketWidth, nil]
+          optional :bucket_width, enum: -> { OpenAI::Admin::Organization::UsageFileSearchCallsParams::BucketWidth }
+
+          # @!attribute end_time
+          #   End time (Unix seconds) of the query time range, exclusive.
+          #
+          #   @return [Integer, nil]
+          optional :end_time, Integer
+
+          # @!attribute group_by
+          #   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.
+          #
+          #   @return [Array<Symbol, OpenAI::Models::Admin::Organization::UsageFileSearchCallsParams::GroupBy>, nil]
+          optional :group_by,
+                   -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Admin::Organization::UsageFileSearchCallsParams::GroupBy] }
+
+          # @!attribute limit
+          #   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
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute page
+          #   A cursor for use in pagination. Corresponding to the `next_page` field from the
+          #   previous response.
+          #
+          #   @return [String, nil]
+          optional :page, String
+
+          # @!attribute project_ids
+          #   Return only usage for these projects.
+          #
+          #   @return [Array<String>, nil]
+          optional :project_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute user_ids
+          #   Return only usage for these users.
+          #
+          #   @return [Array<String>, nil]
+          optional :user_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute vector_store_ids
+          #   Return only usage for these vector stores.
+          #
+          #   @return [Array<String>, nil]
+          optional :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, page: nil, project_ids: nil, user_ids: nil, vector_store_ids: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::UsageFileSearchCallsParams} for more
+          #   details.
+          #
+          #   @param start_time [Integer] Start time (Unix seconds) of the query time range, inclusive.
+          #
+          #   @param api_key_ids [Array<String>] Return only usage for these API keys.
+          #
+          #   @param bucket_width [Symbol, OpenAI::Models::Admin::Organization::UsageFileSearchCallsParams::BucketWidth] Width of each time bucket in response. Currently `1m`, `1h` and `1d` are support
+          #
+          #   @param end_time [Integer] End time (Unix seconds) of the query time range, exclusive.
+          #
+          #   @param group_by [Array<Symbol, OpenAI::Models::Admin::Organization::UsageFileSearchCallsParams::GroupBy>] Group the usage data by the specified fields. Support fields include `project_id
+          #
+          #   @param limit [Integer] Specifies the number of buckets to return.
+          #
+          #   @param page [String] A cursor for use in pagination. Corresponding to the `next_page` field from the
+          #
+          #   @param project_ids [Array<String>] Return only usage for these projects.
+          #
+          #   @param user_ids [Array<String>] Return only usage for these users.
+          #
+          #   @param vector_store_ids [Array<String>] Return only usage for these vector stores.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+          # supported, default to `1d`.
+          module BucketWidth
+            extend OpenAI::Internal::Type::Enum
+
+            BUCKET_WIDTH_1M = :"1m"
+            BUCKET_WIDTH_1H = :"1h"
+            BUCKET_WIDTH_1D = :"1d"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          module GroupBy
+            extend OpenAI::Internal::Type::Enum
+
+            PROJECT_ID = :project_id
+            USER_ID = :user_id
+            API_KEY_ID = :api_key_id
+            VECTOR_STORE_ID = :vector_store_id
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end