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
|
@@ -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::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult::APISource, nil]
|
|
210
|
+
optional(
|
|
211
|
+
:api_source,
|
|
212
|
+
enum: -> {
|
|
213
|
+
OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult::APISource, nil]
|
|
999
|
+
optional(
|
|
1000
|
+
:api_source,
|
|
1001
|
+
enum: -> {
|
|
1002
|
+
OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::APISource, nil]
|
|
1120
|
+
optional(
|
|
1121
|
+
:api_source,
|
|
1122
|
+
enum: -> {
|
|
1123
|
+
OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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::UsageWebSearchCallsResponse::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
|
|
@@ -53,8 +53,8 @@ module OpenAI
|
|
|
53
53
|
optional :name, String, nil?: true
|
|
54
54
|
|
|
55
55
|
# @!attribute network
|
|
56
|
-
# Network access policy for the environment.
|
|
57
|
-
#
|
|
56
|
+
# Network access policy for the environment. If omitted, the API version
|
|
57
|
+
# determines whether network access is enabled or disabled.
|
|
58
58
|
#
|
|
59
59
|
# @return [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network, nil]
|
|
60
60
|
optional(
|
|
@@ -129,8 +129,8 @@ module OpenAI
|
|
|
129
129
|
# An optional human-readable display name for the template.
|
|
130
130
|
#
|
|
131
131
|
# @param network [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network, nil]
|
|
132
|
-
# Network access policy for the environment.
|
|
133
|
-
#
|
|
132
|
+
# Network access policy for the environment. If omitted, the API version
|
|
133
|
+
# determines whether network access is enabled or disabled.
|
|
134
134
|
#
|
|
135
135
|
# @param packages [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Packages, nil]
|
|
136
136
|
# Packages to install in the environment. Defaults to empty package lists.
|
|
@@ -184,8 +184,8 @@ module OpenAI
|
|
|
184
184
|
optional :blocked_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
|
|
185
185
|
|
|
186
186
|
# @!method initialize(access:, allowed_domains: nil, blocked_domains: nil)
|
|
187
|
-
# Network access policy for the environment.
|
|
188
|
-
#
|
|
187
|
+
# Network access policy for the environment. If omitted, the API version
|
|
188
|
+
# determines whether network access is enabled or disabled.
|
|
189
189
|
#
|
|
190
190
|
# @param access [Symbol, OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::Access]
|
|
191
191
|
# The environment's network access mode.
|
|
@@ -57,8 +57,7 @@ module OpenAI
|
|
|
57
57
|
|
|
58
58
|
# @!attribute network
|
|
59
59
|
# Network access available after setup completes. Omit to preserve the current
|
|
60
|
-
# policy, or pass `null` to reset to
|
|
61
|
-
# requests.
|
|
60
|
+
# policy, or pass `null` to reset to the default policy.
|
|
62
61
|
#
|
|
63
62
|
# @return [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network, nil]
|
|
64
63
|
optional(
|
|
@@ -133,8 +132,7 @@ module OpenAI
|
|
|
133
132
|
#
|
|
134
133
|
# @param network [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network, nil]
|
|
135
134
|
# Network access available after setup completes. Omit to preserve the current
|
|
136
|
-
# policy, or pass `null` to reset to
|
|
137
|
-
# requests.
|
|
135
|
+
# policy, or pass `null` to reset to the default policy.
|
|
138
136
|
#
|
|
139
137
|
# @param packages [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Packages, nil]
|
|
140
138
|
# Packages installed before the runtime network policy applies.
|
|
@@ -187,8 +185,7 @@ module OpenAI
|
|
|
187
185
|
|
|
188
186
|
# @!method initialize(access:, allowed_domains: nil, blocked_domains: nil)
|
|
189
187
|
# Network access available after setup completes. Omit to preserve the current
|
|
190
|
-
# policy, or pass `null` to reset to
|
|
191
|
-
# requests.
|
|
188
|
+
# policy, or pass `null` to reset to the default policy.
|
|
192
189
|
#
|
|
193
190
|
# @param access [Symbol, OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network::Access]
|
|
194
191
|
# The environment's network access mode.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Beta
|
|
6
|
+
module Agents
|
|
7
|
+
module Sessions
|
|
8
|
+
module Turns
|
|
9
|
+
# @see OpenAI::Resources::Beta::Agents::Sessions::Turns::Items#list
|
|
10
|
+
class ItemListParams < OpenAI::Internal::Type::BaseModel
|
|
11
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
12
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
13
|
+
|
|
14
|
+
# @!attribute session_id
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :session_id, String
|
|
18
|
+
|
|
19
|
+
# @!attribute turn_id
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :turn_id, String
|
|
23
|
+
|
|
24
|
+
# @!attribute after
|
|
25
|
+
# Return items after this cursor in the selected order. Pass the previous
|
|
26
|
+
# response's last_id, which can differ from the last item's ID.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :after, String
|
|
30
|
+
|
|
31
|
+
# @!attribute limit
|
|
32
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :limit, Integer
|
|
36
|
+
|
|
37
|
+
# @!attribute order
|
|
38
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
39
|
+
#
|
|
40
|
+
# @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::Order, nil]
|
|
41
|
+
optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order }
|
|
42
|
+
|
|
43
|
+
# @!method initialize(session_id:, turn_id:, after: nil, limit: nil, order: nil, request_options: {})
|
|
44
|
+
# @param session_id [String]
|
|
45
|
+
#
|
|
46
|
+
# @param turn_id [String]
|
|
47
|
+
#
|
|
48
|
+
# @param after [String]
|
|
49
|
+
# Return items after this cursor in the selected order. Pass the previous
|
|
50
|
+
# response's last_id, which can differ from the last item's ID.
|
|
51
|
+
#
|
|
52
|
+
# @param limit [Integer]
|
|
53
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
54
|
+
#
|
|
55
|
+
# @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::Order]
|
|
56
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
57
|
+
#
|
|
58
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
59
|
+
|
|
60
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
61
|
+
module Order
|
|
62
|
+
extend OpenAI::Internal::Type::Enum
|
|
63
|
+
|
|
64
|
+
# Returns resources in ascending order.
|
|
65
|
+
ASC = :asc
|
|
66
|
+
|
|
67
|
+
# Returns resources in descending order.
|
|
68
|
+
DESC = :desc
|
|
69
|
+
|
|
70
|
+
# @!method self.values
|
|
71
|
+
# @return [Array<Symbol>]
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
@@ -5,7 +5,7 @@ module OpenAI
|
|
|
5
5
|
module Beta
|
|
6
6
|
class BetaResponseComputerToolCallOutputItem < OpenAI::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
|
-
# The
|
|
8
|
+
# The ID of the computer tool call output.
|
|
9
9
|
#
|
|
10
10
|
# @return [String]
|
|
11
11
|
required :id, String
|
|
@@ -63,7 +63,7 @@ module OpenAI
|
|
|
63
63
|
|
|
64
64
|
# @!method initialize(id:, call_id:, output:, status:, acknowledged_safety_checks: nil, agent: nil, created_by: nil, type: :computer_call_output)
|
|
65
65
|
# @param id [String]
|
|
66
|
-
# The
|
|
66
|
+
# The ID of the computer tool call output.
|
|
67
67
|
#
|
|
68
68
|
# @param call_id [String]
|
|
69
69
|
# The ID of the computer tool call that produced the output.
|
|
@@ -78,19 +78,30 @@ module OpenAI
|
|
|
78
78
|
# @return [String, Symbol, OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType, nil]
|
|
79
79
|
optional :error_type, union: -> { OpenAI::Beta::BetaResponseError::Misalignment::ErrorType }
|
|
80
80
|
|
|
81
|
+
# @!attribute review_target
|
|
82
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
83
|
+
# unavailable.
|
|
84
|
+
#
|
|
85
|
+
# @return [String, nil]
|
|
86
|
+
optional :review_target, String, nil?: true
|
|
87
|
+
|
|
81
88
|
# @!attribute steer
|
|
82
89
|
# An optional public continuation instruction.
|
|
83
90
|
#
|
|
84
91
|
# @return [OpenAI::Models::Beta::BetaResponseError::Misalignment::Steer, nil]
|
|
85
92
|
optional :steer, -> { OpenAI::Beta::BetaResponseError::Misalignment::Steer }
|
|
86
93
|
|
|
87
|
-
# @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
|
|
94
|
+
# @!method initialize(detailed_explanation: nil, error_type: nil, review_target: nil, steer: nil)
|
|
88
95
|
# @param detailed_explanation [String]
|
|
89
96
|
# The public explanation for this block.
|
|
90
97
|
#
|
|
91
98
|
# @param error_type [String, Symbol, OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType]
|
|
92
99
|
# An optional classification; clients must accept additional values.
|
|
93
100
|
#
|
|
101
|
+
# @param review_target [String, nil]
|
|
102
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
103
|
+
# unavailable.
|
|
104
|
+
#
|
|
94
105
|
# @param steer [OpenAI::Models::Beta::BetaResponseError::Misalignment::Steer]
|
|
95
106
|
# An optional public continuation instruction.
|
|
96
107
|
|