openai 0.99.0 → 0.101.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +1 -1
- data/bedrock.md +17 -1
- data/lib/openai/client.rb +13 -0
- data/lib/openai/helpers/agents/session_stream.rb +11 -36
- data/lib/openai/helpers/agents/tools.rb +34 -4
- data/lib/openai/helpers/beta/agents/creation_stream.rb +26 -0
- data/lib/openai/helpers/beta/agents/function_tool.rb +11 -4
- data/lib/openai/helpers/beta/agents/tool_dispatcher.rb +74 -0
- data/lib/openai/helpers/beta/agents/tool_error.rb +28 -0
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_completions_params.rb +9 -4
- data/lib/openai/models/admin/organization/usage_completions_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_costs_params.rb +16 -4
- data/lib/openai/models/admin/organization/usage_costs_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_images_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +125 -3
- data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +9 -4
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +125 -3
- data/lib/openai/models/beta/agents/environments/template_create_params.rb +6 -6
- data/lib/openai/models/beta/agents/environments/template_update_params.rb +3 -6
- data/lib/openai/models/beta/agents/sessions/turns/item_list_params.rb +79 -0
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +2 -2
- data/lib/openai/models/beta/beta_response_error.rb +12 -1
- data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +1166 -3
- data/lib/openai/models/beta/beta_responses_server_event.rb +12 -1
- data/lib/openai/models/beta/beta_tool.rb +12 -9
- data/lib/openai/models/beta/beta_tool_search_output_namespace_tool.rb +176 -0
- data/lib/openai/models/beta/environment_param.rb +6 -6
- data/lib/openai/models/beta/session_turn_error.rb +9 -0
- data/lib/openai/models/chat/chat_completion_chunk.rb +85 -18
- data/lib/openai/models/decision.rb +313 -0
- data/lib/openai/models/decision_create_params.rb +233 -0
- data/lib/openai/models/decision_input_image.rb +53 -0
- data/lib/openai/models/decision_input_message.rb +60 -0
- data/lib/openai/models/decision_input_part.rb +20 -0
- data/lib/openai/models/decision_input_text.rb +21 -0
- data/lib/openai/models/error_object.rb +12 -1
- data/lib/openai/models/eval_create_params.rb +1 -1
- data/lib/openai/models/eval_create_response.rb +1 -1
- data/lib/openai/models/eval_list_response.rb +1 -1
- data/lib/openai/models/eval_retrieve_response.rb +1 -1
- data/lib/openai/models/eval_update_response.rb +1 -1
- data/lib/openai/models/fine_tuning/job_list_params.rb +14 -4
- data/lib/openai/models/graders/score_model_grader.rb +2 -2
- data/lib/openai/models/image_edit_params.rb +12 -9
- data/lib/openai/models/realtime/realtime_client_event.rb +9 -0
- data/lib/openai/models/realtime/session_update_event.rb +16 -0
- data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +2 -2
- data/lib/openai/models/responses/response_error.rb +12 -1
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +1166 -3
- data/lib/openai/models/responses/responses_server_event.rb +12 -1
- data/lib/openai/models/responses/tool.rb +12 -9
- data/lib/openai/models/responses/tool_search_output_namespace_tool.rb +174 -0
- data/lib/openai/models/video_create_error.rb +12 -1
- data/lib/openai/models.rb +12 -0
- data/lib/openai/providers/bedrock.rb +20 -1
- data/lib/openai/resources/admin/organization/usage.rb +15 -6
- data/lib/openai/resources/beta/agents/environments/templates.rb +3 -4
- data/lib/openai/resources/beta/agents/sessions/turns/items.rb +68 -0
- data/lib/openai/resources/beta/agents/sessions/turns.rb +4 -0
- data/lib/openai/resources/beta/agents/sessions.rb +22 -2
- data/lib/openai/resources/decisions.rb +59 -0
- data/lib/openai/resources/fine_tuning/jobs.rb +7 -2
- data/lib/openai/resources/images.rb +8 -6
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +11 -0
- data/rbi/openai/client.rbi +3 -0
- data/rbi/openai/helpers/agents.rbi +2 -0
- data/rbi/openai/helpers/beta/agents/function_tool.rbi +8 -3
- data/rbi/openai/helpers/beta/agents/tool_error.rbi +19 -0
- data/rbi/openai/helpers/beta/agents.rbi +12 -0
- data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_completions_params.rbi +9 -4
- data/rbi/openai/models/admin/organization/usage_completions_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_costs_params.rbi +16 -4
- data/rbi/openai/models/admin/organization/usage_costs_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_images_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +194 -1
- data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +12 -4
- data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +194 -1
- data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +6 -6
- data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +3 -6
- data/rbi/openai/models/beta/agents/sessions/turns/item_list_params.rbi +139 -0
- data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +2 -2
- data/rbi/openai/models/beta/beta_response_error.rbi +12 -0
- data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +1893 -18
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +12 -0
- data/rbi/openai/models/beta/beta_tool.rbi +12 -9
- data/rbi/openai/models/beta/beta_tool_search_output_namespace_tool.rbi +272 -0
- data/rbi/openai/models/beta/environment_param.rbi +6 -6
- data/rbi/openai/models/beta/session_turn_error.rbi +18 -0
- data/rbi/openai/models/chat/chat_completion_chunk.rbi +123 -17
- data/rbi/openai/models/decision.rbi +586 -0
- data/rbi/openai/models/decision_create_params.rbi +435 -0
- data/rbi/openai/models/decision_input_image.rbi +81 -0
- data/rbi/openai/models/decision_input_message.rbi +96 -0
- data/rbi/openai/models/decision_input_part.rbi +24 -0
- data/rbi/openai/models/decision_input_text.rbi +49 -0
- data/rbi/openai/models/error_object.rbi +12 -0
- data/rbi/openai/models/eval_create_params.rbi +1 -1
- data/rbi/openai/models/eval_create_response.rbi +1 -1
- data/rbi/openai/models/eval_list_response.rbi +1 -1
- data/rbi/openai/models/eval_retrieve_response.rbi +1 -1
- data/rbi/openai/models/eval_update_response.rbi +1 -1
- data/rbi/openai/models/fine_tuning/job_list_params.rbi +14 -4
- data/rbi/openai/models/graders/score_model_grader.rbi +2 -2
- data/rbi/openai/models/image_edit_params.rbi +12 -9
- data/rbi/openai/models/realtime/session_update_event.rbi +16 -0
- data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +2 -2
- data/rbi/openai/models/responses/response_error.rbi +12 -0
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +1901 -18
- data/rbi/openai/models/responses/responses_server_event.rbi +12 -0
- data/rbi/openai/models/responses/tool.rbi +12 -9
- data/rbi/openai/models/responses/tool_search_output_namespace_tool.rbi +272 -0
- data/rbi/openai/models/video_create_error.rbi +12 -0
- data/rbi/openai/models.rbi +12 -0
- data/rbi/openai/resources/admin/organization/usage.rbi +15 -6
- data/rbi/openai/resources/beta/agents/environments/templates.rbi +3 -4
- data/rbi/openai/resources/beta/agents/sessions/turns/items.rbi +62 -0
- data/rbi/openai/resources/beta/agents/sessions/turns.rbi +3 -0
- data/rbi/openai/resources/beta/agents/sessions.rbi +2 -0
- data/rbi/openai/resources/decisions.rbi +57 -0
- data/rbi/openai/resources/fine_tuning/jobs.rbi +7 -2
- data/rbi/openai/resources/images.rbi +8 -6
- data/sig/openai/client.rbs +2 -0
- data/sig/openai/helpers/agents.rbs +3 -0
- data/sig/openai/helpers/beta/agents/function_tool.rbs +5 -2
- data/sig/openai/helpers/beta/agents/tool_error.rbs +17 -0
- data/sig/openai/helpers/beta/agents.rbs +5 -0
- data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_completions_params.rbs +14 -6
- data/sig/openai/models/admin/organization/usage_completions_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_costs_params.rbs +25 -7
- data/sig/openai/models/admin/organization/usage_costs_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_images_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_moderations_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +87 -2
- data/sig/openai/models/admin/organization/usage_web_search_calls_params.rbs +19 -7
- data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +87 -2
- data/sig/openai/models/beta/agents/environments/template_create_params.rbs +4 -4
- data/sig/openai/models/beta/agents/environments/template_update_params.rbs +2 -4
- data/sig/openai/models/beta/agents/sessions/turns/item_list_params.rbs +91 -0
- data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +2 -2
- data/sig/openai/models/beta/beta_response_error.rbs +10 -0
- data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +993 -4
- data/sig/openai/models/beta/beta_responses_server_event.rbs +10 -0
- data/sig/openai/models/beta/beta_tool.rbs +8 -6
- data/sig/openai/models/beta/beta_tool_search_output_namespace_tool.rbs +162 -0
- data/sig/openai/models/beta/environment_param.rbs +4 -4
- data/sig/openai/models/beta/session_turn_error.rbs +12 -0
- data/sig/openai/models/chat/chat_completion_chunk.rbs +96 -12
- data/sig/openai/models/decision.rbs +296 -0
- data/sig/openai/models/decision_create_params.rbs +227 -0
- data/sig/openai/models/decision_input_image.rbs +51 -0
- data/sig/openai/models/decision_input_message.rbs +57 -0
- data/sig/openai/models/decision_input_part.rbs +12 -0
- data/sig/openai/models/decision_input_text.rbs +15 -0
- data/sig/openai/models/error_object.rbs +10 -0
- data/sig/openai/models/eval_create_params.rbs +1 -1
- data/sig/openai/models/eval_create_response.rbs +1 -1
- data/sig/openai/models/eval_list_response.rbs +1 -1
- data/sig/openai/models/eval_retrieve_response.rbs +1 -1
- data/sig/openai/models/eval_update_response.rbs +1 -1
- data/sig/openai/models/fine_tuning/job_list_params.rbs +14 -4
- data/sig/openai/models/graders/score_model_grader.rbs +3 -3
- data/sig/openai/models/image_edit_params.rbs +8 -6
- data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs +2 -2
- data/sig/openai/models/responses/response_error.rbs +10 -0
- data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +993 -4
- data/sig/openai/models/responses/responses_server_event.rbs +10 -0
- data/sig/openai/models/responses/tool.rbs +8 -6
- data/sig/openai/models/responses/tool_search_output_namespace_tool.rbs +160 -0
- data/sig/openai/models/video_create_error.rbs +10 -0
- data/sig/openai/models.rbs +12 -0
- data/sig/openai/resources/beta/agents/sessions/turns/items.rbs +24 -0
- data/sig/openai/resources/beta/agents/sessions/turns.rbs +2 -0
- data/sig/openai/resources/beta/agents/sessions.rbs +1 -0
- data/sig/openai/resources/decisions.rbs +15 -0
- metadata +38 -1
|
@@ -198,6 +198,21 @@ module OpenAI
|
|
|
198
198
|
# @return [String, nil]
|
|
199
199
|
optional :api_key_id, String, nil?: true
|
|
200
200
|
|
|
201
|
+
# @!attribute api_source
|
|
202
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
203
|
+
# activity and `unlabeled` includes all records without published source
|
|
204
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
205
|
+
# direct API usage. Without source grouping, this field is null.
|
|
206
|
+
#
|
|
207
|
+
# @return [Symbol, OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageCompletionsResult::APISource, nil]
|
|
208
|
+
optional(
|
|
209
|
+
:api_source,
|
|
210
|
+
enum: -> {
|
|
211
|
+
OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageCompletionsResult::APISource
|
|
212
|
+
},
|
|
213
|
+
nil?: true
|
|
214
|
+
)
|
|
215
|
+
|
|
201
216
|
# @!attribute batch
|
|
202
217
|
# When `group_by=batch`, this field tells whether the grouped usage result is
|
|
203
218
|
# batch or not.
|
|
@@ -316,7 +331,7 @@ module OpenAI
|
|
|
316
331
|
# @return [String, nil]
|
|
317
332
|
optional :user_id, String, nil?: true
|
|
318
333
|
|
|
319
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
334
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, api_source: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
320
335
|
# The aggregated completions usage details of the specific time bucket.
|
|
321
336
|
#
|
|
322
337
|
# @param input_tokens [Integer]
|
|
@@ -336,6 +351,12 @@ module OpenAI
|
|
|
336
351
|
# When `group_by=api_key_id`, this field provides the API key ID of the grouped
|
|
337
352
|
# usage result.
|
|
338
353
|
#
|
|
354
|
+
# @param api_source [Symbol, OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageCompletionsResult::APISource, nil]
|
|
355
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
356
|
+
# activity and `unlabeled` includes all records without published source
|
|
357
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
358
|
+
# direct API usage. Without source grouping, this field is null.
|
|
359
|
+
#
|
|
339
360
|
# @param batch [Boolean, nil]
|
|
340
361
|
# When `group_by=batch`, this field tells whether the grouped usage result is
|
|
341
362
|
# batch or not.
|
|
@@ -401,6 +422,22 @@ module OpenAI
|
|
|
401
422
|
# result.
|
|
402
423
|
#
|
|
403
424
|
# @param object [Symbol, :"organization.usage.completions.result"]
|
|
425
|
+
|
|
426
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
427
|
+
# activity and `unlabeled` includes all records without published source
|
|
428
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
429
|
+
# direct API usage. Without source grouping, this field is null.
|
|
430
|
+
#
|
|
431
|
+
# @see OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageCompletionsResult#api_source
|
|
432
|
+
module APISource
|
|
433
|
+
extend OpenAI::Internal::Type::Enum
|
|
434
|
+
|
|
435
|
+
AGENTS_API = :agents_api
|
|
436
|
+
UNLABELED = :unlabeled
|
|
437
|
+
|
|
438
|
+
# @!method self.values
|
|
439
|
+
# @return [Array<Symbol>]
|
|
440
|
+
end
|
|
404
441
|
end
|
|
405
442
|
|
|
406
443
|
class OrganizationUsageEmbeddingsResult < OpenAI::Internal::Type::BaseModel
|
|
@@ -950,6 +987,21 @@ module OpenAI
|
|
|
950
987
|
# @return [String, nil]
|
|
951
988
|
optional :api_key_id, String, nil?: true
|
|
952
989
|
|
|
990
|
+
# @!attribute api_source
|
|
991
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
992
|
+
# activity and `unlabeled` includes all records without published source
|
|
993
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
994
|
+
# direct API usage. Without source grouping, this field is null.
|
|
995
|
+
#
|
|
996
|
+
# @return [Symbol, OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageWebSearchesResult::APISource, nil]
|
|
997
|
+
optional(
|
|
998
|
+
:api_source,
|
|
999
|
+
enum: -> {
|
|
1000
|
+
OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageWebSearchesResult::APISource
|
|
1001
|
+
},
|
|
1002
|
+
nil?: true
|
|
1003
|
+
)
|
|
1004
|
+
|
|
953
1005
|
# @!attribute context_level
|
|
954
1006
|
# When `group_by=context_level`, this field provides the search context size of
|
|
955
1007
|
# the grouped usage result.
|
|
@@ -978,7 +1030,7 @@ module OpenAI
|
|
|
978
1030
|
# @return [String, nil]
|
|
979
1031
|
optional :user_id, String, nil?: true
|
|
980
1032
|
|
|
981
|
-
# @!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")
|
|
1033
|
+
# @!method initialize(num_model_requests:, num_requests:, api_key_id: nil, api_source: nil, context_level: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.web_searches.result")
|
|
982
1034
|
# The aggregated web search calls usage details of the specific time bucket.
|
|
983
1035
|
#
|
|
984
1036
|
# @param num_model_requests [Integer]
|
|
@@ -991,6 +1043,12 @@ module OpenAI
|
|
|
991
1043
|
# When `group_by=api_key_id`, this field provides the API key ID of the grouped
|
|
992
1044
|
# usage result.
|
|
993
1045
|
#
|
|
1046
|
+
# @param api_source [Symbol, OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageWebSearchesResult::APISource, nil]
|
|
1047
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1048
|
+
# activity and `unlabeled` includes all records without published source
|
|
1049
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1050
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1051
|
+
#
|
|
994
1052
|
# @param context_level [String, nil]
|
|
995
1053
|
# When `group_by=context_level`, this field provides the search context size of
|
|
996
1054
|
# the grouped usage result.
|
|
@@ -1008,6 +1066,22 @@ module OpenAI
|
|
|
1008
1066
|
# result.
|
|
1009
1067
|
#
|
|
1010
1068
|
# @param object [Symbol, :"organization.usage.web_searches.result"]
|
|
1069
|
+
|
|
1070
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1071
|
+
# activity and `unlabeled` includes all records without published source
|
|
1072
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1073
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1074
|
+
#
|
|
1075
|
+
# @see OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationUsageWebSearchesResult#api_source
|
|
1076
|
+
module APISource
|
|
1077
|
+
extend OpenAI::Internal::Type::Enum
|
|
1078
|
+
|
|
1079
|
+
AGENTS_API = :agents_api
|
|
1080
|
+
UNLABELED = :unlabeled
|
|
1081
|
+
|
|
1082
|
+
# @!method self.values
|
|
1083
|
+
# @return [Array<Symbol>]
|
|
1084
|
+
end
|
|
1011
1085
|
end
|
|
1012
1086
|
|
|
1013
1087
|
class OrganizationCostsResult < OpenAI::Internal::Type::BaseModel
|
|
@@ -1034,6 +1108,21 @@ module OpenAI
|
|
|
1034
1108
|
# @return [String, nil]
|
|
1035
1109
|
optional :api_key_id, String, nil?: true
|
|
1036
1110
|
|
|
1111
|
+
# @!attribute api_source
|
|
1112
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1113
|
+
# activity and `unlabeled` includes all records without published source
|
|
1114
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1115
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1116
|
+
#
|
|
1117
|
+
# @return [Symbol, OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationCostsResult::APISource, nil]
|
|
1118
|
+
optional(
|
|
1119
|
+
:api_source,
|
|
1120
|
+
enum: -> {
|
|
1121
|
+
OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationCostsResult::APISource
|
|
1122
|
+
},
|
|
1123
|
+
nil?: true
|
|
1124
|
+
)
|
|
1125
|
+
|
|
1037
1126
|
# @!attribute line_item
|
|
1038
1127
|
# When `group_by=line_item`, this field provides the line item of the grouped
|
|
1039
1128
|
# costs result.
|
|
@@ -1068,7 +1157,14 @@ module OpenAI
|
|
|
1068
1157
|
nil?: true
|
|
1069
1158
|
)
|
|
1070
1159
|
|
|
1071
|
-
# @!
|
|
1160
|
+
# @!attribute user_id
|
|
1161
|
+
# When `group_by=user_id`, this field provides the user ID of the grouped costs
|
|
1162
|
+
# result.
|
|
1163
|
+
#
|
|
1164
|
+
# @return [String, nil]
|
|
1165
|
+
optional :user_id, String, nil?: true
|
|
1166
|
+
|
|
1167
|
+
# @!method initialize(amount: nil, api_key_id: nil, api_source: nil, line_item: nil, project_id: nil, quantity: nil, quantity_unit: nil, user_id: nil, object: :"organization.costs.result")
|
|
1072
1168
|
# The aggregated costs details of the specific time bucket.
|
|
1073
1169
|
#
|
|
1074
1170
|
# @param amount [OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationCostsResult::Amount]
|
|
@@ -1078,6 +1174,12 @@ module OpenAI
|
|
|
1078
1174
|
# When `group_by=api_key_id`, this field provides the API Key ID of the grouped
|
|
1079
1175
|
# costs result.
|
|
1080
1176
|
#
|
|
1177
|
+
# @param api_source [Symbol, OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationCostsResult::APISource, nil]
|
|
1178
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1179
|
+
# activity and `unlabeled` includes all records without published source
|
|
1180
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1181
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1182
|
+
#
|
|
1081
1183
|
# @param line_item [String, nil]
|
|
1082
1184
|
# When `group_by=line_item`, this field provides the line item of the grouped
|
|
1083
1185
|
# costs result.
|
|
@@ -1094,6 +1196,10 @@ module OpenAI
|
|
|
1094
1196
|
# The unit of the `quantity` value. If no single supported unit applies to the
|
|
1095
1197
|
# result, this field is `null`.
|
|
1096
1198
|
#
|
|
1199
|
+
# @param user_id [String, nil]
|
|
1200
|
+
# When `group_by=user_id`, this field provides the user ID of the grouped costs
|
|
1201
|
+
# result.
|
|
1202
|
+
#
|
|
1097
1203
|
# @param object [Symbol, :"organization.costs.result"]
|
|
1098
1204
|
|
|
1099
1205
|
# @see OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationCostsResult#amount
|
|
@@ -1119,6 +1225,22 @@ module OpenAI
|
|
|
1119
1225
|
# @param value [Float]
|
|
1120
1226
|
# The numeric value of the cost.
|
|
1121
1227
|
end
|
|
1228
|
+
|
|
1229
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1230
|
+
# activity and `unlabeled` includes all records without published source
|
|
1231
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1232
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1233
|
+
#
|
|
1234
|
+
# @see OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationCostsResult#api_source
|
|
1235
|
+
module APISource
|
|
1236
|
+
extend OpenAI::Internal::Type::Enum
|
|
1237
|
+
|
|
1238
|
+
AGENTS_API = :agents_api
|
|
1239
|
+
UNLABELED = :unlabeled
|
|
1240
|
+
|
|
1241
|
+
# @!method self.values
|
|
1242
|
+
# @return [Array<Symbol>]
|
|
1243
|
+
end
|
|
1122
1244
|
end
|
|
1123
1245
|
|
|
1124
1246
|
# @!method self.variants
|
|
@@ -200,6 +200,21 @@ module OpenAI
|
|
|
200
200
|
# @return [String, nil]
|
|
201
201
|
optional :api_key_id, String, nil?: true
|
|
202
202
|
|
|
203
|
+
# @!attribute api_source
|
|
204
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
205
|
+
# activity and `unlabeled` includes all records without published source
|
|
206
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
207
|
+
# direct API usage. Without source grouping, this field is null.
|
|
208
|
+
#
|
|
209
|
+
# @return [Symbol, OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageCompletionsResult::APISource, nil]
|
|
210
|
+
optional(
|
|
211
|
+
:api_source,
|
|
212
|
+
enum: -> {
|
|
213
|
+
OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageCompletionsResult::APISource
|
|
214
|
+
},
|
|
215
|
+
nil?: true
|
|
216
|
+
)
|
|
217
|
+
|
|
203
218
|
# @!attribute batch
|
|
204
219
|
# When `group_by=batch`, this field tells whether the grouped usage result is
|
|
205
220
|
# batch or not.
|
|
@@ -318,7 +333,7 @@ module OpenAI
|
|
|
318
333
|
# @return [String, nil]
|
|
319
334
|
optional :user_id, String, nil?: true
|
|
320
335
|
|
|
321
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
336
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, api_source: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
322
337
|
# The aggregated completions usage details of the specific time bucket.
|
|
323
338
|
#
|
|
324
339
|
# @param input_tokens [Integer]
|
|
@@ -338,6 +353,12 @@ module OpenAI
|
|
|
338
353
|
# When `group_by=api_key_id`, this field provides the API key ID of the grouped
|
|
339
354
|
# usage result.
|
|
340
355
|
#
|
|
356
|
+
# @param api_source [Symbol, OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageCompletionsResult::APISource, nil]
|
|
357
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
358
|
+
# activity and `unlabeled` includes all records without published source
|
|
359
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
360
|
+
# direct API usage. Without source grouping, this field is null.
|
|
361
|
+
#
|
|
341
362
|
# @param batch [Boolean, nil]
|
|
342
363
|
# When `group_by=batch`, this field tells whether the grouped usage result is
|
|
343
364
|
# batch or not.
|
|
@@ -403,6 +424,22 @@ module OpenAI
|
|
|
403
424
|
# result.
|
|
404
425
|
#
|
|
405
426
|
# @param object [Symbol, :"organization.usage.completions.result"]
|
|
427
|
+
|
|
428
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
429
|
+
# activity and `unlabeled` includes all records without published source
|
|
430
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
431
|
+
# direct API usage. Without source grouping, this field is null.
|
|
432
|
+
#
|
|
433
|
+
# @see OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageCompletionsResult#api_source
|
|
434
|
+
module APISource
|
|
435
|
+
extend OpenAI::Internal::Type::Enum
|
|
436
|
+
|
|
437
|
+
AGENTS_API = :agents_api
|
|
438
|
+
UNLABELED = :unlabeled
|
|
439
|
+
|
|
440
|
+
# @!method self.values
|
|
441
|
+
# @return [Array<Symbol>]
|
|
442
|
+
end
|
|
406
443
|
end
|
|
407
444
|
|
|
408
445
|
class OrganizationUsageEmbeddingsResult < OpenAI::Internal::Type::BaseModel
|
|
@@ -952,6 +989,21 @@ module OpenAI
|
|
|
952
989
|
# @return [String, nil]
|
|
953
990
|
optional :api_key_id, String, nil?: true
|
|
954
991
|
|
|
992
|
+
# @!attribute api_source
|
|
993
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
994
|
+
# activity and `unlabeled` includes all records without published source
|
|
995
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
996
|
+
# direct API usage. Without source grouping, this field is null.
|
|
997
|
+
#
|
|
998
|
+
# @return [Symbol, OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageWebSearchesResult::APISource, nil]
|
|
999
|
+
optional(
|
|
1000
|
+
:api_source,
|
|
1001
|
+
enum: -> {
|
|
1002
|
+
OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageWebSearchesResult::APISource
|
|
1003
|
+
},
|
|
1004
|
+
nil?: true
|
|
1005
|
+
)
|
|
1006
|
+
|
|
955
1007
|
# @!attribute context_level
|
|
956
1008
|
# When `group_by=context_level`, this field provides the search context size of
|
|
957
1009
|
# the grouped usage result.
|
|
@@ -980,7 +1032,7 @@ module OpenAI
|
|
|
980
1032
|
# @return [String, nil]
|
|
981
1033
|
optional :user_id, String, nil?: true
|
|
982
1034
|
|
|
983
|
-
# @!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")
|
|
1035
|
+
# @!method initialize(num_model_requests:, num_requests:, api_key_id: nil, api_source: nil, context_level: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.web_searches.result")
|
|
984
1036
|
# The aggregated web search calls usage details of the specific time bucket.
|
|
985
1037
|
#
|
|
986
1038
|
# @param num_model_requests [Integer]
|
|
@@ -993,6 +1045,12 @@ module OpenAI
|
|
|
993
1045
|
# When `group_by=api_key_id`, this field provides the API key ID of the grouped
|
|
994
1046
|
# usage result.
|
|
995
1047
|
#
|
|
1048
|
+
# @param api_source [Symbol, OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageWebSearchesResult::APISource, nil]
|
|
1049
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1050
|
+
# activity and `unlabeled` includes all records without published source
|
|
1051
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1052
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1053
|
+
#
|
|
996
1054
|
# @param context_level [String, nil]
|
|
997
1055
|
# When `group_by=context_level`, this field provides the search context size of
|
|
998
1056
|
# the grouped usage result.
|
|
@@ -1010,6 +1068,22 @@ module OpenAI
|
|
|
1010
1068
|
# result.
|
|
1011
1069
|
#
|
|
1012
1070
|
# @param object [Symbol, :"organization.usage.web_searches.result"]
|
|
1071
|
+
|
|
1072
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1073
|
+
# activity and `unlabeled` includes all records without published source
|
|
1074
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1075
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1076
|
+
#
|
|
1077
|
+
# @see OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationUsageWebSearchesResult#api_source
|
|
1078
|
+
module APISource
|
|
1079
|
+
extend OpenAI::Internal::Type::Enum
|
|
1080
|
+
|
|
1081
|
+
AGENTS_API = :agents_api
|
|
1082
|
+
UNLABELED = :unlabeled
|
|
1083
|
+
|
|
1084
|
+
# @!method self.values
|
|
1085
|
+
# @return [Array<Symbol>]
|
|
1086
|
+
end
|
|
1013
1087
|
end
|
|
1014
1088
|
|
|
1015
1089
|
class OrganizationCostsResult < OpenAI::Internal::Type::BaseModel
|
|
@@ -1036,6 +1110,21 @@ module OpenAI
|
|
|
1036
1110
|
# @return [String, nil]
|
|
1037
1111
|
optional :api_key_id, String, nil?: true
|
|
1038
1112
|
|
|
1113
|
+
# @!attribute api_source
|
|
1114
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1115
|
+
# activity and `unlabeled` includes all records without published source
|
|
1116
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1117
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1118
|
+
#
|
|
1119
|
+
# @return [Symbol, OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationCostsResult::APISource, nil]
|
|
1120
|
+
optional(
|
|
1121
|
+
:api_source,
|
|
1122
|
+
enum: -> {
|
|
1123
|
+
OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationCostsResult::APISource
|
|
1124
|
+
},
|
|
1125
|
+
nil?: true
|
|
1126
|
+
)
|
|
1127
|
+
|
|
1039
1128
|
# @!attribute line_item
|
|
1040
1129
|
# When `group_by=line_item`, this field provides the line item of the grouped
|
|
1041
1130
|
# costs result.
|
|
@@ -1070,7 +1159,14 @@ module OpenAI
|
|
|
1070
1159
|
nil?: true
|
|
1071
1160
|
)
|
|
1072
1161
|
|
|
1073
|
-
# @!
|
|
1162
|
+
# @!attribute user_id
|
|
1163
|
+
# When `group_by=user_id`, this field provides the user ID of the grouped costs
|
|
1164
|
+
# result.
|
|
1165
|
+
#
|
|
1166
|
+
# @return [String, nil]
|
|
1167
|
+
optional :user_id, String, nil?: true
|
|
1168
|
+
|
|
1169
|
+
# @!method initialize(amount: nil, api_key_id: nil, api_source: nil, line_item: nil, project_id: nil, quantity: nil, quantity_unit: nil, user_id: nil, object: :"organization.costs.result")
|
|
1074
1170
|
# The aggregated costs details of the specific time bucket.
|
|
1075
1171
|
#
|
|
1076
1172
|
# @param amount [OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationCostsResult::Amount]
|
|
@@ -1080,6 +1176,12 @@ module OpenAI
|
|
|
1080
1176
|
# When `group_by=api_key_id`, this field provides the API Key ID of the grouped
|
|
1081
1177
|
# costs result.
|
|
1082
1178
|
#
|
|
1179
|
+
# @param api_source [Symbol, OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationCostsResult::APISource, nil]
|
|
1180
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1181
|
+
# activity and `unlabeled` includes all records without published source
|
|
1182
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1183
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1184
|
+
#
|
|
1083
1185
|
# @param line_item [String, nil]
|
|
1084
1186
|
# When `group_by=line_item`, this field provides the line item of the grouped
|
|
1085
1187
|
# costs result.
|
|
@@ -1096,6 +1198,10 @@ module OpenAI
|
|
|
1096
1198
|
# The unit of the `quantity` value. If no single supported unit applies to the
|
|
1097
1199
|
# result, this field is `null`.
|
|
1098
1200
|
#
|
|
1201
|
+
# @param user_id [String, nil]
|
|
1202
|
+
# When `group_by=user_id`, this field provides the user ID of the grouped costs
|
|
1203
|
+
# result.
|
|
1204
|
+
#
|
|
1099
1205
|
# @param object [Symbol, :"organization.costs.result"]
|
|
1100
1206
|
|
|
1101
1207
|
# @see OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationCostsResult#amount
|
|
@@ -1121,6 +1227,22 @@ module OpenAI
|
|
|
1121
1227
|
# @param value [Float]
|
|
1122
1228
|
# The numeric value of the cost.
|
|
1123
1229
|
end
|
|
1230
|
+
|
|
1231
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1232
|
+
# activity and `unlabeled` includes all records without published source
|
|
1233
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1234
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1235
|
+
#
|
|
1236
|
+
# @see OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationCostsResult#api_source
|
|
1237
|
+
module APISource
|
|
1238
|
+
extend OpenAI::Internal::Type::Enum
|
|
1239
|
+
|
|
1240
|
+
AGENTS_API = :agents_api
|
|
1241
|
+
UNLABELED = :unlabeled
|
|
1242
|
+
|
|
1243
|
+
# @!method self.values
|
|
1244
|
+
# @return [Array<Symbol>]
|
|
1245
|
+
end
|
|
1124
1246
|
end
|
|
1125
1247
|
|
|
1126
1248
|
# @!method self.variants
|
|
@@ -49,8 +49,10 @@ module OpenAI
|
|
|
49
49
|
|
|
50
50
|
# @!attribute group_by
|
|
51
51
|
# Group the usage data by the specified fields. Support fields include
|
|
52
|
-
# `project_id`, `user_id`, `api_key_id`, `model`, `context_level` or
|
|
53
|
-
# combination of them.
|
|
52
|
+
# `project_id`, `user_id`, `api_key_id`, `model`, `context_level`, `api_source` or
|
|
53
|
+
# any combination of them. When grouped by `api_source`, results use `agents_api`
|
|
54
|
+
# for attributed Agents API activity and `unlabeled` for all other activity.
|
|
55
|
+
# Without source grouping, `api_source` is null.
|
|
54
56
|
#
|
|
55
57
|
# @return [Array<Symbol, OpenAI::Models::Admin::Organization::UsageWebSearchCallsParams::GroupBy>, nil]
|
|
56
58
|
optional(
|
|
@@ -114,8 +116,10 @@ module OpenAI
|
|
|
114
116
|
#
|
|
115
117
|
# @param group_by [Array<Symbol, OpenAI::Models::Admin::Organization::UsageWebSearchCallsParams::GroupBy>]
|
|
116
118
|
# Group the usage data by the specified fields. Support fields include
|
|
117
|
-
# `project_id`, `user_id`, `api_key_id`, `model`, `context_level` or
|
|
118
|
-
# combination of them.
|
|
119
|
+
# `project_id`, `user_id`, `api_key_id`, `model`, `context_level`, `api_source` or
|
|
120
|
+
# any combination of them. When grouped by `api_source`, results use `agents_api`
|
|
121
|
+
# for attributed Agents API activity and `unlabeled` for all other activity.
|
|
122
|
+
# Without source grouping, `api_source` is null.
|
|
119
123
|
#
|
|
120
124
|
# @param limit [Integer]
|
|
121
125
|
# Specifies the number of buckets to return.
|
|
@@ -171,6 +175,7 @@ module OpenAI
|
|
|
171
175
|
API_KEY_ID = :api_key_id
|
|
172
176
|
MODEL = :model
|
|
173
177
|
CONTEXT_LEVEL = :context_level
|
|
178
|
+
API_SOURCE = :api_source
|
|
174
179
|
|
|
175
180
|
# @!method self.values
|
|
176
181
|
# @return [Array<Symbol>]
|