openai 0.125.0 → 0.126.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 +10 -0
- data/README.md +1 -1
- data/lib/openai/models/all_models.rb +1 -0
- data/lib/openai/models/beta/beta_response.rb +9 -0
- data/lib/openai/models/beta/beta_responses_client_event.rb +76 -1
- data/lib/openai/models/beta/response_compact_params.rb +9 -0
- data/lib/openai/models/beta/response_create_params.rb +70 -1
- data/lib/openai/models/chat_model.rb +2 -0
- data/lib/openai/models/responses/response_compact_params.rb +9 -0
- data/lib/openai/models/responses/response_create_params.rb +61 -1
- data/lib/openai/models/responses/responses_client_event.rb +65 -1
- data/lib/openai/models/responses_model.rb +1 -0
- data/lib/openai/resources/beta/responses.rb +12 -2
- data/lib/openai/resources/responses.rb +12 -2
- data/lib/openai/version.rb +1 -1
- data/rbi/openai/models/all_models.rbi +1 -0
- data/rbi/openai/models/beta/beta_response.rbi +3 -0
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +145 -0
- data/rbi/openai/models/beta/response_compact_params.rbi +3 -0
- data/rbi/openai/models/beta/response_create_params.rbi +116 -0
- data/rbi/openai/models/chat_model.rbi +2 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +3 -0
- data/rbi/openai/models/responses/response_create_params.rbi +117 -0
- data/rbi/openai/models/responses/responses_client_event.rbi +135 -0
- data/rbi/openai/models/responses_model.rbi +1 -0
- data/rbi/openai/resources/beta/responses.rbi +10 -0
- data/rbi/openai/resources/responses.rbi +12 -0
- data/sig/openai/models/all_models.rbs +2 -0
- data/sig/openai/models/beta/beta_response.rbs +6 -0
- data/sig/openai/models/beta/beta_responses_client_event.rbs +79 -0
- data/sig/openai/models/beta/response_compact_params.rbs +6 -0
- data/sig/openai/models/beta/response_create_params.rbs +79 -0
- data/sig/openai/models/chat_model.rbs +4 -0
- data/sig/openai/models/responses/response_compact_params.rbs +6 -0
- data/sig/openai/models/responses/response_create_params.rbs +73 -0
- data/sig/openai/models/responses/responses_client_event.rbs +73 -0
- data/sig/openai/models/responses_model.rbs +2 -0
- data/sig/openai/resources/beta/responses.rbs +2 -0
- data/sig/openai/resources/responses.rbs +3 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6cf2d06fc17ac7caa92c7604d9789aa070bce9371f5938d575235dd7e453ed02
|
|
4
|
+
data.tar.gz: 8c35bc035788d11b2846612ba7b203544eaafabf962f7a6486438aba958cd9ed
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1622920a4dab1c2c238d76a5e1fa7b58e4cc326dc564a58836b6d94943bf639ed94edf1a6fc95e28b2806baf5a9ff423e819848e9e883c9013200ef9f84f682e
|
|
7
|
+
data.tar.gz: 8631e42cf7e49bc7a9c140ddd920baf1683e72df94cda1298398bb2e5e02aca459470959675a35b724c09475994fbccac0a986b337b36183064bfc8fe83fa5c0
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.126.0](https://github.com/openai/openai-ruby/compare/v0.125.0...v0.126.0) (2026-11-17)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** add 2-hour and 8-hour Responses background windows ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
|
|
9
|
+
* **api:** add the GPT-6.2 Astra Law Responses model identifier ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
|
|
10
|
+
* **api:** add the GPT-6.2 Astra model identifier ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
|
|
11
|
+
* **api:** add the GPT-6.2 Sol model identifier ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
|
|
12
|
+
|
|
3
13
|
## [0.125.0](https://github.com/openai/openai-ruby/compare/v0.124.0...v0.125.0) (2026-11-16)
|
|
4
14
|
|
|
5
15
|
|
data/README.md
CHANGED
|
@@ -750,8 +750,12 @@ module OpenAI
|
|
|
750
750
|
|
|
751
751
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_ASTRA }
|
|
752
752
|
|
|
753
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_2_ASTRA }
|
|
754
|
+
|
|
753
755
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_1_SOL }
|
|
754
756
|
|
|
757
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_2_SOL }
|
|
758
|
+
|
|
755
759
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_1_TERRA }
|
|
756
760
|
|
|
757
761
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_SOL }
|
|
@@ -970,6 +974,8 @@ module OpenAI
|
|
|
970
974
|
|
|
971
975
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_ROSALIND_RESEARCH }
|
|
972
976
|
|
|
977
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_2_ASTRA_LAW }
|
|
978
|
+
|
|
973
979
|
variant String
|
|
974
980
|
|
|
975
981
|
# @!method self.variants
|
|
@@ -982,7 +988,9 @@ module OpenAI
|
|
|
982
988
|
# @!group
|
|
983
989
|
|
|
984
990
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
991
|
+
GPT_6_2_ASTRA = :"gpt-6.2-astra"
|
|
985
992
|
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
993
|
+
GPT_6_2_SOL = :"gpt-6.2-sol"
|
|
986
994
|
GPT_6_1_TERRA = :"gpt-6.1-terra"
|
|
987
995
|
GPT_6_SOL = :"gpt-6-sol"
|
|
988
996
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
@@ -1351,6 +1359,7 @@ module OpenAI
|
|
|
1351
1359
|
GPT_5_6_CYBER = :"gpt-5.6-cyber"
|
|
1352
1360
|
GPT_6_CYBER = :"gpt-6-cyber"
|
|
1353
1361
|
GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
|
|
1362
|
+
GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
|
|
1354
1363
|
|
|
1355
1364
|
# @!endgroup
|
|
1356
1365
|
end
|
|
@@ -74,6 +74,17 @@ module OpenAI
|
|
|
74
74
|
# @return [Boolean, nil]
|
|
75
75
|
optional :background, OpenAI::Internal::Type::Boolean, nil?: true
|
|
76
76
|
|
|
77
|
+
# @!attribute background_options
|
|
78
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
79
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
80
|
+
# omitted.
|
|
81
|
+
#
|
|
82
|
+
# @return [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions, nil]
|
|
83
|
+
optional(
|
|
84
|
+
:background_options,
|
|
85
|
+
-> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions }
|
|
86
|
+
)
|
|
87
|
+
|
|
77
88
|
# @!attribute context_management
|
|
78
89
|
# Context management configuration for this request.
|
|
79
90
|
#
|
|
@@ -498,7 +509,7 @@ module OpenAI
|
|
|
498
509
|
# @return [String, nil]
|
|
499
510
|
optional :user, String
|
|
500
511
|
|
|
501
|
-
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, generate: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
512
|
+
# @!method initialize(access_programs: nil, background: nil, background_options: nil, context_management: nil, conversation: nil, generate: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
502
513
|
# Client event for creating a response over a persistent WebSocket connection.
|
|
503
514
|
# This payload uses the same top-level fields as `POST /v1/responses`, plus
|
|
504
515
|
# WebSocket-only envelope metadata.
|
|
@@ -516,6 +527,11 @@ module OpenAI
|
|
|
516
527
|
# Whether to run the model response in the background.
|
|
517
528
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
518
529
|
#
|
|
530
|
+
# @param background_options [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions]
|
|
531
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
532
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
533
|
+
# omitted.
|
|
534
|
+
#
|
|
519
535
|
# @param context_management [Array<OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::ContextManagement>, nil]
|
|
520
536
|
# Context management configuration for this request.
|
|
521
537
|
#
|
|
@@ -847,6 +863,54 @@ module OpenAI
|
|
|
847
863
|
end
|
|
848
864
|
end
|
|
849
865
|
|
|
866
|
+
# @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate#background_options
|
|
867
|
+
class BackgroundOptions < OpenAI::Internal::Type::BaseModel
|
|
868
|
+
# @!attribute completion_window
|
|
869
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
870
|
+
# `8h` select discounted background execution.
|
|
871
|
+
#
|
|
872
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow, nil]
|
|
873
|
+
optional(
|
|
874
|
+
:completion_window,
|
|
875
|
+
enum: -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow }
|
|
876
|
+
)
|
|
877
|
+
|
|
878
|
+
# @!attribute continuation_id
|
|
879
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
880
|
+
# requests. It does not add prior history to the input.
|
|
881
|
+
#
|
|
882
|
+
# @return [String, nil]
|
|
883
|
+
optional :continuation_id, String
|
|
884
|
+
|
|
885
|
+
# @!method initialize(completion_window: nil, continuation_id: nil)
|
|
886
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
887
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
888
|
+
# omitted.
|
|
889
|
+
#
|
|
890
|
+
# @param completion_window [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow]
|
|
891
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
892
|
+
# `8h` select discounted background execution.
|
|
893
|
+
#
|
|
894
|
+
# @param continuation_id [String]
|
|
895
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
896
|
+
# requests. It does not add prior history to the input.
|
|
897
|
+
|
|
898
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
899
|
+
# `8h` select discounted background execution.
|
|
900
|
+
#
|
|
901
|
+
# @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions#completion_window
|
|
902
|
+
module CompletionWindow
|
|
903
|
+
extend OpenAI::Internal::Type::Enum
|
|
904
|
+
|
|
905
|
+
SOONEST = :soonest
|
|
906
|
+
COMPLETION_WINDOW_2H = :"2h"
|
|
907
|
+
COMPLETION_WINDOW_8H = :"8h"
|
|
908
|
+
|
|
909
|
+
# @!method self.values
|
|
910
|
+
# @return [Array<Symbol>]
|
|
911
|
+
end
|
|
912
|
+
end
|
|
913
|
+
|
|
850
914
|
class ContextManagement < OpenAI::Internal::Type::BaseModel
|
|
851
915
|
# @!attribute type
|
|
852
916
|
# The context management entry type. Currently only 'compaction' is supported.
|
|
@@ -963,8 +1027,12 @@ module OpenAI
|
|
|
963
1027
|
|
|
964
1028
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_ASTRA }
|
|
965
1029
|
|
|
1030
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_2_ASTRA }
|
|
1031
|
+
|
|
966
1032
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_1_SOL }
|
|
967
1033
|
|
|
1034
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_2_SOL }
|
|
1035
|
+
|
|
968
1036
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_1_TERRA }
|
|
969
1037
|
|
|
970
1038
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_SOL }
|
|
@@ -1367,6 +1435,10 @@ module OpenAI
|
|
|
1367
1435
|
|
|
1368
1436
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_ROSALIND }
|
|
1369
1437
|
|
|
1438
|
+
variant(
|
|
1439
|
+
const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_2_ASTRA_LAW }
|
|
1440
|
+
)
|
|
1441
|
+
|
|
1370
1442
|
variant String
|
|
1371
1443
|
|
|
1372
1444
|
# @!method self.variants
|
|
@@ -1381,7 +1453,9 @@ module OpenAI
|
|
|
1381
1453
|
# @!group
|
|
1382
1454
|
|
|
1383
1455
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
1456
|
+
GPT_6_2_ASTRA = :"gpt-6.2-astra"
|
|
1384
1457
|
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
1458
|
+
GPT_6_2_SOL = :"gpt-6.2-sol"
|
|
1385
1459
|
GPT_6_1_TERRA = :"gpt-6.1-terra"
|
|
1386
1460
|
GPT_6_SOL = :"gpt-6-sol"
|
|
1387
1461
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
@@ -1751,6 +1825,7 @@ module OpenAI
|
|
|
1751
1825
|
GPT_6_CYBER = :"gpt-6-cyber"
|
|
1752
1826
|
GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
|
|
1753
1827
|
GPT_6_ROSALIND = :"gpt-6-rosalind"
|
|
1828
|
+
GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
|
|
1754
1829
|
|
|
1755
1830
|
# @!endgroup
|
|
1756
1831
|
end
|
|
@@ -189,8 +189,12 @@ module OpenAI
|
|
|
189
189
|
|
|
190
190
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_ASTRA }
|
|
191
191
|
|
|
192
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_2_ASTRA }
|
|
193
|
+
|
|
192
194
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_1_SOL }
|
|
193
195
|
|
|
196
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_2_SOL }
|
|
197
|
+
|
|
194
198
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_1_TERRA }
|
|
195
199
|
|
|
196
200
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_SOL }
|
|
@@ -415,6 +419,8 @@ module OpenAI
|
|
|
415
419
|
|
|
416
420
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_ROSALIND }
|
|
417
421
|
|
|
422
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_2_ASTRA_LAW }
|
|
423
|
+
|
|
418
424
|
variant String
|
|
419
425
|
|
|
420
426
|
# @!method self.variants
|
|
@@ -427,7 +433,9 @@ module OpenAI
|
|
|
427
433
|
# @!group
|
|
428
434
|
|
|
429
435
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
436
|
+
GPT_6_2_ASTRA = :"gpt-6.2-astra"
|
|
430
437
|
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
438
|
+
GPT_6_2_SOL = :"gpt-6.2-sol"
|
|
431
439
|
GPT_6_1_TERRA = :"gpt-6.1-terra"
|
|
432
440
|
GPT_6_SOL = :"gpt-6-sol"
|
|
433
441
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
@@ -797,6 +805,7 @@ module OpenAI
|
|
|
797
805
|
GPT_6_CYBER = :"gpt-6-cyber"
|
|
798
806
|
GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
|
|
799
807
|
GPT_6_ROSALIND = :"gpt-6-rosalind"
|
|
808
|
+
GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
|
|
800
809
|
|
|
801
810
|
# @!endgroup
|
|
802
811
|
end
|
|
@@ -23,6 +23,14 @@ module OpenAI
|
|
|
23
23
|
# @return [Boolean, nil]
|
|
24
24
|
optional :background, OpenAI::Internal::Type::Boolean, nil?: true
|
|
25
25
|
|
|
26
|
+
# @!attribute background_options
|
|
27
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
28
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
29
|
+
# omitted.
|
|
30
|
+
#
|
|
31
|
+
# @return [OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions, nil]
|
|
32
|
+
optional :background_options, -> { OpenAI::Beta::ResponseCreateParams::BackgroundOptions }
|
|
33
|
+
|
|
26
34
|
# @!attribute context_management
|
|
27
35
|
# Context management configuration for this request.
|
|
28
36
|
#
|
|
@@ -390,7 +398,7 @@ module OpenAI
|
|
|
390
398
|
# @return [Array<Symbol, OpenAI::Models::Beta::ResponseCreateParams::Beta>, nil]
|
|
391
399
|
optional :betas, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::ResponseCreateParams::Beta] }
|
|
392
400
|
|
|
393
|
-
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, betas: nil, request_options: {})
|
|
401
|
+
# @!method initialize(access_programs: nil, background: nil, background_options: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, betas: nil, request_options: {})
|
|
394
402
|
# @param access_programs [OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms]
|
|
395
403
|
# Domain-specific access programs to use for this request.
|
|
396
404
|
#
|
|
@@ -398,6 +406,11 @@ module OpenAI
|
|
|
398
406
|
# Whether to run the model response in the background.
|
|
399
407
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
400
408
|
#
|
|
409
|
+
# @param background_options [OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions]
|
|
410
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
411
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
412
|
+
# omitted.
|
|
413
|
+
#
|
|
401
414
|
# @param context_management [Array<OpenAI::Models::Beta::ResponseCreateParams::ContextManagement>, nil]
|
|
402
415
|
# Context management configuration for this request.
|
|
403
416
|
#
|
|
@@ -706,6 +719,53 @@ module OpenAI
|
|
|
706
719
|
end
|
|
707
720
|
end
|
|
708
721
|
|
|
722
|
+
class BackgroundOptions < OpenAI::Internal::Type::BaseModel
|
|
723
|
+
# @!attribute completion_window
|
|
724
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
725
|
+
# `8h` select discounted background execution.
|
|
726
|
+
#
|
|
727
|
+
# @return [Symbol, OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions::CompletionWindow, nil]
|
|
728
|
+
optional(
|
|
729
|
+
:completion_window,
|
|
730
|
+
enum: -> { OpenAI::Beta::ResponseCreateParams::BackgroundOptions::CompletionWindow }
|
|
731
|
+
)
|
|
732
|
+
|
|
733
|
+
# @!attribute continuation_id
|
|
734
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
735
|
+
# requests. It does not add prior history to the input.
|
|
736
|
+
#
|
|
737
|
+
# @return [String, nil]
|
|
738
|
+
optional :continuation_id, String
|
|
739
|
+
|
|
740
|
+
# @!method initialize(completion_window: nil, continuation_id: nil)
|
|
741
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
742
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
743
|
+
# omitted.
|
|
744
|
+
#
|
|
745
|
+
# @param completion_window [Symbol, OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions::CompletionWindow]
|
|
746
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
747
|
+
# `8h` select discounted background execution.
|
|
748
|
+
#
|
|
749
|
+
# @param continuation_id [String]
|
|
750
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
751
|
+
# requests. It does not add prior history to the input.
|
|
752
|
+
|
|
753
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
754
|
+
# `8h` select discounted background execution.
|
|
755
|
+
#
|
|
756
|
+
# @see OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions#completion_window
|
|
757
|
+
module CompletionWindow
|
|
758
|
+
extend OpenAI::Internal::Type::Enum
|
|
759
|
+
|
|
760
|
+
SOONEST = :soonest
|
|
761
|
+
COMPLETION_WINDOW_2H = :"2h"
|
|
762
|
+
COMPLETION_WINDOW_8H = :"8h"
|
|
763
|
+
|
|
764
|
+
# @!method self.values
|
|
765
|
+
# @return [Array<Symbol>]
|
|
766
|
+
end
|
|
767
|
+
end
|
|
768
|
+
|
|
709
769
|
class ContextManagement < OpenAI::Internal::Type::BaseModel
|
|
710
770
|
# @!attribute type
|
|
711
771
|
# The context management entry type. Currently only 'compaction' is supported.
|
|
@@ -812,8 +872,12 @@ module OpenAI
|
|
|
812
872
|
|
|
813
873
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_ASTRA }
|
|
814
874
|
|
|
875
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_2_ASTRA }
|
|
876
|
+
|
|
815
877
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_1_SOL }
|
|
816
878
|
|
|
879
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_2_SOL }
|
|
880
|
+
|
|
817
881
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_1_TERRA }
|
|
818
882
|
|
|
819
883
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_SOL }
|
|
@@ -1036,6 +1100,8 @@ module OpenAI
|
|
|
1036
1100
|
|
|
1037
1101
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_ROSALIND }
|
|
1038
1102
|
|
|
1103
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_2_ASTRA_LAW }
|
|
1104
|
+
|
|
1039
1105
|
variant String
|
|
1040
1106
|
|
|
1041
1107
|
# @!method self.variants
|
|
@@ -1048,7 +1114,9 @@ module OpenAI
|
|
|
1048
1114
|
# @!group
|
|
1049
1115
|
|
|
1050
1116
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
1117
|
+
GPT_6_2_ASTRA = :"gpt-6.2-astra"
|
|
1051
1118
|
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
1119
|
+
GPT_6_2_SOL = :"gpt-6.2-sol"
|
|
1052
1120
|
GPT_6_1_TERRA = :"gpt-6.1-terra"
|
|
1053
1121
|
GPT_6_SOL = :"gpt-6-sol"
|
|
1054
1122
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
@@ -1418,6 +1486,7 @@ module OpenAI
|
|
|
1418
1486
|
GPT_6_CYBER = :"gpt-6-cyber"
|
|
1419
1487
|
GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
|
|
1420
1488
|
GPT_6_ROSALIND = :"gpt-6-rosalind"
|
|
1489
|
+
GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
|
|
1421
1490
|
|
|
1422
1491
|
# @!endgroup
|
|
1423
1492
|
end
|
|
@@ -6,7 +6,9 @@ module OpenAI
|
|
|
6
6
|
extend OpenAI::Internal::Type::Enum
|
|
7
7
|
|
|
8
8
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
9
|
+
GPT_6_2_ASTRA = :"gpt-6.2-astra"
|
|
9
10
|
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
11
|
+
GPT_6_2_SOL = :"gpt-6.2-sol"
|
|
10
12
|
GPT_6_1_TERRA = :"gpt-6.1-terra"
|
|
11
13
|
GPT_6_SOL = :"gpt-6-sol"
|
|
12
14
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
@@ -180,8 +180,12 @@ module OpenAI
|
|
|
180
180
|
|
|
181
181
|
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_ASTRA }
|
|
182
182
|
|
|
183
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_2_ASTRA }
|
|
184
|
+
|
|
183
185
|
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_1_SOL }
|
|
184
186
|
|
|
187
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_2_SOL }
|
|
188
|
+
|
|
185
189
|
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_1_TERRA }
|
|
186
190
|
|
|
187
191
|
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_SOL }
|
|
@@ -420,6 +424,8 @@ module OpenAI
|
|
|
420
424
|
|
|
421
425
|
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_ROSALIND }
|
|
422
426
|
|
|
427
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_2_ASTRA_LAW }
|
|
428
|
+
|
|
423
429
|
variant String
|
|
424
430
|
|
|
425
431
|
# @!method self.variants
|
|
@@ -432,7 +438,9 @@ module OpenAI
|
|
|
432
438
|
# @!group
|
|
433
439
|
|
|
434
440
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
441
|
+
GPT_6_2_ASTRA = :"gpt-6.2-astra"
|
|
435
442
|
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
443
|
+
GPT_6_2_SOL = :"gpt-6.2-sol"
|
|
436
444
|
GPT_6_1_TERRA = :"gpt-6.1-terra"
|
|
437
445
|
GPT_6_SOL = :"gpt-6-sol"
|
|
438
446
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
@@ -802,6 +810,7 @@ module OpenAI
|
|
|
802
810
|
GPT_6_CYBER = :"gpt-6-cyber"
|
|
803
811
|
GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
|
|
804
812
|
GPT_6_ROSALIND = :"gpt-6-rosalind"
|
|
813
|
+
GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
|
|
805
814
|
|
|
806
815
|
# @!endgroup
|
|
807
816
|
end
|
|
@@ -23,6 +23,14 @@ module OpenAI
|
|
|
23
23
|
# @return [Boolean, nil]
|
|
24
24
|
optional :background, OpenAI::Internal::Type::Boolean, nil?: true
|
|
25
25
|
|
|
26
|
+
# @!attribute background_options
|
|
27
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
28
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
29
|
+
# omitted.
|
|
30
|
+
#
|
|
31
|
+
# @return [OpenAI::Models::Responses::ResponseCreateParams::BackgroundOptions, nil]
|
|
32
|
+
optional :background_options, -> { OpenAI::Responses::ResponseCreateParams::BackgroundOptions }
|
|
33
|
+
|
|
26
34
|
# @!attribute context_management
|
|
27
35
|
# Context management configuration for this request.
|
|
28
36
|
#
|
|
@@ -390,7 +398,7 @@ module OpenAI
|
|
|
390
398
|
# @return [String, nil]
|
|
391
399
|
optional :user, String
|
|
392
400
|
|
|
393
|
-
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
401
|
+
# @!method initialize(access_programs: nil, background: nil, background_options: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
394
402
|
# @param access_programs [OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms]
|
|
395
403
|
# Domain-specific access programs to use for this request.
|
|
396
404
|
#
|
|
@@ -398,6 +406,11 @@ module OpenAI
|
|
|
398
406
|
# Whether to run the model response in the background.
|
|
399
407
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
400
408
|
#
|
|
409
|
+
# @param background_options [OpenAI::Models::Responses::ResponseCreateParams::BackgroundOptions]
|
|
410
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
411
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
412
|
+
# omitted.
|
|
413
|
+
#
|
|
401
414
|
# @param context_management [Array<OpenAI::Models::Responses::ResponseCreateParams::ContextManagement>, nil]
|
|
402
415
|
# Context management configuration for this request.
|
|
403
416
|
#
|
|
@@ -701,6 +714,53 @@ module OpenAI
|
|
|
701
714
|
end
|
|
702
715
|
end
|
|
703
716
|
|
|
717
|
+
class BackgroundOptions < OpenAI::Internal::Type::BaseModel
|
|
718
|
+
# @!attribute completion_window
|
|
719
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
720
|
+
# `8h` select discounted background execution.
|
|
721
|
+
#
|
|
722
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseCreateParams::BackgroundOptions::CompletionWindow, nil]
|
|
723
|
+
optional(
|
|
724
|
+
:completion_window,
|
|
725
|
+
enum: -> { OpenAI::Responses::ResponseCreateParams::BackgroundOptions::CompletionWindow }
|
|
726
|
+
)
|
|
727
|
+
|
|
728
|
+
# @!attribute continuation_id
|
|
729
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
730
|
+
# requests. It does not add prior history to the input.
|
|
731
|
+
#
|
|
732
|
+
# @return [String, nil]
|
|
733
|
+
optional :continuation_id, String
|
|
734
|
+
|
|
735
|
+
# @!method initialize(completion_window: nil, continuation_id: nil)
|
|
736
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
737
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
738
|
+
# omitted.
|
|
739
|
+
#
|
|
740
|
+
# @param completion_window [Symbol, OpenAI::Models::Responses::ResponseCreateParams::BackgroundOptions::CompletionWindow]
|
|
741
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
742
|
+
# `8h` select discounted background execution.
|
|
743
|
+
#
|
|
744
|
+
# @param continuation_id [String]
|
|
745
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
746
|
+
# requests. It does not add prior history to the input.
|
|
747
|
+
|
|
748
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
749
|
+
# `8h` select discounted background execution.
|
|
750
|
+
#
|
|
751
|
+
# @see OpenAI::Models::Responses::ResponseCreateParams::BackgroundOptions#completion_window
|
|
752
|
+
module CompletionWindow
|
|
753
|
+
extend OpenAI::Internal::Type::Enum
|
|
754
|
+
|
|
755
|
+
SOONEST = :soonest
|
|
756
|
+
COMPLETION_WINDOW_2H = :"2h"
|
|
757
|
+
COMPLETION_WINDOW_8H = :"8h"
|
|
758
|
+
|
|
759
|
+
# @!method self.values
|
|
760
|
+
# @return [Array<Symbol>]
|
|
761
|
+
end
|
|
762
|
+
end
|
|
763
|
+
|
|
704
764
|
class ContextManagement < OpenAI::Internal::Type::BaseModel
|
|
705
765
|
# @!attribute type
|
|
706
766
|
# The context management entry type. Currently only 'compaction' is supported.
|
|
@@ -69,6 +69,17 @@ module OpenAI
|
|
|
69
69
|
# @return [Boolean, nil]
|
|
70
70
|
optional :background, OpenAI::Internal::Type::Boolean, nil?: true
|
|
71
71
|
|
|
72
|
+
# @!attribute background_options
|
|
73
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
74
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
75
|
+
# omitted.
|
|
76
|
+
#
|
|
77
|
+
# @return [OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions, nil]
|
|
78
|
+
optional(
|
|
79
|
+
:background_options,
|
|
80
|
+
-> { OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions }
|
|
81
|
+
)
|
|
82
|
+
|
|
72
83
|
# @!attribute context_management
|
|
73
84
|
# Context management configuration for this request.
|
|
74
85
|
#
|
|
@@ -479,7 +490,7 @@ module OpenAI
|
|
|
479
490
|
# @return [String, nil]
|
|
480
491
|
optional :user, String
|
|
481
492
|
|
|
482
|
-
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, generate: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
493
|
+
# @!method initialize(access_programs: nil, background: nil, background_options: nil, context_management: nil, conversation: nil, generate: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
483
494
|
# Client event for creating a response over a persistent WebSocket connection.
|
|
484
495
|
# This payload uses the same top-level fields as `POST /v1/responses`, plus
|
|
485
496
|
# WebSocket-only envelope metadata.
|
|
@@ -497,6 +508,11 @@ module OpenAI
|
|
|
497
508
|
# Whether to run the model response in the background.
|
|
498
509
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
499
510
|
#
|
|
511
|
+
# @param background_options [OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions]
|
|
512
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
513
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
514
|
+
# omitted.
|
|
515
|
+
#
|
|
500
516
|
# @param context_management [Array<OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement>, nil]
|
|
501
517
|
# Context management configuration for this request.
|
|
502
518
|
#
|
|
@@ -825,6 +841,54 @@ module OpenAI
|
|
|
825
841
|
end
|
|
826
842
|
end
|
|
827
843
|
|
|
844
|
+
# @see OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate#background_options
|
|
845
|
+
class BackgroundOptions < OpenAI::Internal::Type::BaseModel
|
|
846
|
+
# @!attribute completion_window
|
|
847
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
848
|
+
# `8h` select discounted background execution.
|
|
849
|
+
#
|
|
850
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow, nil]
|
|
851
|
+
optional(
|
|
852
|
+
:completion_window,
|
|
853
|
+
enum: -> { OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow }
|
|
854
|
+
)
|
|
855
|
+
|
|
856
|
+
# @!attribute continuation_id
|
|
857
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
858
|
+
# requests. It does not add prior history to the input.
|
|
859
|
+
#
|
|
860
|
+
# @return [String, nil]
|
|
861
|
+
optional :continuation_id, String
|
|
862
|
+
|
|
863
|
+
# @!method initialize(completion_window: nil, continuation_id: nil)
|
|
864
|
+
# Options for background execution on HTTP requests. The `2h` and `8h` completion
|
|
865
|
+
# windows require `background: true`, Standard processing, and `stream: false` or
|
|
866
|
+
# omitted.
|
|
867
|
+
#
|
|
868
|
+
# @param completion_window [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow]
|
|
869
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
870
|
+
# `8h` select discounted background execution.
|
|
871
|
+
#
|
|
872
|
+
# @param continuation_id [String]
|
|
873
|
+
# A customer-provided opaque identifier used to prioritize related background
|
|
874
|
+
# requests. It does not add prior history to the input.
|
|
875
|
+
|
|
876
|
+
# The completion window for background execution. Defaults to `soonest`; `2h` and
|
|
877
|
+
# `8h` select discounted background execution.
|
|
878
|
+
#
|
|
879
|
+
# @see OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions#completion_window
|
|
880
|
+
module CompletionWindow
|
|
881
|
+
extend OpenAI::Internal::Type::Enum
|
|
882
|
+
|
|
883
|
+
SOONEST = :soonest
|
|
884
|
+
COMPLETION_WINDOW_2H = :"2h"
|
|
885
|
+
COMPLETION_WINDOW_8H = :"8h"
|
|
886
|
+
|
|
887
|
+
# @!method self.values
|
|
888
|
+
# @return [Array<Symbol>]
|
|
889
|
+
end
|
|
890
|
+
end
|
|
891
|
+
|
|
828
892
|
class ContextManagement < OpenAI::Internal::Type::BaseModel
|
|
829
893
|
# @!attribute type
|
|
830
894
|
# The context management entry type. Currently only 'compaction' is supported.
|