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
|
@@ -3,6 +3,7 @@ module OpenAI
|
|
|
3
3
|
module Responses
|
|
4
4
|
type response_create_params =
|
|
5
5
|
{
|
|
6
|
+
?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
|
|
6
7
|
?background: bool?,
|
|
7
8
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
8
9
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
@@ -40,6 +41,14 @@ module OpenAI
|
|
|
40
41
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
41
42
|
include OpenAI::Internal::Type::RequestParameters
|
|
42
43
|
|
|
44
|
+
# Domain-specific access programs to use for this request.
|
|
45
|
+
attr_reader access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms?
|
|
46
|
+
|
|
47
|
+
# Domain-specific access programs to use for this request.
|
|
48
|
+
def access_programs=: (
|
|
49
|
+
OpenAI::Responses::ResponseCreateParams::AccessPrograms
|
|
50
|
+
) -> OpenAI::Responses::ResponseCreateParams::AccessPrograms
|
|
51
|
+
|
|
43
52
|
# Whether to run the model response in the background.
|
|
44
53
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
45
54
|
attr_accessor background: bool?
|
|
@@ -367,6 +376,8 @@ module OpenAI
|
|
|
367
376
|
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
368
377
|
def user=: (String) -> String
|
|
369
378
|
|
|
379
|
+
# @param access_programs
|
|
380
|
+
# Domain-specific access programs to use for this request.
|
|
370
381
|
# @param background
|
|
371
382
|
# Whether to run the model response in the background.
|
|
372
383
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
@@ -583,6 +594,7 @@ module OpenAI
|
|
|
583
594
|
# similar requests and to help OpenAI detect and prevent abuse.
|
|
584
595
|
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
585
596
|
def initialize: (
|
|
597
|
+
?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
|
|
586
598
|
?background: bool?,
|
|
587
599
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
588
600
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
@@ -617,6 +629,7 @@ module OpenAI
|
|
|
617
629
|
) -> void
|
|
618
630
|
|
|
619
631
|
def to_hash: -> {
|
|
632
|
+
?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
|
|
620
633
|
?background: bool?,
|
|
621
634
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
622
635
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
@@ -650,6 +663,70 @@ module OpenAI
|
|
|
650
663
|
?request_options: OpenAI::RequestOptions
|
|
651
664
|
}
|
|
652
665
|
|
|
666
|
+
type access_programs =
|
|
667
|
+
{
|
|
668
|
+
?cyber: OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms::cyber
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
class AccessPrograms < OpenAI::Internal::Type::BaseModel
|
|
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
|
+
attr_reader cyber: OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms::cyber?
|
|
683
|
+
|
|
684
|
+
# The Cyber access program to use for this request. Supported values are
|
|
685
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
686
|
+
# the program from the model's Cyber tier and your organization and project
|
|
687
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
688
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
689
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
690
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
691
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
692
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
693
|
+
# field, rather than an explicit Standard selection.
|
|
694
|
+
def cyber=: (
|
|
695
|
+
OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms::cyber
|
|
696
|
+
) -> OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms::cyber
|
|
697
|
+
|
|
698
|
+
# @param cyber
|
|
699
|
+
# The Cyber access program to use for this request. Supported values are
|
|
700
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
701
|
+
# the program from the model's Cyber tier and your organization and project
|
|
702
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
703
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
704
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
705
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
706
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
707
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
708
|
+
# field, rather than an explicit Standard selection.
|
|
709
|
+
def initialize: (
|
|
710
|
+
?cyber: OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms::cyber
|
|
711
|
+
) -> void
|
|
712
|
+
|
|
713
|
+
def to_hash: -> {
|
|
714
|
+
?cyber: OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms::cyber
|
|
715
|
+
}
|
|
716
|
+
|
|
717
|
+
type cyber = :standard | :daybreak_blue | :daybreak_red
|
|
718
|
+
|
|
719
|
+
module Cyber
|
|
720
|
+
extend OpenAI::Internal::Type::Enum
|
|
721
|
+
|
|
722
|
+
STANDARD: :standard
|
|
723
|
+
DAYBREAK_BLUE: :daybreak_blue
|
|
724
|
+
DAYBREAK_RED: :daybreak_red
|
|
725
|
+
|
|
726
|
+
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms::cyber]
|
|
727
|
+
end
|
|
728
|
+
end
|
|
729
|
+
|
|
653
730
|
type context_management = { type: String, ?compact_threshold: Integer? }
|
|
654
731
|
|
|
655
732
|
class ContextManagement < OpenAI::Internal::Type::BaseModel
|
|
@@ -11,6 +11,7 @@ module OpenAI
|
|
|
11
11
|
type response_create =
|
|
12
12
|
{
|
|
13
13
|
?type: :"response.create",
|
|
14
|
+
?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
|
|
14
15
|
?background: bool?,
|
|
15
16
|
?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
|
|
16
17
|
?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
|
|
@@ -49,6 +50,14 @@ module OpenAI
|
|
|
49
50
|
# The type of the client event. Always `response.create`.
|
|
50
51
|
attr_accessor type: :"response.create"
|
|
51
52
|
|
|
53
|
+
# Domain-specific access programs to use for this request.
|
|
54
|
+
attr_reader access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms?
|
|
55
|
+
|
|
56
|
+
# Domain-specific access programs to use for this request.
|
|
57
|
+
def access_programs=: (
|
|
58
|
+
OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms
|
|
59
|
+
) -> OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms
|
|
60
|
+
|
|
52
61
|
# Whether to run the model response in the background.
|
|
53
62
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
54
63
|
attr_accessor background: bool?
|
|
@@ -398,6 +407,8 @@ module OpenAI
|
|
|
398
407
|
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
399
408
|
def user=: (String) -> String
|
|
400
409
|
|
|
410
|
+
# @param access_programs
|
|
411
|
+
# Domain-specific access programs to use for this request.
|
|
401
412
|
# @param background
|
|
402
413
|
# Whether to run the model response in the background.
|
|
403
414
|
# [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
@@ -629,6 +640,7 @@ module OpenAI
|
|
|
629
640
|
# @param type
|
|
630
641
|
# The type of the client event. Always `response.create`.
|
|
631
642
|
def initialize: (
|
|
643
|
+
?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
|
|
632
644
|
?background: bool?,
|
|
633
645
|
?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
|
|
634
646
|
?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
|
|
@@ -666,6 +678,7 @@ module OpenAI
|
|
|
666
678
|
|
|
667
679
|
def to_hash: -> {
|
|
668
680
|
?type: :"response.create",
|
|
681
|
+
?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
|
|
669
682
|
?background: bool?,
|
|
670
683
|
?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
|
|
671
684
|
?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
|
|
@@ -700,6 +713,70 @@ module OpenAI
|
|
|
700
713
|
?user: String
|
|
701
714
|
}
|
|
702
715
|
|
|
716
|
+
type access_programs =
|
|
717
|
+
{
|
|
718
|
+
?cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
class AccessPrograms < OpenAI::Internal::Type::BaseModel
|
|
722
|
+
# The Cyber access program to use for this request. Supported values are
|
|
723
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
724
|
+
# the program from the model's Cyber tier and your organization and project
|
|
725
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
726
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
727
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
728
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
729
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
730
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
731
|
+
# field, rather than an explicit Standard selection.
|
|
732
|
+
attr_reader cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber?
|
|
733
|
+
|
|
734
|
+
# The Cyber access program to use for this request. Supported values are
|
|
735
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
736
|
+
# the program from the model's Cyber tier and your organization and project
|
|
737
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
738
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
739
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
740
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
741
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
742
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
743
|
+
# field, rather than an explicit Standard selection.
|
|
744
|
+
def cyber=: (
|
|
745
|
+
OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
|
|
746
|
+
) -> OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
|
|
747
|
+
|
|
748
|
+
# @param cyber
|
|
749
|
+
# The Cyber access program to use for this request. Supported values are
|
|
750
|
+
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
|
|
751
|
+
# the program from the model's Cyber tier and your organization and project
|
|
752
|
+
# access, subject to model-specific eligibility restrictions. By default, models
|
|
753
|
+
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
|
|
754
|
+
# authorized; otherwise they fall back to Standard unless the model requires
|
|
755
|
+
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
|
|
756
|
+
# Requests that require unavailable Daybreak access return 403. An implicit
|
|
757
|
+
# Standard fallback is represented by null in the response's access_programs
|
|
758
|
+
# field, rather than an explicit Standard selection.
|
|
759
|
+
def initialize: (
|
|
760
|
+
?cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
|
|
761
|
+
) -> void
|
|
762
|
+
|
|
763
|
+
def to_hash: -> {
|
|
764
|
+
?cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
|
|
765
|
+
}
|
|
766
|
+
|
|
767
|
+
type cyber = :standard | :daybreak_blue | :daybreak_red
|
|
768
|
+
|
|
769
|
+
module Cyber
|
|
770
|
+
extend OpenAI::Internal::Type::Enum
|
|
771
|
+
|
|
772
|
+
STANDARD: :standard
|
|
773
|
+
DAYBREAK_BLUE: :daybreak_blue
|
|
774
|
+
DAYBREAK_RED: :daybreak_red
|
|
775
|
+
|
|
776
|
+
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber]
|
|
777
|
+
end
|
|
778
|
+
end
|
|
779
|
+
|
|
703
780
|
type context_management =
|
|
704
781
|
{ type: String, ?compact_threshold: Integer? }
|
|
705
782
|
|
|
@@ -30,7 +30,9 @@ module OpenAI
|
|
|
30
30
|
OpenAI::Models::Responses::WebSearchPreviewTool::search_context_size
|
|
31
31
|
) -> OpenAI::Models::Responses::WebSearchPreviewTool::search_context_size
|
|
32
32
|
|
|
33
|
-
# The
|
|
33
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
34
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
35
|
+
# fields. To localize results, provide the relevant location fields.
|
|
34
36
|
attr_accessor user_location: OpenAI::Responses::WebSearchPreviewTool::UserLocation?
|
|
35
37
|
|
|
36
38
|
# @param type
|
|
@@ -40,7 +42,9 @@ module OpenAI
|
|
|
40
42
|
# High level guidance for the amount of context window space to use for the
|
|
41
43
|
# search. One of `low`, `medium`, or `high`. `medium` is the default.
|
|
42
44
|
# @param user_location
|
|
43
|
-
# The
|
|
45
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
46
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
47
|
+
# fields. To localize results, provide the relevant location fields.
|
|
44
48
|
def initialize: (
|
|
45
49
|
type: OpenAI::Models::Responses::WebSearchPreviewTool::type_,
|
|
46
50
|
?search_content_types: ::Array[OpenAI::Models::Responses::WebSearchPreviewTool::search_content_type],
|
|
@@ -37,7 +37,9 @@ module OpenAI
|
|
|
37
37
|
OpenAI::Models::Responses::WebSearchTool::search_context_size
|
|
38
38
|
) -> OpenAI::Models::Responses::WebSearchTool::search_context_size
|
|
39
39
|
|
|
40
|
-
# The approximate location of the user.
|
|
40
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
41
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
42
|
+
# fields. To localize results, provide the relevant location fields.
|
|
41
43
|
attr_accessor user_location: OpenAI::Responses::WebSearchTool::UserLocation?
|
|
42
44
|
|
|
43
45
|
# @param type
|
|
@@ -52,7 +54,9 @@ module OpenAI
|
|
|
52
54
|
# High level guidance for the amount of context window space to use for the
|
|
53
55
|
# search. One of `low`, `medium`, or `high`. `medium` is the default.
|
|
54
56
|
# @param user_location
|
|
55
|
-
# The approximate location of the user.
|
|
57
|
+
# The approximate location of the user. If omitted or null, defaults to the United
|
|
58
|
+
# States. To avoid this fallback, pass `{"type": "approximate"}` without location
|
|
59
|
+
# fields. To localize results, provide the relevant location fields.
|
|
56
60
|
def initialize: (
|
|
57
61
|
type: OpenAI::Models::Responses::WebSearchTool::type_,
|
|
58
62
|
?external_web_access: bool,
|
|
@@ -8,6 +8,7 @@ module OpenAI
|
|
|
8
8
|
String vault_id,
|
|
9
9
|
auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth_create_param,
|
|
10
10
|
name: String,
|
|
11
|
+
?metadata: ::Hash[Symbol, String],
|
|
11
12
|
?request_options: OpenAI::request_opts
|
|
12
13
|
) -> OpenAI::Beta::Agents::Vaults::Credential
|
|
13
14
|
|
|
@@ -20,7 +21,8 @@ module OpenAI
|
|
|
20
21
|
def update: (
|
|
21
22
|
String credential_id,
|
|
22
23
|
vault_id: String,
|
|
23
|
-
auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth_rotate_param,
|
|
24
|
+
?auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth_rotate_param,
|
|
25
|
+
?metadata: ::Hash[Symbol, String],
|
|
24
26
|
?request_options: OpenAI::request_opts
|
|
25
27
|
) -> OpenAI::Beta::Agents::Vaults::Credential
|
|
26
28
|
|
|
@@ -7,6 +7,7 @@ module OpenAI
|
|
|
7
7
|
attr_reader input_tokens: OpenAI::Resources::Beta::Responses::InputTokens
|
|
8
8
|
|
|
9
9
|
def create: (
|
|
10
|
+
?access_programs: OpenAI::Beta::ResponseCreateParams::AccessPrograms,
|
|
10
11
|
?background: bool?,
|
|
11
12
|
?context_management: ::Array[OpenAI::Beta::ResponseCreateParams::ContextManagement]?,
|
|
12
13
|
?conversation: OpenAI::Models::Beta::ResponseCreateParams::conversation?,
|
|
@@ -43,6 +44,7 @@ module OpenAI
|
|
|
43
44
|
) -> OpenAI::Beta::BetaResponse
|
|
44
45
|
|
|
45
46
|
def stream_raw: (
|
|
47
|
+
?access_programs: OpenAI::Beta::ResponseCreateParams::AccessPrograms,
|
|
46
48
|
?background: bool?,
|
|
47
49
|
?context_management: ::Array[OpenAI::Beta::ResponseCreateParams::ContextManagement]?,
|
|
48
50
|
?conversation: OpenAI::Models::Beta::ResponseCreateParams::conversation?,
|
|
@@ -6,6 +6,7 @@ module OpenAI
|
|
|
6
6
|
attr_reader input_tokens: OpenAI::Resources::Responses::InputTokens
|
|
7
7
|
|
|
8
8
|
def create: (
|
|
9
|
+
?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
|
|
9
10
|
?background: bool?,
|
|
10
11
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
11
12
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
@@ -40,6 +41,7 @@ module OpenAI
|
|
|
40
41
|
) -> OpenAI::Responses::Response
|
|
41
42
|
|
|
42
43
|
def stream_raw: (
|
|
44
|
+
?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
|
|
43
45
|
?background: bool?,
|
|
44
46
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
45
47
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
@@ -75,6 +77,7 @@ module OpenAI
|
|
|
75
77
|
| OpenAI::Streaming::UnknownStreamEvent)]
|
|
76
78
|
|
|
77
79
|
def stream: (
|
|
80
|
+
?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
|
|
78
81
|
?background: bool?,
|
|
79
82
|
?include: ::Array[OpenAI::Models::Responses::response_includable]?,
|
|
80
83
|
?input: OpenAI::Models::Responses::ResponseCreateParams::input,
|
|
@@ -156,6 +159,7 @@ module OpenAI
|
|
|
156
159
|
module ConnectionResources
|
|
157
160
|
class Response
|
|
158
161
|
def create: (
|
|
162
|
+
?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
|
|
159
163
|
?background: bool?,
|
|
160
164
|
?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
|
|
161
165
|
?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: openai
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.96.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenAI
|
|
@@ -94,6 +94,9 @@ files:
|
|
|
94
94
|
- lib/openai/helpers/agents/tools.rb
|
|
95
95
|
- lib/openai/helpers/client_options.rb
|
|
96
96
|
- lib/openai/helpers/data_residency.rb
|
|
97
|
+
- lib/openai/helpers/live/transcript_grouper.rb
|
|
98
|
+
- lib/openai/helpers/live/transcript_grouping.rb
|
|
99
|
+
- lib/openai/helpers/live/websocket.rb
|
|
97
100
|
- lib/openai/helpers/local_audio.rb
|
|
98
101
|
- lib/openai/helpers/local_audio/errors.rb
|
|
99
102
|
- lib/openai/helpers/local_audio/process.rb
|
|
@@ -107,6 +110,7 @@ files:
|
|
|
107
110
|
- lib/openai/helpers/realtime/recovery.rb
|
|
108
111
|
- lib/openai/helpers/realtime/resources/realtime_extension.rb
|
|
109
112
|
- lib/openai/helpers/realtime/sideband_connection.rb
|
|
113
|
+
- lib/openai/helpers/realtime/translation.rb
|
|
110
114
|
- lib/openai/helpers/realtime/transports/async_websocket.rb
|
|
111
115
|
- lib/openai/helpers/realtime/unknown_server_event.rb
|
|
112
116
|
- lib/openai/helpers/resource_polling.rb
|
|
@@ -116,6 +120,7 @@ files:
|
|
|
116
120
|
- lib/openai/helpers/responses_websocket/connection_manager.rb
|
|
117
121
|
- lib/openai/helpers/responses_websocket/connection_resources.rb
|
|
118
122
|
- lib/openai/helpers/responses_websocket/errors.rb
|
|
123
|
+
- lib/openai/helpers/responses_websocket/incremental.rb
|
|
119
124
|
- lib/openai/helpers/responses_websocket/resources/responses_extension.rb
|
|
120
125
|
- lib/openai/helpers/responses_websocket/session.rb
|
|
121
126
|
- lib/openai/helpers/responses_websocket/transports/async_websocket.rb
|
|
@@ -1694,6 +1699,8 @@ files:
|
|
|
1694
1699
|
- rbi/openai/helpers/agents.rbi
|
|
1695
1700
|
- rbi/openai/helpers/client_options.rbi
|
|
1696
1701
|
- rbi/openai/helpers/data_residency.rbi
|
|
1702
|
+
- rbi/openai/helpers/live/transcript_grouper.rbi
|
|
1703
|
+
- rbi/openai/helpers/live/websocket.rbi
|
|
1697
1704
|
- rbi/openai/helpers/local_audio/interface.rbi
|
|
1698
1705
|
- rbi/openai/helpers/realtime/connection.rbi
|
|
1699
1706
|
- rbi/openai/helpers/realtime/connection_manager.rbi
|
|
@@ -1701,6 +1708,7 @@ files:
|
|
|
1701
1708
|
- rbi/openai/helpers/realtime/extensions.rbi
|
|
1702
1709
|
- rbi/openai/helpers/realtime/recovery.rbi
|
|
1703
1710
|
- rbi/openai/helpers/realtime/sideband_connection.rbi
|
|
1711
|
+
- rbi/openai/helpers/realtime/translation.rbi
|
|
1704
1712
|
- rbi/openai/helpers/realtime/transports/async_websocket.rbi
|
|
1705
1713
|
- rbi/openai/helpers/realtime/unknown_server_event.rbi
|
|
1706
1714
|
- rbi/openai/helpers/resource_polling.rbi
|
|
@@ -1708,6 +1716,7 @@ files:
|
|
|
1708
1716
|
- rbi/openai/helpers/responses_websocket/connection_manager.rbi
|
|
1709
1717
|
- rbi/openai/helpers/responses_websocket/connection_resources.rbi
|
|
1710
1718
|
- rbi/openai/helpers/responses_websocket/extensions.rbi
|
|
1719
|
+
- rbi/openai/helpers/responses_websocket/incremental.rbi
|
|
1711
1720
|
- rbi/openai/helpers/responses_websocket/session.rbi
|
|
1712
1721
|
- rbi/openai/helpers/responses_websocket/transports/async_websocket.rbi
|
|
1713
1722
|
- rbi/openai/helpers/responses_websocket/unknown_server_event.rbi
|
|
@@ -3273,6 +3282,8 @@ files:
|
|
|
3273
3282
|
- sig/openai/helpers/agents.rbs
|
|
3274
3283
|
- sig/openai/helpers/client_options.rbs
|
|
3275
3284
|
- sig/openai/helpers/data_residency.rbs
|
|
3285
|
+
- sig/openai/helpers/live/transcript_grouper.rbs
|
|
3286
|
+
- sig/openai/helpers/live/websocket.rbs
|
|
3276
3287
|
- sig/openai/helpers/local_audio/interface.rbs
|
|
3277
3288
|
- sig/openai/helpers/realtime/connection.rbs
|
|
3278
3289
|
- sig/openai/helpers/realtime/connection_manager.rbs
|
|
@@ -3280,6 +3291,7 @@ files:
|
|
|
3280
3291
|
- sig/openai/helpers/realtime/extensions.rbs
|
|
3281
3292
|
- sig/openai/helpers/realtime/recovery.rbs
|
|
3282
3293
|
- sig/openai/helpers/realtime/sideband_connection.rbs
|
|
3294
|
+
- sig/openai/helpers/realtime/translation.rbs
|
|
3283
3295
|
- sig/openai/helpers/realtime/transports/async_websocket.rbs
|
|
3284
3296
|
- sig/openai/helpers/realtime/unknown_server_event.rbs
|
|
3285
3297
|
- sig/openai/helpers/resource_polling.rbs
|
|
@@ -3287,6 +3299,7 @@ files:
|
|
|
3287
3299
|
- sig/openai/helpers/responses_websocket/connection_manager.rbs
|
|
3288
3300
|
- sig/openai/helpers/responses_websocket/connection_resources.rbs
|
|
3289
3301
|
- sig/openai/helpers/responses_websocket/extensions.rbs
|
|
3302
|
+
- sig/openai/helpers/responses_websocket/incremental.rbs
|
|
3290
3303
|
- sig/openai/helpers/responses_websocket/session.rbs
|
|
3291
3304
|
- sig/openai/helpers/responses_websocket/transports/async_websocket.rbs
|
|
3292
3305
|
- sig/openai/helpers/responses_websocket/unknown_server_event.rbs
|