openai 0.77.1 → 0.79.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 +98 -0
- data/README.md +341 -10
- data/SECURITY.md +6 -22
- data/azure.md +110 -0
- data/bedrock.md +132 -0
- data/examples/mtls_custom_http_client.rb +61 -0
- data/lib/openai/auth/workload_identity.rb +13 -2
- data/lib/openai/auth/workload_identity_auth.rb +2 -1
- data/lib/openai/client.rb +34 -14
- data/lib/openai/errors.rb +11 -1
- data/lib/openai/helpers/streaming/chat_completion_stream.rb +3 -3
- data/lib/openai/helpers/streaming/response_stream.rb +5 -6
- data/lib/openai/helpers/structured_output/base_model.rb +20 -19
- data/lib/openai/helpers/structured_output/json_schema_converter.rb +12 -5
- data/lib/openai/http_client.rb +189 -0
- data/lib/openai/internal/conversation_cursor_page.rb +5 -6
- data/lib/openai/internal/cursor_page.rb +3 -3
- data/lib/openai/internal/logging.rb +419 -0
- data/lib/openai/internal/next_cursor_page.rb +5 -6
- data/lib/openai/internal/page.rb +2 -2
- data/lib/openai/internal/provider.rb +7 -1
- data/lib/openai/internal/read_io_adapter.rb +161 -0
- data/lib/openai/internal/stream.rb +2 -2
- data/lib/openai/internal/transport/base_client.rb +216 -57
- data/lib/openai/internal/type/array_of.rb +6 -4
- data/lib/openai/internal/type/base_model.rb +39 -1
- data/lib/openai/internal/type/base_page.rb +19 -2
- data/lib/openai/internal/type/base_stream.rb +40 -8
- data/lib/openai/internal/type/hash_of.rb +3 -3
- data/lib/openai/internal/util.rb +59 -112
- data/lib/openai/models/admin/organization/audit_log_list_params.rb +3 -1
- data/lib/openai/models/admin/organization/audit_log_list_response.rb +33 -11
- data/lib/openai/models/admin/organization/groups/role_list_response.rb +5 -1
- data/lib/openai/models/admin/organization/groups/role_retrieve_response.rb +5 -1
- data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb +6 -1
- data/lib/openai/models/admin/organization/projects/groups/role_retrieve_response.rb +6 -1
- data/lib/openai/models/admin/organization/projects/service_account_create_response.rb +3 -1
- data/lib/openai/models/admin/organization/projects/users/role_list_response.rb +6 -1
- data/lib/openai/models/admin/organization/projects/users/role_retrieve_response.rb +6 -1
- data/lib/openai/models/admin/organization/users/role_list_response.rb +5 -1
- data/lib/openai/models/admin/organization/users/role_retrieve_response.rb +5 -1
- data/lib/openai/models/all_models.rb +3 -0
- data/lib/openai/models/audio/transcription_create_params.rb +7 -1
- data/lib/openai/models/audio/translation_create_params.rb +7 -1
- data/lib/openai/models/beta/beta_response.rb +9 -0
- data/lib/openai/models/beta/beta_response_stream_event.rb +1 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +28 -3
- data/lib/openai/models/beta/beta_responses_server_event.rb +1037 -61
- data/lib/openai/models/beta/response_compact_params.rb +9 -0
- data/lib/openai/models/beta/response_create_params.rb +9 -0
- data/lib/openai/models/containers/file_create_params.rb +4 -0
- data/lib/openai/models/content_provenance_check_create_params.rb +4 -0
- data/lib/openai/models/file_create_params.rb +4 -0
- data/lib/openai/models/image_create_variation_params.rb +4 -0
- data/lib/openai/models/image_edit_params.rb +8 -0
- data/lib/openai/models/responses/response_compact_params.rb +9 -0
- data/lib/openai/models/responses/response_stream_event.rb +1 -1
- data/lib/openai/models/responses/responses_client_event.rb +13 -1
- data/lib/openai/models/responses/responses_server_event.rb +1027 -54
- data/lib/openai/models/responses_model.rb +3 -0
- data/lib/openai/models/skill_create_params.rb +4 -0
- data/lib/openai/models/skills/version_create_params.rb +4 -0
- data/lib/openai/models/uploads/part_create_params.rb +4 -0
- data/lib/openai/models/vector_store_search_response.rb +3 -1
- data/lib/openai/models/video_create_character_params.rb +4 -0
- data/lib/openai/models/video_create_params.rb +4 -0
- data/lib/openai/models/video_edit_params.rb +4 -0
- data/lib/openai/models/video_extend_params.rb +4 -0
- data/lib/openai/models.rb +9 -1
- data/lib/openai/net_http_client.rb +295 -0
- data/lib/openai/providers/azure.rb +216 -0
- data/lib/openai/providers/bedrock.rb +3 -1
- data/lib/openai/resources/admin/organization/projects/groups/roles.rb +1 -1
- data/lib/openai/resources/admin/organization/projects/groups.rb +1 -1
- data/lib/openai/resources/admin/organization/projects/users/roles.rb +1 -1
- data/lib/openai/resources/admin/organization/projects.rb +4 -2
- data/lib/openai/resources/audio/transcriptions.rb +8 -0
- data/lib/openai/resources/audio/translations.rb +4 -0
- data/lib/openai/resources/beta/responses.rb +1 -1
- data/lib/openai/resources/beta/threads/runs/steps.rb +2 -2
- data/lib/openai/resources/containers/files.rb +4 -0
- data/lib/openai/resources/content_provenance_checks.rb +4 -0
- data/lib/openai/resources/conversations/items.rb +1 -1
- data/lib/openai/resources/evals/runs/output_items.rb +1 -1
- data/lib/openai/resources/files.rb +4 -0
- data/lib/openai/resources/images.rb +12 -0
- data/lib/openai/resources/responses.rb +3 -2
- data/lib/openai/resources/skills/versions.rb +4 -0
- data/lib/openai/resources/skills.rb +4 -0
- data/lib/openai/resources/uploads/parts.rb +4 -0
- data/lib/openai/resources/vector_stores/file_batches.rb +1 -1
- data/lib/openai/resources/videos.rb +38 -0
- data/lib/openai/resources/webhooks.rb +18 -6
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +113 -108
- data/rbi/openai/auth.rbi +4 -4
- data/rbi/openai/client.rbi +15 -3
- data/rbi/openai/errors.rbi +7 -0
- data/rbi/openai/helpers/streaming/events.rbi +12 -0
- data/rbi/openai/http_client.rbi +123 -0
- data/rbi/openai/internal/logging.rbi +192 -0
- data/rbi/openai/internal/provider.rbi +3 -0
- data/rbi/openai/internal/read_io_adapter.rbi +52 -0
- data/rbi/openai/internal/transport/base_client.rbi +80 -10
- data/rbi/openai/internal/type/base_model.rbi +24 -1
- data/rbi/openai/internal/type/base_page.rbi +13 -2
- data/rbi/openai/internal/type/base_stream.rbi +16 -5
- data/rbi/openai/internal/util.rbi +26 -42
- data/rbi/openai/models/admin/organization/audit_log_list_params.rbi +5 -0
- data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +5 -0
- data/rbi/openai/models/all_models.rbi +15 -0
- data/rbi/openai/models/audio/transcription_create_params.rbi +14 -2
- data/rbi/openai/models/audio/translation_create_params.rbi +14 -2
- data/rbi/openai/models/beta/beta_response.rbi +15 -0
- data/rbi/openai/models/beta/beta_response_stream_event.rbi +1 -1
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +37 -1
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +3791 -54
- data/rbi/openai/models/beta/response_compact_params.rbi +15 -0
- data/rbi/openai/models/beta/response_create_params.rbi +15 -0
- data/rbi/openai/models/containers/file_create_params.rbi +8 -0
- data/rbi/openai/models/content_provenance_check_create_params.rbi +8 -0
- data/rbi/openai/models/file_create_params.rbi +8 -0
- data/rbi/openai/models/image_create_variation_params.rbi +8 -0
- data/rbi/openai/models/image_edit_params.rbi +16 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +15 -0
- data/rbi/openai/models/responses/response_stream_event.rbi +1 -1
- data/rbi/openai/models/responses/responses_client_event.rbi +19 -0
- data/rbi/openai/models/responses/responses_server_event.rbi +3282 -53
- data/rbi/openai/models/responses_model.rbi +15 -0
- data/rbi/openai/models/skill_create_params.rbi +8 -0
- data/rbi/openai/models/skills/version_create_params.rbi +8 -0
- data/rbi/openai/models/uploads/part_create_params.rbi +8 -0
- data/rbi/openai/models/video_create_character_params.rbi +8 -0
- data/rbi/openai/models/video_create_params.rbi +8 -0
- data/rbi/openai/models/video_edit_params.rbi +8 -0
- data/rbi/openai/models/video_extend_params.rbi +8 -0
- data/rbi/openai/net_http_client.rbi +64 -0
- data/rbi/openai/providers.rbi +9 -0
- data/rbi/openai/resources/audio/transcriptions.rbi +14 -2
- data/rbi/openai/resources/audio/translations.rbi +7 -1
- data/rbi/openai/resources/containers/files.rbi +4 -0
- data/rbi/openai/resources/content_provenance_checks.rbi +4 -0
- data/rbi/openai/resources/files.rbi +4 -0
- data/rbi/openai/resources/images.rbi +20 -0
- data/rbi/openai/resources/skills/versions.rbi +4 -0
- data/rbi/openai/resources/skills.rbi +4 -0
- data/rbi/openai/resources/uploads/parts.rbi +4 -0
- data/rbi/openai/resources/videos.rbi +16 -0
- data/sig/openai/client.rbs +7 -2
- data/sig/openai/errors.rbs +5 -0
- data/sig/openai/http_client.rbs +76 -0
- data/sig/openai/internal/logging.rbs +88 -0
- data/sig/openai/internal/provider.rbs +3 -1
- data/sig/openai/internal/read_io_adapter.rbs +23 -0
- data/sig/openai/internal/transport/base_client.rbs +41 -6
- data/sig/openai/internal/type/base_model.rbs +13 -0
- data/sig/openai/internal/type/base_page.rbs +8 -1
- data/sig/openai/internal/type/base_stream.rbs +9 -3
- data/sig/openai/internal/util.rbs +12 -16
- data/sig/openai/models/admin/organization/audit_log_list_params.rbs +2 -0
- data/sig/openai/models/admin/organization/audit_log_list_response.rbs +2 -0
- data/sig/openai/models/all_models.rbs +6 -0
- data/sig/openai/models/beta/beta_response.rbs +6 -0
- data/sig/openai/models/beta/beta_responses_client_event.rbs +13 -0
- data/sig/openai/models/beta/beta_responses_server_event.rbs +1946 -54
- data/sig/openai/models/beta/response_compact_params.rbs +6 -0
- data/sig/openai/models/beta/response_create_params.rbs +6 -0
- data/sig/openai/models/responses/response_compact_params.rbs +6 -0
- data/sig/openai/models/responses/responses_client_event.rbs +7 -0
- data/sig/openai/models/responses/responses_server_event.rbs +1786 -53
- data/sig/openai/models/responses_model.rbs +6 -0
- data/sig/openai/net_http_client.rbs +34 -0
- data/sig/openai/providers.rbs +6 -0
- metadata +33 -4
- data/lib/openai/internal/transport/pooled_net_requester.rb +0 -210
- data/rbi/openai/internal/transport/pooled_net_requester.rbi +0 -82
- data/sig/openai/internal/transport/pooled_net_requester.rbs +0 -48
|
@@ -19,7 +19,12 @@ module OpenAI
|
|
|
19
19
|
#
|
|
20
20
|
# @return [Array<OpenAI::Models::Admin::Organization::Projects::Groups::RoleRetrieveResponse::AssignmentSource>, nil]
|
|
21
21
|
required :assignment_sources,
|
|
22
|
-
->
|
|
22
|
+
-> do
|
|
23
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
24
|
+
OpenAI::Models::Admin::Organization::Projects::Groups::RoleRetrieveResponse::
|
|
25
|
+
AssignmentSource
|
|
26
|
+
]
|
|
27
|
+
end,
|
|
23
28
|
nil?: true
|
|
24
29
|
|
|
25
30
|
# @!attribute created_at
|
|
@@ -16,7 +16,9 @@ module OpenAI
|
|
|
16
16
|
#
|
|
17
17
|
# @return [OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateResponse::APIKey, nil]
|
|
18
18
|
required :api_key,
|
|
19
|
-
-> {
|
|
19
|
+
-> {
|
|
20
|
+
OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateResponse::APIKey
|
|
21
|
+
},
|
|
20
22
|
nil?: true
|
|
21
23
|
|
|
22
24
|
# @!attribute created_at
|
|
@@ -19,7 +19,12 @@ module OpenAI
|
|
|
19
19
|
#
|
|
20
20
|
# @return [Array<OpenAI::Models::Admin::Organization::Projects::Users::RoleListResponse::AssignmentSource>, nil]
|
|
21
21
|
required :assignment_sources,
|
|
22
|
-
->
|
|
22
|
+
-> do
|
|
23
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
24
|
+
OpenAI::Models::Admin::Organization::Projects::Users::RoleListResponse::
|
|
25
|
+
AssignmentSource
|
|
26
|
+
]
|
|
27
|
+
end,
|
|
23
28
|
nil?: true
|
|
24
29
|
|
|
25
30
|
# @!attribute created_at
|
|
@@ -19,7 +19,12 @@ module OpenAI
|
|
|
19
19
|
#
|
|
20
20
|
# @return [Array<OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource>, nil]
|
|
21
21
|
required :assignment_sources,
|
|
22
|
-
->
|
|
22
|
+
-> do
|
|
23
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
24
|
+
OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::
|
|
25
|
+
AssignmentSource
|
|
26
|
+
]
|
|
27
|
+
end,
|
|
23
28
|
nil?: true
|
|
24
29
|
|
|
25
30
|
# @!attribute created_at
|
|
@@ -18,7 +18,11 @@ module OpenAI
|
|
|
18
18
|
#
|
|
19
19
|
# @return [Array<OpenAI::Models::Admin::Organization::Users::RoleListResponse::AssignmentSource>, nil]
|
|
20
20
|
required :assignment_sources,
|
|
21
|
-
->
|
|
21
|
+
-> do
|
|
22
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
23
|
+
OpenAI::Models::Admin::Organization::Users::RoleListResponse::AssignmentSource
|
|
24
|
+
]
|
|
25
|
+
end,
|
|
22
26
|
nil?: true
|
|
23
27
|
|
|
24
28
|
# @!attribute created_at
|
|
@@ -18,7 +18,11 @@ module OpenAI
|
|
|
18
18
|
#
|
|
19
19
|
# @return [Array<OpenAI::Models::Admin::Organization::Users::RoleRetrieveResponse::AssignmentSource>, nil]
|
|
20
20
|
required :assignment_sources,
|
|
21
|
-
->
|
|
21
|
+
-> do
|
|
22
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
23
|
+
OpenAI::Models::Admin::Organization::Users::RoleRetrieveResponse::AssignmentSource
|
|
24
|
+
]
|
|
25
|
+
end,
|
|
22
26
|
nil?: true
|
|
23
27
|
|
|
24
28
|
# @!attribute created_at
|
|
@@ -28,6 +28,9 @@ module OpenAI
|
|
|
28
28
|
GPT_5_PRO = :"gpt-5-pro"
|
|
29
29
|
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
30
30
|
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
31
|
+
GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
|
|
32
|
+
GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
|
|
33
|
+
GPT_5_6_CYBER = :"gpt-5.6-cyber"
|
|
31
34
|
|
|
32
35
|
# @!method self.values
|
|
33
36
|
# @return [Array<Symbol>]
|
|
@@ -12,7 +12,13 @@ module OpenAI
|
|
|
12
12
|
|
|
13
13
|
# @!attribute file
|
|
14
14
|
# The audio file object (not file name) to transcribe, in one of these formats:
|
|
15
|
-
# flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
|
|
15
|
+
# flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include
|
|
16
|
+
# enough format metadata for the file to be identified. We recommend an
|
|
17
|
+
# extension-bearing filename and an appropriate content type.
|
|
18
|
+
#
|
|
19
|
+
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
20
|
+
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
21
|
+
# content type.
|
|
16
22
|
#
|
|
17
23
|
# @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
|
|
18
24
|
required :file, OpenAI::Internal::Type::FileInput
|
|
@@ -10,7 +10,13 @@ module OpenAI
|
|
|
10
10
|
|
|
11
11
|
# @!attribute file
|
|
12
12
|
# The audio file object (not file name) translate, in one of these formats: flac,
|
|
13
|
-
# mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
|
|
13
|
+
# mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough
|
|
14
|
+
# format metadata for the file to be identified. We recommend an extension-bearing
|
|
15
|
+
# filename and an appropriate content type.
|
|
16
|
+
#
|
|
17
|
+
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
18
|
+
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
19
|
+
# content type.
|
|
14
20
|
#
|
|
15
21
|
# @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
|
|
16
22
|
required :file, OpenAI::Internal::Type::FileInput
|
|
@@ -667,6 +667,12 @@ module OpenAI
|
|
|
667
667
|
|
|
668
668
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_1_CODEX_MAX }
|
|
669
669
|
|
|
670
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_DAYBREAK_BLUE_LATEST }
|
|
671
|
+
|
|
672
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_DAYBREAK_RED_LATEST }
|
|
673
|
+
|
|
674
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_6_CYBER }
|
|
675
|
+
|
|
670
676
|
variant String
|
|
671
677
|
|
|
672
678
|
# @!method self.variants
|
|
@@ -774,6 +780,9 @@ module OpenAI
|
|
|
774
780
|
GPT_5_PRO = :"gpt-5-pro"
|
|
775
781
|
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
776
782
|
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
783
|
+
GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
|
|
784
|
+
GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
|
|
785
|
+
GPT_5_6_CYBER = :"gpt-5.6-cyber"
|
|
777
786
|
|
|
778
787
|
# @!endgroup
|
|
779
788
|
end
|
|
@@ -10,11 +10,13 @@ module OpenAI
|
|
|
10
10
|
discriminator :type
|
|
11
11
|
|
|
12
12
|
# Client event for creating a response over a persistent WebSocket connection.
|
|
13
|
-
# This payload uses the same top-level fields as `POST /v1/responses
|
|
13
|
+
# This payload uses the same top-level fields as `POST /v1/responses`, plus
|
|
14
|
+
# WebSocket-only envelope metadata.
|
|
14
15
|
#
|
|
15
16
|
# Notes:
|
|
16
17
|
# - `stream` is implicit over WebSocket and should not be sent.
|
|
17
18
|
# - `background` is not supported over WebSocket.
|
|
19
|
+
# - `stream_id` is WebSocket-only and is not part of `POST /v1/responses`.
|
|
18
20
|
variant :"response.create", -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate }
|
|
19
21
|
|
|
20
22
|
# Injects input items into an active response over a WebSocket connection.
|
|
@@ -299,6 +301,16 @@ module OpenAI
|
|
|
299
301
|
# @return [Boolean, nil]
|
|
300
302
|
optional :stream, OpenAI::Internal::Type::Boolean, nil?: true
|
|
301
303
|
|
|
304
|
+
# @!attribute stream_id
|
|
305
|
+
# The WebSocket lane for this response. Requests with the same `stream_id` are
|
|
306
|
+
# processed FIFO, and events for the response echo the same `stream_id`.
|
|
307
|
+
#
|
|
308
|
+
# `stream_id` controls routing; `previous_response_id` controls conversation
|
|
309
|
+
# lineage, so a new lane can fork from a response created on another lane.
|
|
310
|
+
#
|
|
311
|
+
# @return [String, nil]
|
|
312
|
+
optional :stream_id, String
|
|
313
|
+
|
|
302
314
|
# @!attribute stream_options
|
|
303
315
|
# Options for streaming responses. Only set this when you set `stream: true`.
|
|
304
316
|
#
|
|
@@ -404,18 +416,20 @@ module OpenAI
|
|
|
404
416
|
# @return [String, nil]
|
|
405
417
|
optional :user, String
|
|
406
418
|
|
|
407
|
-
# @!method initialize(background: nil, context_management: nil, conversation: 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_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
419
|
+
# @!method initialize(background: nil, context_management: nil, conversation: 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")
|
|
408
420
|
# Some parameter documentations has been truncated, see
|
|
409
421
|
# {OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate} for more
|
|
410
422
|
# details.
|
|
411
423
|
#
|
|
412
424
|
# Client event for creating a response over a persistent WebSocket connection.
|
|
413
|
-
# This payload uses the same top-level fields as `POST /v1/responses
|
|
425
|
+
# This payload uses the same top-level fields as `POST /v1/responses`, plus
|
|
426
|
+
# WebSocket-only envelope metadata.
|
|
414
427
|
#
|
|
415
428
|
# Notes:
|
|
416
429
|
#
|
|
417
430
|
# - `stream` is implicit over WebSocket and should not be sent.
|
|
418
431
|
# - `background` is not supported over WebSocket.
|
|
432
|
+
# - `stream_id` is WebSocket-only and is not part of `POST /v1/responses`.
|
|
419
433
|
#
|
|
420
434
|
# @param background [Boolean, nil] Whether to run the model response in the background.
|
|
421
435
|
#
|
|
@@ -463,6 +477,8 @@ module OpenAI
|
|
|
463
477
|
#
|
|
464
478
|
# @param stream [Boolean, nil] If set to true, the model response data will be streamed to the client
|
|
465
479
|
#
|
|
480
|
+
# @param stream_id [String] The WebSocket lane for this response. Requests with the same
|
|
481
|
+
#
|
|
466
482
|
# @param stream_options [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::StreamOptions, nil] Options for streaming responses. Only set this when you set `stream: true`.
|
|
467
483
|
#
|
|
468
484
|
# @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
|
|
@@ -749,6 +765,12 @@ module OpenAI
|
|
|
749
765
|
|
|
750
766
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_5_1_CODEX_MAX }
|
|
751
767
|
|
|
768
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_DAYBREAK_BLUE_LATEST }
|
|
769
|
+
|
|
770
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_DAYBREAK_RED_LATEST }
|
|
771
|
+
|
|
772
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_5_6_CYBER }
|
|
773
|
+
|
|
752
774
|
variant String
|
|
753
775
|
|
|
754
776
|
# @!method self.variants
|
|
@@ -856,6 +878,9 @@ module OpenAI
|
|
|
856
878
|
GPT_5_PRO = :"gpt-5-pro"
|
|
857
879
|
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
858
880
|
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
881
|
+
GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
|
|
882
|
+
GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
|
|
883
|
+
GPT_5_6_CYBER = :"gpt-5.6-cyber"
|
|
859
884
|
|
|
860
885
|
# @!endgroup
|
|
861
886
|
end
|