openai 0.95.0 → 0.96.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 +44 -0
- data/README.md +5 -2
- data/docs/architecture/security-model.md +2 -2
- data/examples/audio/record_and_play.rb +1 -1
- data/lib/openai/helpers/live/transcript_grouper.rb +264 -0
- data/lib/openai/helpers/live/transcript_grouping.rb +309 -0
- data/lib/openai/helpers/live/websocket.rb +454 -0
- data/lib/openai/helpers/realtime/translation.rb +440 -0
- data/lib/openai/helpers/realtime.rb +1 -0
- data/lib/openai/helpers/responses_websocket/incremental.rb +246 -0
- data/lib/openai/helpers/responses_websocket/transports/async_websocket.rb +183 -0
- data/lib/openai/helpers/responses_websocket.rb +1 -0
- data/lib/openai/helpers/streaming/response_stream.rb +19 -11
- data/lib/openai/helpers/structured_output/chat_completion_parser.rb +0 -2
- data/lib/openai/helpers/structured_output/response_parser.rb +1 -2
- data/lib/openai/helpers/structured_output/union_of.rb +0 -2
- data/lib/openai/helpers/websocket/async_websocket_transport.rb +11 -6
- data/lib/openai/helpers/websocket/connection_manager.rb +9 -0
- data/lib/openai/internal/read_io_adapter.rb +0 -2
- data/lib/openai/internal/stream.rb +0 -2
- data/lib/openai/internal/type/base_model.rb +4 -6
- data/lib/openai/internal/type/converter.rb +5 -3
- data/lib/openai/internal/type/enum.rb +0 -2
- data/lib/openai/internal/type/union.rb +0 -6
- data/lib/openai/internal/type/unknown.rb +34 -6
- data/lib/openai/internal/util.rb +0 -4
- data/lib/openai/models/audio/speech_create_params.rb +9 -0
- data/lib/openai/models/audio/transcription_create_response.rb +4 -1
- data/lib/openai/models/audio/translation_create_response.rb +4 -1
- data/lib/openai/models/beta/agent.rb +1 -0
- data/lib/openai/models/beta/agent_create_params.rb +3 -0
- data/lib/openai/models/beta/agent_session.rb +1 -0
- data/lib/openai/models/beta/agent_update_params.rb +3 -0
- data/lib/openai/models/beta/agents/environments/template_create_params.rb +3 -3
- data/lib/openai/models/beta/agents/environments/template_update_params.rb +6 -6
- data/lib/openai/models/beta/agents/session_create_params.rb +3 -0
- data/lib/openai/models/beta/agents/session_update_params.rb +3 -0
- data/lib/openai/models/beta/agents/vaults/credential.rb +10 -1
- data/lib/openai/models/beta/agents/vaults/credential_create_params.rb +12 -1
- data/lib/openai/models/beta/agents/vaults/credential_update_params.rb +14 -3
- data/lib/openai/models/beta/beta_response.rb +38 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +73 -1
- data/lib/openai/models/beta/beta_web_search_preview_tool.rb +9 -3
- data/lib/openai/models/beta/beta_web_search_tool.rb +9 -3
- data/lib/openai/models/beta/environment_param.rb +3 -3
- data/lib/openai/models/beta/response_compact_params.rb +3 -0
- data/lib/openai/models/beta/response_create_params.rb +68 -1
- data/lib/openai/models/beta/session_turn_error.rb +3 -0
- data/lib/openai/models/chat_model.rb +1 -0
- data/lib/openai/models/responses/response.rb +35 -1
- data/lib/openai/models/responses/response_compact_params.rb +3 -0
- data/lib/openai/models/responses/response_create_params.rb +65 -1
- data/lib/openai/models/responses/responses_client_event.rb +70 -1
- data/lib/openai/models/responses/web_search_preview_tool.rb +9 -3
- data/lib/openai/models/responses/web_search_tool.rb +9 -3
- data/lib/openai/net_http_client.rb +0 -2
- data/lib/openai/resources/audio/transcriptions.rb +5 -3
- data/lib/openai/resources/audio/translations.rb +1 -1
- data/lib/openai/resources/beta/agents/environments/templates.rb +3 -3
- data/lib/openai/resources/beta/agents/vaults/credentials.rb +12 -4
- data/lib/openai/resources/beta/responses.rb +8 -2
- data/lib/openai/resources/responses.rb +8 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +1 -0
- data/rbi/openai/helpers/live/transcript_grouper.rbi +67 -0
- data/rbi/openai/helpers/live/websocket.rbi +299 -0
- data/rbi/openai/helpers/realtime/translation.rbi +137 -0
- data/rbi/openai/helpers/responses_websocket/incremental.rbi +32 -0
- data/rbi/openai/helpers/responses_websocket/transports/async_websocket.rbi +24 -0
- data/rbi/openai/helpers/streaming/response_stream.rbi +5 -0
- data/rbi/openai/internal/type/converter.rbi +3 -2
- data/rbi/openai/models/audio/speech_create_params.rbi +3 -0
- data/rbi/openai/models/audio/transcription_create_response.rbi +2 -1
- data/rbi/openai/models/audio/translation_create_response.rbi +2 -1
- data/rbi/openai/models/beta/agent.rbi +1 -0
- data/rbi/openai/models/beta/agent_create_params.rbi +3 -0
- data/rbi/openai/models/beta/agent_session.rbi +1 -0
- data/rbi/openai/models/beta/agent_update_params.rbi +3 -0
- data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +3 -3
- data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +6 -6
- data/rbi/openai/models/beta/agents/session_create_params.rbi +3 -0
- data/rbi/openai/models/beta/agents/session_update_params.rbi +3 -0
- data/rbi/openai/models/beta/agents/vaults/credential.rbi +10 -0
- data/rbi/openai/models/beta/agents/vaults/credential_create_params.rbi +15 -0
- data/rbi/openai/models/beta/agents/vaults/credential_update_params.rbi +35 -6
- data/rbi/openai/models/beta/beta_response.rbi +64 -0
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +128 -0
- data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +9 -3
- data/rbi/openai/models/beta/beta_web_search_tool.rbi +9 -3
- data/rbi/openai/models/beta/environment_param.rbi +3 -3
- data/rbi/openai/models/beta/response_compact_params.rbi +1 -0
- data/rbi/openai/models/beta/response_create_params.rbi +100 -0
- data/rbi/openai/models/beta/session_turn_error.rbi +6 -0
- data/rbi/openai/models/chat_model.rbi +1 -0
- data/rbi/openai/models/responses/response.rbi +63 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +1 -0
- data/rbi/openai/models/responses/response_create_params.rbi +106 -0
- data/rbi/openai/models/responses/responses_client_event.rbi +125 -0
- data/rbi/openai/models/responses/web_search_preview_tool.rbi +9 -3
- data/rbi/openai/models/responses/web_search_tool.rbi +9 -3
- data/rbi/openai/resources/audio/transcriptions.rbi +4 -2
- data/rbi/openai/resources/beta/agents/environments/templates.rbi +3 -3
- data/rbi/openai/resources/beta/agents/vaults/credentials.rbi +11 -3
- data/rbi/openai/resources/beta/responses.rbi +6 -0
- data/rbi/openai/resources/responses.rbi +11 -0
- data/responses-websocket.md +55 -0
- data/sig/openai/helpers/live/transcript_grouper.rbs +42 -0
- data/sig/openai/helpers/live/websocket.rbs +152 -0
- data/sig/openai/helpers/realtime/translation.rbs +81 -0
- data/sig/openai/helpers/responses_websocket/incremental.rbs +14 -0
- data/sig/openai/helpers/responses_websocket/transports/async_websocket.rbs +21 -0
- data/sig/openai/helpers/streaming/response_stream.rbs +9 -0
- data/sig/openai/internal/type/converter.rbs +3 -1
- data/sig/openai/models/audio/speech_create_params.rbs +6 -0
- data/sig/openai/models/audio/transcription_create_response.rbs +1 -0
- data/sig/openai/models/audio/translation_create_response.rbs +3 -1
- data/sig/openai/models/beta/agent.rbs +3 -1
- data/sig/openai/models/beta/agent_create_params.rbs +5 -1
- data/sig/openai/models/beta/agent_session.rbs +3 -1
- data/sig/openai/models/beta/agent_update_params.rbs +5 -1
- data/sig/openai/models/beta/agents/environments/template_create_params.rbs +2 -2
- data/sig/openai/models/beta/agents/environments/template_update_params.rbs +4 -4
- data/sig/openai/models/beta/agents/session_create_params.rbs +5 -1
- data/sig/openai/models/beta/agents/session_update_params.rbs +5 -1
- data/sig/openai/models/beta/agents/vaults/credential.rbs +8 -0
- data/sig/openai/models/beta/agents/vaults/credential_create_params.rbs +14 -0
- data/sig/openai/models/beta/agents/vaults/credential_update_params.rbs +23 -4
- data/sig/openai/models/beta/beta_response.rbs +37 -0
- data/sig/openai/models/beta/beta_responses_client_event.rbs +79 -0
- data/sig/openai/models/beta/beta_web_search_preview_tool.rbs +6 -2
- data/sig/openai/models/beta/beta_web_search_tool.rbs +6 -2
- data/sig/openai/models/beta/environment_param.rbs +2 -2
- data/sig/openai/models/beta/response_compact_params.rbs +2 -0
- data/sig/openai/models/beta/response_create_params.rbs +79 -0
- data/sig/openai/models/beta/session_turn_error.rbs +4 -0
- data/sig/openai/models/chat_model.rbs +2 -0
- data/sig/openai/models/responses/response.rbs +35 -0
- data/sig/openai/models/responses/response_compact_params.rbs +2 -0
- data/sig/openai/models/responses/response_create_params.rbs +77 -0
- data/sig/openai/models/responses/responses_client_event.rbs +77 -0
- data/sig/openai/models/responses/web_search_preview_tool.rbs +6 -2
- data/sig/openai/models/responses/web_search_tool.rbs +6 -2
- data/sig/openai/resources/beta/agents/vaults/credentials.rbs +3 -1
- data/sig/openai/resources/beta/responses.rbs +2 -0
- data/sig/openai/resources/responses.rbs +4 -0
- metadata +14 -1
|
@@ -11,8 +11,11 @@ module OpenAI
|
|
|
11
11
|
|
|
12
12
|
variant -> { OpenAI::Audio::TranslationVerbose }
|
|
13
13
|
|
|
14
|
+
# Text, SRT, and VTT responses retain the SDK's readable IO return value.
|
|
15
|
+
variant StringIO
|
|
16
|
+
|
|
14
17
|
# @!method self.variants
|
|
15
|
-
# @return [Array(OpenAI::Models::Audio::Translation, OpenAI::Models::Audio::TranslationVerbose)]
|
|
18
|
+
# @return [Array(OpenAI::Models::Audio::Translation, OpenAI::Models::Audio::TranslationVerbose, StringIO)]
|
|
16
19
|
end
|
|
17
20
|
end
|
|
18
21
|
end
|
|
@@ -41,7 +41,7 @@ module OpenAI
|
|
|
41
41
|
|
|
42
42
|
# @!attribute network
|
|
43
43
|
# Network access policy for the environment. Defaults to disabled for GA requests
|
|
44
|
-
# and enabled for
|
|
44
|
+
# and enabled for beta requests.
|
|
45
45
|
#
|
|
46
46
|
# @return [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network, nil]
|
|
47
47
|
optional(
|
|
@@ -113,7 +113,7 @@ module OpenAI
|
|
|
113
113
|
#
|
|
114
114
|
# @param network [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network, nil]
|
|
115
115
|
# Network access policy for the environment. Defaults to disabled for GA requests
|
|
116
|
-
# and enabled for
|
|
116
|
+
# and enabled for beta requests.
|
|
117
117
|
#
|
|
118
118
|
# @param packages [OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Packages, nil]
|
|
119
119
|
# Packages to install in the environment. Defaults to empty package lists.
|
|
@@ -145,7 +145,7 @@ module OpenAI
|
|
|
145
145
|
|
|
146
146
|
# @!method initialize(access:, allowed_domains: nil)
|
|
147
147
|
# Network access policy for the environment. Defaults to disabled for GA requests
|
|
148
|
-
# and enabled for
|
|
148
|
+
# and enabled for beta requests.
|
|
149
149
|
#
|
|
150
150
|
# @param access [Symbol, OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::Access]
|
|
151
151
|
# The environment's network access mode.
|
|
@@ -45,8 +45,8 @@ module OpenAI
|
|
|
45
45
|
|
|
46
46
|
# @!attribute network
|
|
47
47
|
# Network access available after setup completes. Omit to preserve the current
|
|
48
|
-
# policy, or pass `null` to reset to disabled for GA requests or enabled for
|
|
49
|
-
#
|
|
48
|
+
# policy, or pass `null` to reset to disabled for GA requests or enabled for beta
|
|
49
|
+
# requests.
|
|
50
50
|
#
|
|
51
51
|
# @return [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network, nil]
|
|
52
52
|
optional(
|
|
@@ -118,8 +118,8 @@ module OpenAI
|
|
|
118
118
|
#
|
|
119
119
|
# @param network [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network, nil]
|
|
120
120
|
# Network access available after setup completes. Omit to preserve the current
|
|
121
|
-
# policy, or pass `null` to reset to disabled for GA requests or enabled for
|
|
122
|
-
#
|
|
121
|
+
# policy, or pass `null` to reset to disabled for GA requests or enabled for beta
|
|
122
|
+
# requests.
|
|
123
123
|
#
|
|
124
124
|
# @param packages [OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Packages, nil]
|
|
125
125
|
# Packages installed before the runtime network policy applies.
|
|
@@ -150,8 +150,8 @@ module OpenAI
|
|
|
150
150
|
|
|
151
151
|
# @!method initialize(access:, allowed_domains: nil)
|
|
152
152
|
# Network access available after setup completes. Omit to preserve the current
|
|
153
|
-
# policy, or pass `null` to reset to disabled for GA requests or enabled for
|
|
154
|
-
#
|
|
153
|
+
# policy, or pass `null` to reset to disabled for GA requests or enabled for beta
|
|
154
|
+
# requests.
|
|
155
155
|
#
|
|
156
156
|
# @param access [Symbol, OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network::Access]
|
|
157
157
|
# The environment's network access mode.
|
|
@@ -25,6 +25,12 @@ module OpenAI
|
|
|
25
25
|
# @return [Integer]
|
|
26
26
|
required :created_at, Integer
|
|
27
27
|
|
|
28
|
+
# @!attribute metadata
|
|
29
|
+
# Application-defined key-value pairs associated with this credential.
|
|
30
|
+
#
|
|
31
|
+
# @return [Hash{Symbol=>String}]
|
|
32
|
+
required :metadata, OpenAI::Internal::Type::HashOf[String]
|
|
33
|
+
|
|
28
34
|
# @!attribute name
|
|
29
35
|
# The human-readable name of the credential.
|
|
30
36
|
#
|
|
@@ -49,7 +55,7 @@ module OpenAI
|
|
|
49
55
|
# @return [String]
|
|
50
56
|
required :vault_id, String
|
|
51
57
|
|
|
52
|
-
# @!method initialize(id:, auth:, created_at:, name:, updated_at:, vault_id:, object: :"vault.credential")
|
|
58
|
+
# @!method initialize(id:, auth:, created_at:, metadata:, name:, updated_at:, vault_id:, object: :"vault.credential")
|
|
53
59
|
# Metadata for a stored credential. Secret values are never returned.
|
|
54
60
|
#
|
|
55
61
|
# @param id [String]
|
|
@@ -61,6 +67,9 @@ module OpenAI
|
|
|
61
67
|
# @param created_at [Integer]
|
|
62
68
|
# The Unix timestamp, in seconds, when the credential was created.
|
|
63
69
|
#
|
|
70
|
+
# @param metadata [Hash{Symbol=>String}]
|
|
71
|
+
# Application-defined key-value pairs associated with this credential.
|
|
72
|
+
#
|
|
64
73
|
# @param name [String]
|
|
65
74
|
# The human-readable name of the credential.
|
|
66
75
|
#
|
|
@@ -28,7 +28,14 @@ module OpenAI
|
|
|
28
28
|
# @return [String]
|
|
29
29
|
required :name, String
|
|
30
30
|
|
|
31
|
-
# @!
|
|
31
|
+
# @!attribute metadata
|
|
32
|
+
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
33
|
+
# characters. Defaults to an empty map.
|
|
34
|
+
#
|
|
35
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
36
|
+
optional :metadata, OpenAI::Internal::Type::HashOf[String]
|
|
37
|
+
|
|
38
|
+
# @!method initialize(vault_id:, auth:, name:, metadata: nil, request_options: {})
|
|
32
39
|
# @param vault_id [String]
|
|
33
40
|
#
|
|
34
41
|
# @param auth [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::EnvironmentVariable]
|
|
@@ -38,6 +45,10 @@ module OpenAI
|
|
|
38
45
|
# The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
|
|
39
46
|
# trimming.
|
|
40
47
|
#
|
|
48
|
+
# @param metadata [Hash{Symbol=>String}]
|
|
49
|
+
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
50
|
+
# characters. Defaults to an empty map.
|
|
51
|
+
#
|
|
41
52
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
42
53
|
end
|
|
43
54
|
end
|
|
@@ -23,10 +23,17 @@ module OpenAI
|
|
|
23
23
|
# @!attribute auth
|
|
24
24
|
# Replacement values for the credential's existing authentication method.
|
|
25
25
|
#
|
|
26
|
-
# @return [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::EnvironmentVariable]
|
|
27
|
-
|
|
26
|
+
# @return [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::EnvironmentVariable, nil]
|
|
27
|
+
optional :auth, union: -> { OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam }
|
|
28
28
|
|
|
29
|
-
# @!
|
|
29
|
+
# @!attribute metadata
|
|
30
|
+
# Replaces all metadata. Omit to preserve it, or pass {} to clear it. Up to 16
|
|
31
|
+
# string key-value pairs, with keys up to 64 and values up to 512 characters.
|
|
32
|
+
#
|
|
33
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
34
|
+
optional :metadata, OpenAI::Internal::Type::HashOf[String]
|
|
35
|
+
|
|
36
|
+
# @!method initialize(vault_id:, credential_id:, auth: nil, metadata: nil, request_options: {})
|
|
30
37
|
# @param vault_id [String]
|
|
31
38
|
#
|
|
32
39
|
# @param credential_id [String]
|
|
@@ -34,6 +41,10 @@ module OpenAI
|
|
|
34
41
|
# @param auth [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::EnvironmentVariable]
|
|
35
42
|
# Replacement values for the credential's existing authentication method.
|
|
36
43
|
#
|
|
44
|
+
# @param metadata [Hash{Symbol=>String}]
|
|
45
|
+
# Replaces all metadata. Omit to preserve it, or pass {} to clear it. Up to 16
|
|
46
|
+
# string key-value pairs, with keys up to 64 and values up to 512 characters.
|
|
47
|
+
#
|
|
37
48
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
38
49
|
end
|
|
39
50
|
end
|
|
@@ -13,6 +13,11 @@ module OpenAI
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :id, String
|
|
15
15
|
|
|
16
|
+
# @!attribute access_programs
|
|
17
|
+
#
|
|
18
|
+
# @return [OpenAI::Models::Beta::BetaResponse::AccessPrograms, nil]
|
|
19
|
+
required :access_programs, -> { OpenAI::Beta::BetaResponse::AccessPrograms }, nil?: true
|
|
20
|
+
|
|
16
21
|
# @!attribute created_at
|
|
17
22
|
# Unix timestamp (in seconds) of when this Response was created.
|
|
18
23
|
#
|
|
@@ -353,10 +358,12 @@ module OpenAI
|
|
|
353
358
|
# @return [String, nil]
|
|
354
359
|
optional :user, String
|
|
355
360
|
|
|
356
|
-
# @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, completed_at: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, moderation: nil, previous_response_id: nil, prompt: nil, prompt_cache_diagnostics: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
|
|
361
|
+
# @!method initialize(id:, access_programs:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, completed_at: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, moderation: nil, previous_response_id: nil, prompt: nil, prompt_cache_diagnostics: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
|
|
357
362
|
# @param id [String]
|
|
358
363
|
# Unique identifier for this Response.
|
|
359
364
|
#
|
|
365
|
+
# @param access_programs [OpenAI::Models::Beta::BetaResponse::AccessPrograms, nil]
|
|
366
|
+
#
|
|
360
367
|
# @param created_at [Float]
|
|
361
368
|
# Unix timestamp (in seconds) of when this Response was created.
|
|
362
369
|
#
|
|
@@ -587,6 +594,33 @@ module OpenAI
|
|
|
587
594
|
# @param object [Symbol, :response]
|
|
588
595
|
# The object type of this resource - always set to `response`.
|
|
589
596
|
|
|
597
|
+
# @see OpenAI::Models::Beta::BetaResponse#access_programs
|
|
598
|
+
class AccessPrograms < OpenAI::Internal::Type::BaseModel
|
|
599
|
+
# @!attribute cyber
|
|
600
|
+
# The effective Cyber access program used for this response.
|
|
601
|
+
#
|
|
602
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponse::AccessPrograms::Cyber]
|
|
603
|
+
required :cyber, enum: -> { OpenAI::Beta::BetaResponse::AccessPrograms::Cyber }
|
|
604
|
+
|
|
605
|
+
# @!method initialize(cyber:)
|
|
606
|
+
# @param cyber [Symbol, OpenAI::Models::Beta::BetaResponse::AccessPrograms::Cyber]
|
|
607
|
+
# The effective Cyber access program used for this response.
|
|
608
|
+
|
|
609
|
+
# The effective Cyber access program used for this response.
|
|
610
|
+
#
|
|
611
|
+
# @see OpenAI::Models::Beta::BetaResponse::AccessPrograms#cyber
|
|
612
|
+
module Cyber
|
|
613
|
+
extend OpenAI::Internal::Type::Enum
|
|
614
|
+
|
|
615
|
+
STANDARD = :standard
|
|
616
|
+
DAYBREAK_BLUE = :daybreak_blue
|
|
617
|
+
DAYBREAK_RED = :daybreak_red
|
|
618
|
+
|
|
619
|
+
# @!method self.values
|
|
620
|
+
# @return [Array<Symbol>]
|
|
621
|
+
end
|
|
622
|
+
end
|
|
623
|
+
|
|
590
624
|
# @see OpenAI::Models::Beta::BetaResponse#incomplete_details
|
|
591
625
|
class IncompleteDetails < OpenAI::Internal::Type::BaseModel
|
|
592
626
|
# @!attribute reason
|
|
@@ -662,6 +696,8 @@ module OpenAI
|
|
|
662
696
|
|
|
663
697
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_ASTRA }
|
|
664
698
|
|
|
699
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_1_SOL }
|
|
700
|
+
|
|
665
701
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_SOL }
|
|
666
702
|
|
|
667
703
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_LUNA }
|
|
@@ -888,6 +924,7 @@ module OpenAI
|
|
|
888
924
|
# @!group
|
|
889
925
|
|
|
890
926
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
927
|
+
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
891
928
|
GPT_6_SOL = :"gpt-6-sol"
|
|
892
929
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
893
930
|
GPT_5_6_SOL = :"gpt-5.6-sol"
|
|
@@ -61,6 +61,12 @@ module OpenAI
|
|
|
61
61
|
# @return [Symbol, :"response.create"]
|
|
62
62
|
required :type, const: :"response.create"
|
|
63
63
|
|
|
64
|
+
# @!attribute access_programs
|
|
65
|
+
# Domain-specific access programs to use for this request.
|
|
66
|
+
#
|
|
67
|
+
# @return [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms, nil]
|
|
68
|
+
optional :access_programs, -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms }
|
|
69
|
+
|
|
64
70
|
# @!attribute background
|
|
65
71
|
# Whether to run the model response in the background.
|
|
66
72
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
@@ -476,7 +482,7 @@ module OpenAI
|
|
|
476
482
|
# @return [String, nil]
|
|
477
483
|
optional :user, String
|
|
478
484
|
|
|
479
|
-
# @!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")
|
|
485
|
+
# @!method initialize(access_programs: nil, 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")
|
|
480
486
|
# Client event for creating a response over a persistent WebSocket connection.
|
|
481
487
|
# This payload uses the same top-level fields as `POST /v1/responses`, plus
|
|
482
488
|
# WebSocket-only envelope metadata.
|
|
@@ -487,6 +493,9 @@ module OpenAI
|
|
|
487
493
|
# - `background` is not supported over WebSocket.
|
|
488
494
|
# - `stream_id` is WebSocket-only and is not part of `POST /v1/responses`.
|
|
489
495
|
#
|
|
496
|
+
# @param access_programs [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms]
|
|
497
|
+
# Domain-specific access programs to use for this request.
|
|
498
|
+
#
|
|
490
499
|
# @param background [Boolean, nil]
|
|
491
500
|
# Whether to run the model response in the background.
|
|
492
501
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
@@ -752,6 +761,66 @@ module OpenAI
|
|
|
752
761
|
#
|
|
753
762
|
# @param type [Symbol, :"response.create"]
|
|
754
763
|
# The type of the client event. Always `response.create`.
|
|
764
|
+
|
|
765
|
+
# @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate#access_programs
|
|
766
|
+
class AccessPrograms < OpenAI::Internal::Type::BaseModel
|
|
767
|
+
# @!attribute cyber
|
|
768
|
+
# The Cyber access program to use for this request. Supported values are
|
|
769
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
770
|
+
# the program from the model's Cyber tier and your organization and project
|
|
771
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
772
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
773
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
774
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
775
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
776
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
777
|
+
# field, rather than an explicit Standard selection.
|
|
778
|
+
#
|
|
779
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms::Cyber, nil]
|
|
780
|
+
optional(
|
|
781
|
+
:cyber,
|
|
782
|
+
enum: -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms::Cyber }
|
|
783
|
+
)
|
|
784
|
+
|
|
785
|
+
# @!method initialize(cyber: nil)
|
|
786
|
+
# Domain-specific access programs to use for this request.
|
|
787
|
+
#
|
|
788
|
+
# @param cyber [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms::Cyber]
|
|
789
|
+
# The Cyber access program to use for this request. Supported values are
|
|
790
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
791
|
+
# the program from the model's Cyber tier and your organization and project
|
|
792
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
793
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
794
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
795
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
796
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
797
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
798
|
+
# field, rather than an explicit Standard selection.
|
|
799
|
+
|
|
800
|
+
# The Cyber access program to use for this request. Supported values are
|
|
801
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
802
|
+
# the program from the model's Cyber tier and your organization and project
|
|
803
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
804
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
805
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
806
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
807
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
808
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
809
|
+
# field, rather than an explicit Standard selection.
|
|
810
|
+
#
|
|
811
|
+
# @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms#cyber
|
|
812
|
+
module Cyber
|
|
813
|
+
extend OpenAI::Internal::Type::Enum
|
|
814
|
+
|
|
815
|
+
STANDARD = :standard
|
|
816
|
+
DAYBREAK_BLUE = :daybreak_blue
|
|
817
|
+
DAYBREAK_RED = :daybreak_red
|
|
818
|
+
|
|
819
|
+
# @!method self.values
|
|
820
|
+
# @return [Array<Symbol>]
|
|
821
|
+
end
|
|
822
|
+
end
|
|
823
|
+
|
|
755
824
|
class ContextManagement < OpenAI::Internal::Type::BaseModel
|
|
756
825
|
# @!attribute type
|
|
757
826
|
# The context management entry type. Currently only 'compaction' is supported.
|
|
@@ -830,6 +899,8 @@ module OpenAI
|
|
|
830
899
|
|
|
831
900
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_ASTRA }
|
|
832
901
|
|
|
902
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_1_SOL }
|
|
903
|
+
|
|
833
904
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_SOL }
|
|
834
905
|
|
|
835
906
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_LUNA }
|
|
@@ -1240,6 +1311,7 @@ module OpenAI
|
|
|
1240
1311
|
# @!group
|
|
1241
1312
|
|
|
1242
1313
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
1314
|
+
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
1243
1315
|
GPT_6_SOL = :"gpt-6-sol"
|
|
1244
1316
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
1245
1317
|
GPT_5_6_SOL = :"gpt-5.6-sol"
|
|
@@ -27,7 +27,9 @@ module OpenAI
|
|
|
27
27
|
optional :search_context_size, enum: -> { OpenAI::Beta::BetaWebSearchPreviewTool::SearchContextSize }
|
|
28
28
|
|
|
29
29
|
# @!attribute user_location
|
|
30
|
-
# The
|
|
30
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
31
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
32
|
+
# fields. To localize results, provide the relevant location fields.
|
|
31
33
|
#
|
|
32
34
|
# @return [OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation, nil]
|
|
33
35
|
optional :user_location, -> { OpenAI::Beta::BetaWebSearchPreviewTool::UserLocation }, nil?: true
|
|
@@ -48,7 +50,9 @@ module OpenAI
|
|
|
48
50
|
# search. One of `low`, `medium`, or `high`. `medium` is the default.
|
|
49
51
|
#
|
|
50
52
|
# @param user_location [OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation, nil]
|
|
51
|
-
# The
|
|
53
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
54
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
55
|
+
# fields. To localize results, provide the relevant location fields.
|
|
52
56
|
|
|
53
57
|
# The type of the web search tool. One of `web_search_preview` or
|
|
54
58
|
# `web_search_preview_2025_03_11`.
|
|
@@ -124,7 +128,9 @@ module OpenAI
|
|
|
124
128
|
optional :timezone, String, nil?: true
|
|
125
129
|
|
|
126
130
|
# @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: :approximate)
|
|
127
|
-
# The
|
|
131
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
132
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
133
|
+
# fields. To localize results, provide the relevant location fields.
|
|
128
134
|
#
|
|
129
135
|
# @param city [String, nil]
|
|
130
136
|
# Free text input for the city of the user, e.g. `San Francisco`.
|
|
@@ -32,7 +32,9 @@ module OpenAI
|
|
|
32
32
|
optional :search_context_size, enum: -> { OpenAI::Beta::BetaWebSearchTool::SearchContextSize }
|
|
33
33
|
|
|
34
34
|
# @!attribute user_location
|
|
35
|
-
# The approximate location of the user.
|
|
35
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
36
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
37
|
+
# fields. To localize results, provide the relevant location fields.
|
|
36
38
|
#
|
|
37
39
|
# @return [OpenAI::Models::Beta::BetaWebSearchTool::UserLocation, nil]
|
|
38
40
|
optional :user_location, -> { OpenAI::Beta::BetaWebSearchTool::UserLocation }, nil?: true
|
|
@@ -57,7 +59,9 @@ module OpenAI
|
|
|
57
59
|
# search. One of `low`, `medium`, or `high`. `medium` is the default.
|
|
58
60
|
#
|
|
59
61
|
# @param user_location [OpenAI::Models::Beta::BetaWebSearchTool::UserLocation, nil]
|
|
60
|
-
# The approximate location of the user.
|
|
62
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
63
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
64
|
+
# fields. To localize results, provide the relevant location fields.
|
|
61
65
|
|
|
62
66
|
# The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
|
|
63
67
|
#
|
|
@@ -143,7 +147,9 @@ module OpenAI
|
|
|
143
147
|
optional :type, enum: -> { OpenAI::Beta::BetaWebSearchTool::UserLocation::Type }
|
|
144
148
|
|
|
145
149
|
# @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: nil)
|
|
146
|
-
# The approximate location of the user.
|
|
150
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
151
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
152
|
+
# fields. To localize results, provide the relevant location fields.
|
|
147
153
|
#
|
|
148
154
|
# @param city [String, nil]
|
|
149
155
|
# Free text input for the city of the user, e.g. `San Francisco`.
|
|
@@ -71,7 +71,7 @@ module OpenAI
|
|
|
71
71
|
|
|
72
72
|
# @!attribute network
|
|
73
73
|
# Network access policy for the environment. Defaults to disabled for GA requests
|
|
74
|
-
# and enabled for
|
|
74
|
+
# and enabled for beta requests.
|
|
75
75
|
#
|
|
76
76
|
# @return [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network, nil]
|
|
77
77
|
optional :network, -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network }, nil?: true
|
|
@@ -135,7 +135,7 @@ module OpenAI
|
|
|
135
135
|
#
|
|
136
136
|
# @param network [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network, nil]
|
|
137
137
|
# Network access policy for the environment. Defaults to disabled for GA requests
|
|
138
|
-
# and enabled for
|
|
138
|
+
# and enabled for beta requests.
|
|
139
139
|
#
|
|
140
140
|
# @param packages [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Packages, nil]
|
|
141
141
|
# Packages to install in the environment. Defaults to empty package lists.
|
|
@@ -169,7 +169,7 @@ module OpenAI
|
|
|
169
169
|
|
|
170
170
|
# @!method initialize(access:, allowed_domains: nil)
|
|
171
171
|
# Network access policy for the environment. Defaults to disabled for GA requests
|
|
172
|
-
# and enabled for
|
|
172
|
+
# and enabled for beta requests.
|
|
173
173
|
#
|
|
174
174
|
# @param access [Symbol, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network::Access]
|
|
175
175
|
# The environment's network access mode.
|
|
@@ -178,6 +178,8 @@ module OpenAI
|
|
|
178
178
|
|
|
179
179
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_ASTRA }
|
|
180
180
|
|
|
181
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_1_SOL }
|
|
182
|
+
|
|
181
183
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_SOL }
|
|
182
184
|
|
|
183
185
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_LUNA }
|
|
@@ -408,6 +410,7 @@ module OpenAI
|
|
|
408
410
|
# @!group
|
|
409
411
|
|
|
410
412
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
413
|
+
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
411
414
|
GPT_6_SOL = :"gpt-6-sol"
|
|
412
415
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
413
416
|
GPT_5_6_SOL = :"gpt-5.6-sol"
|
|
@@ -10,6 +10,12 @@ module OpenAI
|
|
|
10
10
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
11
11
|
include OpenAI::Internal::Type::RequestParameters
|
|
12
12
|
|
|
13
|
+
# @!attribute access_programs
|
|
14
|
+
# Domain-specific access programs to use for this request.
|
|
15
|
+
#
|
|
16
|
+
# @return [OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms, nil]
|
|
17
|
+
optional :access_programs, -> { OpenAI::Beta::ResponseCreateParams::AccessPrograms }
|
|
18
|
+
|
|
13
19
|
# @!attribute background
|
|
14
20
|
# Whether to run the model response in the background.
|
|
15
21
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
@@ -376,7 +382,10 @@ module OpenAI
|
|
|
376
382
|
# @return [Array<Symbol, OpenAI::Models::Beta::ResponseCreateParams::Beta>, nil]
|
|
377
383
|
optional :betas, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::ResponseCreateParams::Beta] }
|
|
378
384
|
|
|
379
|
-
# @!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_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: {})
|
|
385
|
+
# @!method initialize(access_programs: nil, 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_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: {})
|
|
386
|
+
# @param access_programs [OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms]
|
|
387
|
+
# Domain-specific access programs to use for this request.
|
|
388
|
+
#
|
|
380
389
|
# @param background [Boolean, nil]
|
|
381
390
|
# Whether to run the model response in the background.
|
|
382
391
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
@@ -629,6 +638,61 @@ module OpenAI
|
|
|
629
638
|
#
|
|
630
639
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
631
640
|
|
|
641
|
+
class AccessPrograms < OpenAI::Internal::Type::BaseModel
|
|
642
|
+
# @!attribute cyber
|
|
643
|
+
# The Cyber access program to use for this request. Supported values are
|
|
644
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
645
|
+
# the program from the model's Cyber tier and your organization and project
|
|
646
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
647
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
648
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
649
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
650
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
651
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
652
|
+
# field, rather than an explicit Standard selection.
|
|
653
|
+
#
|
|
654
|
+
# @return [Symbol, OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms::Cyber, nil]
|
|
655
|
+
optional :cyber, enum: -> { OpenAI::Beta::ResponseCreateParams::AccessPrograms::Cyber }
|
|
656
|
+
|
|
657
|
+
# @!method initialize(cyber: nil)
|
|
658
|
+
# Domain-specific access programs to use for this request.
|
|
659
|
+
#
|
|
660
|
+
# @param cyber [Symbol, OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms::Cyber]
|
|
661
|
+
# The Cyber access program to use for this request. Supported values are
|
|
662
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
663
|
+
# the program from the model's Cyber tier and your organization and project
|
|
664
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
665
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
666
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
667
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
668
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
669
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
670
|
+
# field, rather than an explicit Standard selection.
|
|
671
|
+
|
|
672
|
+
# The Cyber access program to use for this request. Supported values are
|
|
673
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
674
|
+
# the program from the model's Cyber tier and your organization and project
|
|
675
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
676
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
677
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
678
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
679
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
680
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
681
|
+
# field, rather than an explicit Standard selection.
|
|
682
|
+
#
|
|
683
|
+
# @see OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms#cyber
|
|
684
|
+
module Cyber
|
|
685
|
+
extend OpenAI::Internal::Type::Enum
|
|
686
|
+
|
|
687
|
+
STANDARD = :standard
|
|
688
|
+
DAYBREAK_BLUE = :daybreak_blue
|
|
689
|
+
DAYBREAK_RED = :daybreak_red
|
|
690
|
+
|
|
691
|
+
# @!method self.values
|
|
692
|
+
# @return [Array<Symbol>]
|
|
693
|
+
end
|
|
694
|
+
end
|
|
695
|
+
|
|
632
696
|
class ContextManagement < OpenAI::Internal::Type::BaseModel
|
|
633
697
|
# @!attribute type
|
|
634
698
|
# The context management entry type. Currently only 'compaction' is supported.
|
|
@@ -701,6 +765,8 @@ module OpenAI
|
|
|
701
765
|
|
|
702
766
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_ASTRA }
|
|
703
767
|
|
|
768
|
+
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_1_SOL }
|
|
769
|
+
|
|
704
770
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_SOL }
|
|
705
771
|
|
|
706
772
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_LUNA }
|
|
@@ -929,6 +995,7 @@ module OpenAI
|
|
|
929
995
|
# @!group
|
|
930
996
|
|
|
931
997
|
GPT_6_ASTRA = :"gpt-6-astra"
|
|
998
|
+
GPT_6_1_SOL = :"gpt-6.1-sol"
|
|
932
999
|
GPT_6_SOL = :"gpt-6-sol"
|
|
933
1000
|
GPT_6_LUNA = :"gpt-6-luna"
|
|
934
1001
|
GPT_5_6_SOL = :"gpt-5.6-sol"
|
|
@@ -52,6 +52,9 @@ module OpenAI
|
|
|
52
52
|
# The request was rejected by a safety policy.
|
|
53
53
|
CYBER_POLICY = :cyber_policy
|
|
54
54
|
|
|
55
|
+
# The request was blocked by the safety systems.
|
|
56
|
+
MISALIGNMENT_POLICY_VIOLATION = :misalignment_policy_violation
|
|
57
|
+
|
|
55
58
|
# The request could not connect to the model service.
|
|
56
59
|
CONNECTION_FAILED = :connection_failed
|
|
57
60
|
|