openai 0.83.0 → 0.84.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 +29 -0
- data/README.md +1 -1
- data/lib/openai/auth/workload_identity_auth.rb +17 -2
- data/lib/openai/client.rb +20 -6
- data/lib/openai/errors.rb +1 -1
- data/lib/openai/helpers/streaming/chat_completion_stream.rb +1 -2
- data/lib/openai/helpers/streaming/response_events.rb +2 -2
- data/lib/openai/helpers/streaming/response_stream.rb +73 -42
- data/lib/openai/helpers/structured_output/chat_completion_parser.rb +6 -0
- data/lib/openai/helpers/structured_output/response_parser.rb +1 -1
- data/lib/openai/internal/type/base_model.rb +2 -2
- data/lib/openai/internal/type/converter.rb +1 -1
- data/lib/openai/internal/util.rb +2 -2
- data/lib/openai/models/admin/organization/usage_costs_params.rb +10 -1
- data/lib/openai/models/batch.rb +4 -4
- data/lib/openai/models/beta/beta_response.rb +9 -12
- data/lib/openai/models/beta/beta_response_usage.rb +1 -12
- data/lib/openai/models/beta/beta_responses_client_event.rb +8 -12
- data/lib/openai/models/beta/response_compact_params.rb +7 -7
- data/lib/openai/models/beta/response_create_params.rb +8 -12
- data/lib/openai/models/chat/completion_create_params.rb +8 -8
- data/lib/openai/models/completion_usage.rb +1 -12
- 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/evals/create_eval_completions_run_data_source.rb +2 -2
- data/lib/openai/models/reasoning.rb +0 -2
- data/lib/openai/models/responses/response.rb +6 -7
- data/lib/openai/models/responses/response_compact_params.rb +7 -7
- data/lib/openai/models/responses/response_create_params.rb +5 -7
- data/lib/openai/models/responses/response_usage.rb +1 -12
- data/lib/openai/models/responses/responses_client_event.rb +5 -7
- data/lib/openai/resources/admin/organization/usage.rb +3 -1
- data/lib/openai/resources/beta/responses.rb +5 -5
- data/lib/openai/resources/chat/completions.rb +2 -2
- data/lib/openai/resources/responses.rb +7 -6
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +1 -0
- data/rbi/openai/errors.rbi +1 -1
- data/rbi/openai/helpers/streaming/events.rbi +2 -2
- data/rbi/openai/helpers/streaming/response_stream.rbi +3 -3
- data/rbi/openai/models/admin/organization/usage_costs_params.rbi +15 -0
- data/rbi/openai/models/batch.rbi +6 -6
- data/rbi/openai/models/beta/beta_response.rbi +10 -15
- data/rbi/openai/models/beta/beta_response_usage.rbi +3 -13
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +9 -15
- data/rbi/openai/models/beta/response_compact_params.rbi +9 -9
- data/rbi/openai/models/beta/response_create_params.rbi +9 -15
- data/rbi/openai/models/chat/completion_create_params.rbi +9 -9
- data/rbi/openai/models/completion_usage.rbi +0 -10
- 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/evals/create_eval_completions_run_data_source.rbi +2 -2
- data/rbi/openai/models/reasoning.rbi +0 -2
- data/rbi/openai/models/responses/response.rbi +7 -10
- data/rbi/openai/models/responses/response_compact_params.rbi +9 -9
- data/rbi/openai/models/responses/response_create_params.rbi +6 -10
- data/rbi/openai/models/responses/response_usage.rbi +3 -13
- data/rbi/openai/models/responses/responses_client_event.rbi +6 -10
- data/rbi/openai/resources/admin/organization/usage.rbi +4 -0
- data/rbi/openai/resources/beta/responses.rbi +7 -11
- data/rbi/openai/resources/chat/completions.rbi +6 -6
- data/rbi/openai/resources/responses.rbi +9 -13
- data/sig/openai/errors.rbs +1 -1
- data/sig/openai/internal/transport/base_client.rbs +4 -19
- data/sig/openai/models/admin/organization/usage_costs_params.rbs +7 -0
- data/sig/openai/models/beta/beta_response.rbs +2 -1
- data/sig/openai/models/beta/beta_response_usage.rbs +3 -8
- data/sig/openai/models/completion_usage.rbs +0 -5
- data/sig/openai/models/responses/response.rbs +2 -1
- data/sig/openai/models/responses/response_usage.rbs +3 -8
- data/sig/openai/resources/admin/organization/usage.rbs +1 -0
- metadata +1 -1
|
@@ -143,9 +143,9 @@ module OpenAI
|
|
|
143
143
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
144
144
|
|
|
145
145
|
# @!attribute model
|
|
146
|
-
# Model ID used to generate the response, like `gpt-
|
|
147
|
-
#
|
|
148
|
-
#
|
|
146
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
147
|
+
# range of models with different capabilities, performance characteristics, and
|
|
148
|
+
# price points. Refer to the
|
|
149
149
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
150
150
|
# available models.
|
|
151
151
|
#
|
|
@@ -248,8 +248,6 @@ module OpenAI
|
|
|
248
248
|
)
|
|
249
249
|
|
|
250
250
|
# @!attribute reasoning
|
|
251
|
-
# **gpt-5 and o-series models only**
|
|
252
|
-
#
|
|
253
251
|
# Configuration options for
|
|
254
252
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
255
253
|
#
|
|
@@ -475,7 +473,7 @@ module OpenAI
|
|
|
475
473
|
#
|
|
476
474
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
477
475
|
#
|
|
478
|
-
# @param model [Symbol, String, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model] Model ID used to generate the response, like `gpt-
|
|
476
|
+
# @param model [Symbol, String, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
|
|
479
477
|
#
|
|
480
478
|
# @param moderation [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Moderation, nil] Configuration for running moderation on the input and output of this response.
|
|
481
479
|
#
|
|
@@ -493,7 +491,7 @@ module OpenAI
|
|
|
493
491
|
#
|
|
494
492
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
495
493
|
#
|
|
496
|
-
# @param reasoning [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Reasoning, nil]
|
|
494
|
+
# @param reasoning [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Reasoning, nil] Configuration options for
|
|
497
495
|
#
|
|
498
496
|
# @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
|
|
499
497
|
#
|
|
@@ -589,9 +587,9 @@ module OpenAI
|
|
|
589
587
|
# @return [Array(String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>)]
|
|
590
588
|
end
|
|
591
589
|
|
|
592
|
-
# Model ID used to generate the response, like `gpt-
|
|
593
|
-
#
|
|
594
|
-
#
|
|
590
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
591
|
+
# range of models with different capabilities, performance characteristics, and
|
|
592
|
+
# price points. Refer to the
|
|
595
593
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
596
594
|
# available models.
|
|
597
595
|
#
|
|
@@ -1434,8 +1432,6 @@ module OpenAI
|
|
|
1434
1432
|
# {OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Reasoning} for
|
|
1435
1433
|
# more details.
|
|
1436
1434
|
#
|
|
1437
|
-
# **gpt-5 and o-series models only**
|
|
1438
|
-
#
|
|
1439
1435
|
# Configuration options for
|
|
1440
1436
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
1441
1437
|
#
|
|
@@ -9,9 +9,9 @@ module OpenAI
|
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
11
|
# @!attribute model
|
|
12
|
-
# Model ID used to generate the response, like `gpt-5
|
|
13
|
-
#
|
|
14
|
-
#
|
|
12
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
13
|
+
# range of models with different capabilities, performance characteristics, and
|
|
14
|
+
# price points. Refer to the
|
|
15
15
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
16
16
|
# available models.
|
|
17
17
|
#
|
|
@@ -109,7 +109,7 @@ module OpenAI
|
|
|
109
109
|
# Some parameter documentations has been truncated, see
|
|
110
110
|
# {OpenAI::Models::Beta::ResponseCompactParams} for more details.
|
|
111
111
|
#
|
|
112
|
-
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5
|
|
112
|
+
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
113
113
|
#
|
|
114
114
|
# @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
115
115
|
#
|
|
@@ -129,9 +129,9 @@ module OpenAI
|
|
|
129
129
|
#
|
|
130
130
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
131
131
|
|
|
132
|
-
# Model ID used to generate the response, like `gpt-5
|
|
133
|
-
#
|
|
134
|
-
#
|
|
132
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
133
|
+
# range of models with different capabilities, performance characteristics, and
|
|
134
|
+
# price points. Refer to the
|
|
135
135
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
136
136
|
# available models.
|
|
137
137
|
module Model
|
|
@@ -118,9 +118,9 @@ module OpenAI
|
|
|
118
118
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
119
119
|
|
|
120
120
|
# @!attribute model
|
|
121
|
-
# Model ID used to generate the response, like `gpt-
|
|
122
|
-
#
|
|
123
|
-
#
|
|
121
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
122
|
+
# range of models with different capabilities, performance characteristics, and
|
|
123
|
+
# price points. Refer to the
|
|
124
124
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
125
125
|
# available models.
|
|
126
126
|
#
|
|
@@ -212,8 +212,6 @@ module OpenAI
|
|
|
212
212
|
)
|
|
213
213
|
|
|
214
214
|
# @!attribute reasoning
|
|
215
|
-
# **gpt-5 and o-series models only**
|
|
216
|
-
#
|
|
217
215
|
# Configuration options for
|
|
218
216
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
219
217
|
#
|
|
@@ -394,7 +392,7 @@ module OpenAI
|
|
|
394
392
|
#
|
|
395
393
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
396
394
|
#
|
|
397
|
-
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCreateParams::Model] Model ID used to generate the response, like `gpt-
|
|
395
|
+
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCreateParams::Model] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
|
|
398
396
|
#
|
|
399
397
|
# @param moderation [OpenAI::Models::Beta::ResponseCreateParams::Moderation, nil] Configuration for running moderation on the input and output of this response.
|
|
400
398
|
#
|
|
@@ -412,7 +410,7 @@ module OpenAI
|
|
|
412
410
|
#
|
|
413
411
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::ResponseCreateParams::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
414
412
|
#
|
|
415
|
-
# @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil]
|
|
413
|
+
# @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil] Configuration options for
|
|
416
414
|
#
|
|
417
415
|
# @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
|
|
418
416
|
#
|
|
@@ -502,9 +500,9 @@ module OpenAI
|
|
|
502
500
|
# @return [Array(String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>)]
|
|
503
501
|
end
|
|
504
502
|
|
|
505
|
-
# Model ID used to generate the response, like `gpt-
|
|
506
|
-
#
|
|
507
|
-
#
|
|
503
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
504
|
+
# range of models with different capabilities, performance characteristics, and
|
|
505
|
+
# price points. Refer to the
|
|
508
506
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
509
507
|
# available models.
|
|
510
508
|
module Model
|
|
@@ -1126,8 +1124,6 @@ module OpenAI
|
|
|
1126
1124
|
# Some parameter documentations has been truncated, see
|
|
1127
1125
|
# {OpenAI::Models::Beta::ResponseCreateParams::Reasoning} for more details.
|
|
1128
1126
|
#
|
|
1129
|
-
# **gpt-5 and o-series models only**
|
|
1130
|
-
#
|
|
1131
1127
|
# Configuration options for
|
|
1132
1128
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
1133
1129
|
#
|
|
@@ -25,9 +25,9 @@ module OpenAI
|
|
|
25
25
|
)
|
|
26
26
|
|
|
27
27
|
# @!attribute model
|
|
28
|
-
# Model ID used to generate the response, like `gpt-
|
|
29
|
-
# wide range of models with different capabilities, performance
|
|
30
|
-
# and price points. Refer to the
|
|
28
|
+
# Model ID used to generate the response, like `gpt-5.6-sol` or `o3`. OpenAI
|
|
29
|
+
# offers a wide range of models with different capabilities, performance
|
|
30
|
+
# characteristics, and price points. Refer to the
|
|
31
31
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
32
32
|
# available models.
|
|
33
33
|
#
|
|
@@ -438,7 +438,7 @@ module OpenAI
|
|
|
438
438
|
#
|
|
439
439
|
# @param messages [Array<OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam, OpenAI::Models::Chat::ChatCompletionSystemMessageParam, OpenAI::Models::Chat::ChatCompletionUserMessageParam, OpenAI::Models::Chat::ChatCompletionAssistantMessageParam, OpenAI::Models::Chat::ChatCompletionToolMessageParam, OpenAI::Models::Chat::ChatCompletionFunctionMessageParam>] A list of messages comprising the conversation so far. Depending on the
|
|
440
440
|
#
|
|
441
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel] Model ID used to generate the response, like `gpt-
|
|
441
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel] Model ID used to generate the response, like `gpt-5.6-sol` or `o3`. OpenAI
|
|
442
442
|
#
|
|
443
443
|
# @param audio [OpenAI::Models::Chat::ChatCompletionAudioParam, nil] Parameters for audio output. Required when audio output is requested with
|
|
444
444
|
#
|
|
@@ -510,9 +510,9 @@ module OpenAI
|
|
|
510
510
|
#
|
|
511
511
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
512
512
|
|
|
513
|
-
# Model ID used to generate the response, like `gpt-
|
|
514
|
-
# wide range of models with different capabilities, performance
|
|
515
|
-
# and price points. Refer to the
|
|
513
|
+
# Model ID used to generate the response, like `gpt-5.6-sol` or `o3`. OpenAI
|
|
514
|
+
# offers a wide range of models with different capabilities, performance
|
|
515
|
+
# characteristics, and price points. Refer to the
|
|
516
516
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
517
517
|
# available models.
|
|
518
518
|
module Model
|
|
@@ -520,7 +520,7 @@ module OpenAI
|
|
|
520
520
|
|
|
521
521
|
variant String
|
|
522
522
|
|
|
523
|
-
# Model ID used to generate the response, like `gpt-
|
|
523
|
+
# Model ID used to generate the response, like `gpt-5.6-sol` or `o3`. OpenAI
|
|
524
524
|
# offers a wide range of models with different capabilities, performance
|
|
525
525
|
# characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models)
|
|
526
526
|
# to browse and compare available models.
|
|
@@ -27,22 +27,13 @@ module OpenAI
|
|
|
27
27
|
# @return [OpenAI::Models::CompletionUsage::CompletionTokensDetails, nil]
|
|
28
28
|
optional :completion_tokens_details, -> { OpenAI::CompletionUsage::CompletionTokensDetails }
|
|
29
29
|
|
|
30
|
-
# @!attribute compute_units
|
|
31
|
-
# Compute units for the request. Currently null when available.
|
|
32
|
-
#
|
|
33
|
-
# @return [Integer, nil]
|
|
34
|
-
optional :compute_units, Integer, nil?: true
|
|
35
|
-
|
|
36
30
|
# @!attribute prompt_tokens_details
|
|
37
31
|
# Breakdown of tokens used in the prompt.
|
|
38
32
|
#
|
|
39
33
|
# @return [OpenAI::Models::CompletionUsage::PromptTokensDetails, nil]
|
|
40
34
|
optional :prompt_tokens_details, -> { OpenAI::CompletionUsage::PromptTokensDetails }
|
|
41
35
|
|
|
42
|
-
# @!method initialize(completion_tokens:, prompt_tokens:, total_tokens:, completion_tokens_details: nil,
|
|
43
|
-
# Some parameter documentations has been truncated, see
|
|
44
|
-
# {OpenAI::Models::CompletionUsage} for more details.
|
|
45
|
-
#
|
|
36
|
+
# @!method initialize(completion_tokens:, prompt_tokens:, total_tokens:, completion_tokens_details: nil, prompt_tokens_details: nil)
|
|
46
37
|
# Usage statistics for the completion request.
|
|
47
38
|
#
|
|
48
39
|
# @param completion_tokens [Integer] Number of tokens in the generated completion.
|
|
@@ -53,8 +44,6 @@ module OpenAI
|
|
|
53
44
|
#
|
|
54
45
|
# @param completion_tokens_details [OpenAI::Models::CompletionUsage::CompletionTokensDetails] Breakdown of tokens used in a completion.
|
|
55
46
|
#
|
|
56
|
-
# @param compute_units [Integer, nil] Compute units for the request. Currently null when available.
|
|
57
|
-
#
|
|
58
47
|
# @param prompt_tokens_details [OpenAI::Models::CompletionUsage::PromptTokensDetails] Breakdown of tokens used in the prompt.
|
|
59
48
|
|
|
60
49
|
# @see OpenAI::Models::CompletionUsage#completion_tokens_details
|
|
@@ -63,7 +63,7 @@ module OpenAI
|
|
|
63
63
|
#
|
|
64
64
|
# - Improve the quality of my chatbot
|
|
65
65
|
# - See how well my chatbot handles customer support
|
|
66
|
-
# - Check if o4-mini is better at my usecase than gpt-
|
|
66
|
+
# - Check if o4-mini is better at my usecase than gpt-5.6-sol
|
|
67
67
|
#
|
|
68
68
|
# @param id [String] Unique identifier for the evaluation.
|
|
69
69
|
#
|
|
@@ -63,7 +63,7 @@ module OpenAI
|
|
|
63
63
|
#
|
|
64
64
|
# - Improve the quality of my chatbot
|
|
65
65
|
# - See how well my chatbot handles customer support
|
|
66
|
-
# - Check if o4-mini is better at my usecase than gpt-
|
|
66
|
+
# - Check if o4-mini is better at my usecase than gpt-5.6-sol
|
|
67
67
|
#
|
|
68
68
|
# @param id [String] Unique identifier for the evaluation.
|
|
69
69
|
#
|
|
@@ -63,7 +63,7 @@ module OpenAI
|
|
|
63
63
|
#
|
|
64
64
|
# - Improve the quality of my chatbot
|
|
65
65
|
# - See how well my chatbot handles customer support
|
|
66
|
-
# - Check if o4-mini is better at my usecase than gpt-
|
|
66
|
+
# - Check if o4-mini is better at my usecase than gpt-5.6-sol
|
|
67
67
|
#
|
|
68
68
|
# @param id [String] Unique identifier for the evaluation.
|
|
69
69
|
#
|
|
@@ -63,7 +63,7 @@ module OpenAI
|
|
|
63
63
|
#
|
|
64
64
|
# - Improve the quality of my chatbot
|
|
65
65
|
# - See how well my chatbot handles customer support
|
|
66
|
-
# - Check if o4-mini is better at my usecase than gpt-
|
|
66
|
+
# - Check if o4-mini is better at my usecase than gpt-5.6-sol
|
|
67
67
|
#
|
|
68
68
|
# @param id [String] Unique identifier for the evaluation.
|
|
69
69
|
#
|
|
@@ -168,7 +168,7 @@ module OpenAI
|
|
|
168
168
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
169
169
|
|
|
170
170
|
# @!attribute model
|
|
171
|
-
# An optional model to filter by (e.g., 'gpt-
|
|
171
|
+
# An optional model to filter by (e.g., 'gpt-5.6-sol').
|
|
172
172
|
#
|
|
173
173
|
# @return [String, nil]
|
|
174
174
|
optional :model, String, nil?: true
|
|
@@ -188,7 +188,7 @@ module OpenAI
|
|
|
188
188
|
#
|
|
189
189
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
190
190
|
#
|
|
191
|
-
# @param model [String, nil] An optional model to filter by (e.g., 'gpt-
|
|
191
|
+
# @param model [String, nil] An optional model to filter by (e.g., 'gpt-5.6-sol').
|
|
192
192
|
#
|
|
193
193
|
# @param type [Symbol, :stored_completions] The type of source. Always `stored_completions`.
|
|
194
194
|
end
|
|
@@ -60,8 +60,6 @@ module OpenAI
|
|
|
60
60
|
# Some parameter documentations has been truncated, see
|
|
61
61
|
# {OpenAI::Models::Reasoning} for more details.
|
|
62
62
|
#
|
|
63
|
-
# **gpt-5 and o-series models only**
|
|
64
|
-
#
|
|
65
63
|
# Configuration options for
|
|
66
64
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
67
65
|
#
|
|
@@ -53,9 +53,9 @@ module OpenAI
|
|
|
53
53
|
required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
54
54
|
|
|
55
55
|
# @!attribute model
|
|
56
|
-
# Model ID used to generate the response, like `gpt-
|
|
57
|
-
#
|
|
58
|
-
#
|
|
56
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
57
|
+
# range of models with different capabilities, performance characteristics, and
|
|
58
|
+
# price points. Refer to the
|
|
59
59
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
60
60
|
# available models.
|
|
61
61
|
#
|
|
@@ -242,8 +242,6 @@ module OpenAI
|
|
|
242
242
|
)
|
|
243
243
|
|
|
244
244
|
# @!attribute reasoning
|
|
245
|
-
# **gpt-5 and o-series models only**
|
|
246
|
-
#
|
|
247
245
|
# Configuration options for
|
|
248
246
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
249
247
|
#
|
|
@@ -382,7 +380,7 @@ module OpenAI
|
|
|
382
380
|
#
|
|
383
381
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
384
382
|
#
|
|
385
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-
|
|
383
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
|
|
386
384
|
#
|
|
387
385
|
# @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] An array of content items generated by the model.
|
|
388
386
|
#
|
|
@@ -418,7 +416,7 @@ module OpenAI
|
|
|
418
416
|
#
|
|
419
417
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::Response::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
420
418
|
#
|
|
421
|
-
# @param reasoning [OpenAI::Models::Reasoning, nil]
|
|
419
|
+
# @param reasoning [OpenAI::Models::Reasoning, nil] Configuration options for
|
|
422
420
|
#
|
|
423
421
|
# @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
|
|
424
422
|
#
|
|
@@ -458,6 +456,7 @@ module OpenAI
|
|
|
458
456
|
extend OpenAI::Internal::Type::Enum
|
|
459
457
|
|
|
460
458
|
MAX_OUTPUT_TOKENS = :max_output_tokens
|
|
459
|
+
MAX_MESSAGES = :max_messages
|
|
461
460
|
CONTENT_FILTER = :content_filter
|
|
462
461
|
|
|
463
462
|
# @!method self.values
|
|
@@ -9,9 +9,9 @@ module OpenAI
|
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
11
|
# @!attribute model
|
|
12
|
-
# Model ID used to generate the response, like `gpt-5
|
|
13
|
-
#
|
|
14
|
-
#
|
|
12
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
13
|
+
# range of models with different capabilities, performance characteristics, and
|
|
14
|
+
# price points. Refer to the
|
|
15
15
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
16
16
|
# available models.
|
|
17
17
|
#
|
|
@@ -102,7 +102,7 @@ module OpenAI
|
|
|
102
102
|
# Some parameter documentations has been truncated, see
|
|
103
103
|
# {OpenAI::Models::Responses::ResponseCompactParams} for more details.
|
|
104
104
|
#
|
|
105
|
-
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5
|
|
105
|
+
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
106
106
|
#
|
|
107
107
|
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
108
108
|
#
|
|
@@ -120,9 +120,9 @@ module OpenAI
|
|
|
120
120
|
#
|
|
121
121
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
122
122
|
|
|
123
|
-
# Model ID used to generate the response, like `gpt-5
|
|
124
|
-
#
|
|
125
|
-
#
|
|
123
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
124
|
+
# range of models with different capabilities, performance characteristics, and
|
|
125
|
+
# price points. Refer to the
|
|
126
126
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
127
127
|
# available models.
|
|
128
128
|
module Model
|
|
@@ -124,9 +124,9 @@ module OpenAI
|
|
|
124
124
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
125
125
|
|
|
126
126
|
# @!attribute model
|
|
127
|
-
# Model ID used to generate the response, like `gpt-
|
|
128
|
-
#
|
|
129
|
-
#
|
|
127
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
128
|
+
# range of models with different capabilities, performance characteristics, and
|
|
129
|
+
# price points. Refer to the
|
|
130
130
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
131
131
|
# available models.
|
|
132
132
|
#
|
|
@@ -212,8 +212,6 @@ module OpenAI
|
|
|
212
212
|
)
|
|
213
213
|
|
|
214
214
|
# @!attribute reasoning
|
|
215
|
-
# **gpt-5 and o-series models only**
|
|
216
|
-
#
|
|
217
215
|
# Configuration options for
|
|
218
216
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
219
217
|
#
|
|
@@ -397,7 +395,7 @@ module OpenAI
|
|
|
397
395
|
#
|
|
398
396
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
399
397
|
#
|
|
400
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-
|
|
398
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
|
|
401
399
|
#
|
|
402
400
|
# @param moderation [OpenAI::Models::Responses::ResponseCreateParams::Moderation, nil] Configuration for running moderation on the input and output of this response.
|
|
403
401
|
#
|
|
@@ -413,7 +411,7 @@ module OpenAI
|
|
|
413
411
|
#
|
|
414
412
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
415
413
|
#
|
|
416
|
-
# @param reasoning [OpenAI::Models::Reasoning, nil]
|
|
414
|
+
# @param reasoning [OpenAI::Models::Reasoning, nil] Configuration options for
|
|
417
415
|
#
|
|
418
416
|
# @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
|
|
419
417
|
#
|
|
@@ -34,16 +34,7 @@ module OpenAI
|
|
|
34
34
|
# @return [Integer]
|
|
35
35
|
required :total_tokens, Integer
|
|
36
36
|
|
|
37
|
-
# @!
|
|
38
|
-
# Compute units for the request. Currently null when available.
|
|
39
|
-
#
|
|
40
|
-
# @return [Integer, nil]
|
|
41
|
-
optional :compute_units, Integer, nil?: true
|
|
42
|
-
|
|
43
|
-
# @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:, compute_units: nil)
|
|
44
|
-
# Some parameter documentations has been truncated, see
|
|
45
|
-
# {OpenAI::Models::Responses::ResponseUsage} for more details.
|
|
46
|
-
#
|
|
37
|
+
# @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
|
|
47
38
|
# Represents token usage details including input tokens, output tokens, a
|
|
48
39
|
# breakdown of output tokens, and the total tokens used.
|
|
49
40
|
#
|
|
@@ -56,8 +47,6 @@ module OpenAI
|
|
|
56
47
|
# @param output_tokens_details [OpenAI::Models::Responses::ResponseUsage::OutputTokensDetails] A detailed breakdown of the output tokens.
|
|
57
48
|
#
|
|
58
49
|
# @param total_tokens [Integer] The total number of tokens used.
|
|
59
|
-
#
|
|
60
|
-
# @param compute_units [Integer, nil] Compute units for the request. Currently null when available.
|
|
61
50
|
|
|
62
51
|
# @see OpenAI::Models::Responses::ResponseUsage#input_tokens_details
|
|
63
52
|
class InputTokensDetails < OpenAI::Internal::Type::BaseModel
|
|
@@ -124,9 +124,9 @@ module OpenAI
|
|
|
124
124
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
125
125
|
|
|
126
126
|
# @!attribute model
|
|
127
|
-
# Model ID used to generate the response, like `gpt-
|
|
128
|
-
#
|
|
129
|
-
#
|
|
127
|
+
# Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
|
|
128
|
+
# range of models with different capabilities, performance characteristics, and
|
|
129
|
+
# price points. Refer to the
|
|
130
130
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
131
131
|
# available models.
|
|
132
132
|
#
|
|
@@ -212,8 +212,6 @@ module OpenAI
|
|
|
212
212
|
)
|
|
213
213
|
|
|
214
214
|
# @!attribute reasoning
|
|
215
|
-
# **gpt-5 and o-series models only**
|
|
216
|
-
#
|
|
217
215
|
# Configuration options for
|
|
218
216
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
219
217
|
#
|
|
@@ -410,7 +408,7 @@ module OpenAI
|
|
|
410
408
|
#
|
|
411
409
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
412
410
|
#
|
|
413
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-
|
|
411
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
|
|
414
412
|
#
|
|
415
413
|
# @param moderation [OpenAI::Models::Responses::ResponsesClientEvent::Moderation, nil] Configuration for running moderation on the input and output of this response.
|
|
416
414
|
#
|
|
@@ -426,7 +424,7 @@ module OpenAI
|
|
|
426
424
|
#
|
|
427
425
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
428
426
|
#
|
|
429
|
-
# @param reasoning [OpenAI::Models::Reasoning, nil]
|
|
427
|
+
# @param reasoning [OpenAI::Models::Reasoning, nil] Configuration options for
|
|
430
428
|
#
|
|
431
429
|
# @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
|
|
432
430
|
#
|
|
@@ -189,7 +189,7 @@ module OpenAI
|
|
|
189
189
|
#
|
|
190
190
|
# Get costs details for the organization.
|
|
191
191
|
#
|
|
192
|
-
# @overload costs(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, page: nil, project_ids: nil, request_options: {})
|
|
192
|
+
# @overload costs(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, line_items: nil, page: nil, project_ids: nil, request_options: {})
|
|
193
193
|
#
|
|
194
194
|
# @param start_time [Integer] Start time (Unix seconds) of the query time range, inclusive.
|
|
195
195
|
#
|
|
@@ -203,6 +203,8 @@ module OpenAI
|
|
|
203
203
|
#
|
|
204
204
|
# @param limit [Integer] A limit on the number of buckets to be returned. Limit can range between 1 and 1
|
|
205
205
|
#
|
|
206
|
+
# @param line_items [Array<String>] Return only costs for these exact line item names. Each value must match the com
|
|
207
|
+
#
|
|
206
208
|
# @param page [String] A cursor for use in pagination. Corresponding to the `next_page` field from the
|
|
207
209
|
#
|
|
208
210
|
# @param project_ids [Array<String>] Return only costs for these projects.
|
|
@@ -47,7 +47,7 @@ module OpenAI
|
|
|
47
47
|
#
|
|
48
48
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Set of 16 key-value pairs that can be attached to an object. This ca
|
|
49
49
|
#
|
|
50
|
-
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCreateParams::Model] Body param: Model ID used to generate the response, like `gpt-
|
|
50
|
+
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCreateParams::Model] Body param: Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
|
|
51
51
|
#
|
|
52
52
|
# @param moderation [OpenAI::Models::Beta::ResponseCreateParams::Moderation, nil] Body param: Configuration for running moderation on the input and output of this
|
|
53
53
|
#
|
|
@@ -65,7 +65,7 @@ module OpenAI
|
|
|
65
65
|
#
|
|
66
66
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::ResponseCreateParams::PromptCacheRetention, nil] Body param: Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
67
67
|
#
|
|
68
|
-
# @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil] Body param:
|
|
68
|
+
# @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil] Body param: Configuration options for
|
|
69
69
|
#
|
|
70
70
|
# @param safety_identifier [String, nil] Body param: A stable identifier used to help detect users of your application th
|
|
71
71
|
#
|
|
@@ -154,7 +154,7 @@ module OpenAI
|
|
|
154
154
|
#
|
|
155
155
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Set of 16 key-value pairs that can be attached to an object. This ca
|
|
156
156
|
#
|
|
157
|
-
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCreateParams::Model] Body param: Model ID used to generate the response, like `gpt-
|
|
157
|
+
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCreateParams::Model] Body param: Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
|
|
158
158
|
#
|
|
159
159
|
# @param moderation [OpenAI::Models::Beta::ResponseCreateParams::Moderation, nil] Body param: Configuration for running moderation on the input and output of this
|
|
160
160
|
#
|
|
@@ -172,7 +172,7 @@ module OpenAI
|
|
|
172
172
|
#
|
|
173
173
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::ResponseCreateParams::PromptCacheRetention, nil] Body param: Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
174
174
|
#
|
|
175
|
-
# @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil] Body param:
|
|
175
|
+
# @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil] Body param: Configuration options for
|
|
176
176
|
#
|
|
177
177
|
# @param safety_identifier [String, nil] Body param: A stable identifier used to help detect users of your application th
|
|
178
178
|
#
|
|
@@ -393,7 +393,7 @@ module OpenAI
|
|
|
393
393
|
#
|
|
394
394
|
# @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, betas: nil, request_options: {})
|
|
395
395
|
#
|
|
396
|
-
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil] Body param: Model ID used to generate the response, like `gpt-5
|
|
396
|
+
# @param model [Symbol, String, OpenAI::Models::Beta::ResponseCompactParams::Model, nil] Body param: Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI o
|
|
397
397
|
#
|
|
398
398
|
# @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] Body param: Text, image, or file inputs to the model, used to generate a respons
|
|
399
399
|
#
|
|
@@ -43,7 +43,7 @@ module OpenAI
|
|
|
43
43
|
#
|
|
44
44
|
# @param messages [Array<OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam, OpenAI::Models::Chat::ChatCompletionSystemMessageParam, OpenAI::Models::Chat::ChatCompletionUserMessageParam, OpenAI::Models::Chat::ChatCompletionAssistantMessageParam, OpenAI::Models::Chat::ChatCompletionToolMessageParam, OpenAI::Models::Chat::ChatCompletionFunctionMessageParam>] A list of messages comprising the conversation so far. Depending on the
|
|
45
45
|
#
|
|
46
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel] Model ID used to generate the response, like `gpt-
|
|
46
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel] Model ID used to generate the response, like `gpt-5.6-sol` or `o3`. OpenAI
|
|
47
47
|
#
|
|
48
48
|
# @param audio [OpenAI::Models::Chat::ChatCompletionAudioParam, nil] Parameters for audio output. Required when audio output is requested with
|
|
49
49
|
#
|
|
@@ -205,7 +205,7 @@ module OpenAI
|
|
|
205
205
|
#
|
|
206
206
|
# @param messages [Array<OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam, OpenAI::Models::Chat::ChatCompletionSystemMessageParam, OpenAI::Models::Chat::ChatCompletionUserMessageParam, OpenAI::Models::Chat::ChatCompletionAssistantMessageParam, OpenAI::Models::Chat::ChatCompletionToolMessageParam, OpenAI::Models::Chat::ChatCompletionFunctionMessageParam>] A list of messages comprising the conversation so far. Depending on the
|
|
207
207
|
#
|
|
208
|
-
# @param model [String, Symbol, OpenAI::Models::ChatModel] Model ID used to generate the response, like `gpt-
|
|
208
|
+
# @param model [String, Symbol, OpenAI::Models::ChatModel] Model ID used to generate the response, like `gpt-5.6-sol` or `o3`. OpenAI
|
|
209
209
|
#
|
|
210
210
|
# @param audio [OpenAI::Models::Chat::ChatCompletionAudioParam, nil] Parameters for audio output. Required when audio output is requested with
|
|
211
211
|
#
|