openai 0.90.0 → 0.92.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 +31 -0
- data/README.md +1 -1
- data/examples/realtime/README.md +8 -0
- data/examples/realtime/browser/README.md +167 -0
- data/examples/realtime/browser/index.html +19 -0
- data/examples/realtime/browser/page.js +21 -0
- data/examples/realtime/browser/peer.js +180 -0
- data/examples/realtime/browser/server.rb +281 -0
- data/examples/responses/websocket_workflows.rb +66 -6
- data/lib/openai/auth/workload_identity.rb +5 -1
- data/lib/openai/auth/workload_identity_auth.rb +2 -2
- data/lib/openai/auth/x509_token_exchange.rb +1 -1
- data/lib/openai/helpers/local_audio/process.rb +1 -1
- data/lib/openai/helpers/responses_websocket/connection.rb +2 -1
- data/lib/openai/helpers/responses_websocket/session.rb +551 -0
- data/lib/openai/helpers/responses_websocket.rb +1 -0
- data/lib/openai/helpers/sorbet.rb +1 -1
- data/lib/openai/helpers/websocket/async_websocket_transport.rb +6 -1
- data/lib/openai/internal/poller.rb +2 -2
- data/lib/openai/internal/transport/base_client.rb +1 -1
- data/lib/openai/internal/util.rb +1 -1
- data/lib/openai/models/beta/agents/session_update_params.rb +108 -1
- data/lib/openai/models/beta/beta_response.rb +9 -3
- data/lib/openai/models/beta/beta_response_compaction_compacting_event.rb +75 -0
- data/lib/openai/models/beta/beta_response_stream_event.rb +4 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +25 -4
- data/lib/openai/models/beta/beta_responses_server_event.rb +39 -1
- data/lib/openai/models/beta/beta_tool.rb +16 -0
- data/lib/openai/models/beta/response_compact_params.rb +9 -3
- data/lib/openai/models/beta/response_create_params.rb +21 -4
- data/lib/openai/models/beta/session_turn_error.rb +3 -0
- data/lib/openai/models/chat_model.rb +3 -1
- data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +16 -0
- data/lib/openai/models/realtime/realtime_session_create_response.rb +16 -0
- data/lib/openai/models/realtime/realtime_tools_config_union.rb +16 -0
- data/lib/openai/models/responses/response_compact_params.rb +9 -3
- data/lib/openai/models/responses/response_compaction_compacting_event.rb +49 -0
- data/lib/openai/models/responses/response_create_params.rb +12 -1
- data/lib/openai/models/responses/response_stream_event.rb +4 -1
- data/lib/openai/models/responses/responses_client_event.rb +12 -1
- data/lib/openai/models/responses/responses_server_event.rb +36 -1
- data/lib/openai/models/responses/tool.rb +16 -0
- data/lib/openai/models/webhooks/deleted_webhook_endpoint.rb +38 -0
- data/lib/openai/models/webhooks/event_type_list_params.rb +16 -0
- data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +6 -8
- data/lib/openai/models/webhooks/webhook_create_params.rb +73 -0
- data/lib/openai/models/webhooks/webhook_delete_params.rb +22 -0
- data/lib/openai/models/webhooks/webhook_endpoint.rb +85 -0
- data/lib/openai/models/webhooks/webhook_endpoint_list.rb +55 -0
- data/lib/openai/models/webhooks/webhook_endpoint_test_result.rb +58 -0
- data/lib/openai/models/webhooks/webhook_endpoint_with_secret.rb +105 -0
- data/lib/openai/models/webhooks/webhook_event_type_list.rb +28 -0
- data/lib/openai/models/webhooks/webhook_list_params.rb +34 -0
- data/lib/openai/models/webhooks/webhook_retrieve_params.rb +22 -0
- data/lib/openai/models/webhooks/webhook_rotate_secret_params.rb +34 -0
- data/lib/openai/models/webhooks/webhook_test_params.rb +59 -0
- data/lib/openai/models/webhooks/webhook_update_params.rb +80 -0
- data/lib/openai/resources/beta/agents/sessions.rb +6 -2
- data/lib/openai/resources/beta/responses.rb +2 -2
- data/lib/openai/resources/responses.rb +2 -2
- data/lib/openai/resources/webhooks/event_types.rb +35 -0
- data/lib/openai/resources/webhooks.rb +195 -0
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +17 -0
- data/rbi/openai/helpers/responses_websocket/connection.rbi +5 -0
- data/rbi/openai/helpers/responses_websocket/session.rbi +206 -0
- data/rbi/openai/models/beta/agents/session_update_params.rbi +178 -0
- data/rbi/openai/models/beta/beta_response.rbi +6 -1
- data/rbi/openai/models/beta/beta_response_compaction_compacting_event.rbi +136 -0
- data/rbi/openai/models/beta/beta_response_stream_event.rbi +1 -0
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +27 -4
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +77 -0
- data/rbi/openai/models/beta/beta_tool.rbi +12 -0
- data/rbi/openai/models/beta/response_compact_params.rbi +6 -1
- data/rbi/openai/models/beta/response_create_params.rbi +21 -1
- data/rbi/openai/models/beta/session_turn_error.rbi +6 -0
- data/rbi/openai/models/chat_model.rbi +3 -1
- data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +12 -0
- data/rbi/openai/models/realtime/realtime_session_create_response.rbi +12 -0
- data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +12 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +6 -1
- data/rbi/openai/models/responses/response_compaction_compacting_event.rbi +78 -0
- data/rbi/openai/models/responses/response_create_params.rbi +15 -0
- data/rbi/openai/models/responses/response_stream_event.rbi +1 -0
- data/rbi/openai/models/responses/responses_client_event.rbi +15 -0
- data/rbi/openai/models/responses/responses_server_event.rbi +71 -0
- data/rbi/openai/models/responses/tool.rbi +12 -0
- data/rbi/openai/models/webhooks/deleted_webhook_endpoint.rbi +67 -0
- data/rbi/openai/models/webhooks/event_type_list_params.rbi +37 -0
- data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +6 -8
- data/rbi/openai/models/webhooks/webhook_create_params.rbi +139 -0
- data/rbi/openai/models/webhooks/webhook_delete_params.rbi +53 -0
- data/rbi/openai/models/webhooks/webhook_endpoint.rbi +126 -0
- data/rbi/openai/models/webhooks/webhook_endpoint_list.rbi +91 -0
- data/rbi/openai/models/webhooks/webhook_endpoint_test_result.rbi +87 -0
- data/rbi/openai/models/webhooks/webhook_endpoint_with_secret.rbi +138 -0
- data/rbi/openai/models/webhooks/webhook_event_type_list.rbi +58 -0
- data/rbi/openai/models/webhooks/webhook_list_params.rbi +67 -0
- data/rbi/openai/models/webhooks/webhook_retrieve_params.rbi +53 -0
- data/rbi/openai/models/webhooks/webhook_rotate_secret_params.rbi +71 -0
- data/rbi/openai/models/webhooks/webhook_test_params.rbi +124 -0
- data/rbi/openai/models/webhooks/webhook_update_params.rbi +156 -0
- data/rbi/openai/resources/beta/agents/sessions.rbi +5 -1
- data/rbi/openai/resources/webhooks/event_types.rbi +24 -0
- data/rbi/openai/resources/webhooks.rbi +126 -0
- data/responses-websocket.md +117 -10
- data/sig/openai/helpers/responses_websocket/connection.rbs +5 -0
- data/sig/openai/helpers/responses_websocket/session.rbs +123 -0
- data/sig/openai/models/beta/agents/session_update_params.rbs +99 -0
- data/sig/openai/models/beta/beta_response.rbs +6 -2
- data/sig/openai/models/beta/beta_response_compaction_compacting_event.rbs +58 -0
- data/sig/openai/models/beta/beta_response_stream_event.rbs +1 -0
- data/sig/openai/models/beta/beta_responses_client_event.rbs +13 -2
- data/sig/openai/models/beta/beta_responses_server_event.rbs +35 -0
- data/sig/openai/models/beta/response_compact_params.rbs +6 -2
- data/sig/openai/models/beta/response_create_params.rbs +13 -2
- data/sig/openai/models/beta/session_turn_error.rbs +4 -0
- data/sig/openai/models/chat_model.rbs +6 -2
- data/sig/openai/models/responses/response_compact_params.rbs +6 -2
- data/sig/openai/models/responses/response_compaction_compacting_event.rbs +37 -0
- data/sig/openai/models/responses/response_create_params.rbs +7 -0
- data/sig/openai/models/responses/response_stream_event.rbs +1 -0
- data/sig/openai/models/responses/responses_client_event.rbs +7 -0
- data/sig/openai/models/responses/responses_server_event.rbs +32 -0
- data/sig/openai/models/webhooks/deleted_webhook_endpoint.rbs +28 -0
- data/sig/openai/models/webhooks/event_type_list_params.rbs +16 -0
- data/sig/openai/models/webhooks/webhook_create_params.rbs +83 -0
- data/sig/openai/models/webhooks/webhook_delete_params.rbs +25 -0
- data/sig/openai/models/webhooks/webhook_endpoint.rbs +59 -0
- data/sig/openai/models/webhooks/webhook_endpoint_list.rbs +42 -0
- data/sig/openai/models/webhooks/webhook_endpoint_test_result.rbs +42 -0
- data/sig/openai/models/webhooks/webhook_endpoint_with_secret.rbs +64 -0
- data/sig/openai/models/webhooks/webhook_event_type_list.rbs +17 -0
- data/sig/openai/models/webhooks/webhook_list_params.rbs +35 -0
- data/sig/openai/models/webhooks/webhook_retrieve_params.rbs +25 -0
- data/sig/openai/models/webhooks/webhook_rotate_secret_params.rbs +35 -0
- data/sig/openai/models/webhooks/webhook_test_params.rbs +78 -0
- data/sig/openai/models/webhooks/webhook_update_params.rbs +96 -0
- data/sig/openai/resources/beta/agents/sessions.rbs +1 -0
- data/sig/openai/resources/webhooks/event_types.rbs +13 -0
- data/sig/openai/resources/webhooks.rbs +45 -0
- metadata +61 -2
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#delete
|
|
7
|
+
class WebhookDeleteParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute webhook_endpoint_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :webhook_endpoint_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(webhook_endpoint_id:, request_options: {})
|
|
17
|
+
# @param webhook_endpoint_id [String]
|
|
18
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#retrieve
|
|
7
|
+
class WebhookEndpoint < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
# The unique ID of the webhook endpoint.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :id, String
|
|
13
|
+
|
|
14
|
+
# @!attribute created_at
|
|
15
|
+
# The Unix timestamp when the endpoint was created.
|
|
16
|
+
#
|
|
17
|
+
# @return [Integer]
|
|
18
|
+
required :created_at, Integer
|
|
19
|
+
|
|
20
|
+
# @!attribute event_types
|
|
21
|
+
# The event types that trigger deliveries to this endpoint.
|
|
22
|
+
#
|
|
23
|
+
# @return [Array<String>]
|
|
24
|
+
required :event_types, OpenAI::Internal::Type::ArrayOf[String]
|
|
25
|
+
|
|
26
|
+
# @!attribute name
|
|
27
|
+
# The human-readable name of the endpoint.
|
|
28
|
+
#
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :name, String
|
|
31
|
+
|
|
32
|
+
# @!attribute object
|
|
33
|
+
# The object type, which is always webhook_endpoint.
|
|
34
|
+
#
|
|
35
|
+
# @return [Symbol, :webhook_endpoint]
|
|
36
|
+
required :object, const: :webhook_endpoint
|
|
37
|
+
|
|
38
|
+
# @!attribute signing_secret_hint
|
|
39
|
+
# A masked hint for the endpoint's signing secret.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
required :signing_secret_hint, String, nil?: true
|
|
43
|
+
|
|
44
|
+
# @!attribute url
|
|
45
|
+
# The HTTPS URL that receives webhook deliveries.
|
|
46
|
+
#
|
|
47
|
+
# @return [String]
|
|
48
|
+
required :url, String
|
|
49
|
+
|
|
50
|
+
# @!attribute updated_at
|
|
51
|
+
# The Unix timestamp of the last endpoint configuration or signing-secret change.
|
|
52
|
+
# Initialized at creation; tests and unchanged updates do not advance it.
|
|
53
|
+
#
|
|
54
|
+
# @return [Integer, nil]
|
|
55
|
+
optional :updated_at, Integer
|
|
56
|
+
|
|
57
|
+
# @!method initialize(id:, created_at:, event_types:, name:, signing_secret_hint:, url:, updated_at: nil, object: :webhook_endpoint)
|
|
58
|
+
# @param id [String]
|
|
59
|
+
# The unique ID of the webhook endpoint.
|
|
60
|
+
#
|
|
61
|
+
# @param created_at [Integer]
|
|
62
|
+
# The Unix timestamp when the endpoint was created.
|
|
63
|
+
#
|
|
64
|
+
# @param event_types [Array<String>]
|
|
65
|
+
# The event types that trigger deliveries to this endpoint.
|
|
66
|
+
#
|
|
67
|
+
# @param name [String]
|
|
68
|
+
# The human-readable name of the endpoint.
|
|
69
|
+
#
|
|
70
|
+
# @param signing_secret_hint [String, nil]
|
|
71
|
+
# A masked hint for the endpoint's signing secret.
|
|
72
|
+
#
|
|
73
|
+
# @param url [String]
|
|
74
|
+
# The HTTPS URL that receives webhook deliveries.
|
|
75
|
+
#
|
|
76
|
+
# @param updated_at [Integer]
|
|
77
|
+
# The Unix timestamp of the last endpoint configuration or signing-secret change.
|
|
78
|
+
# Initialized at creation; tests and unchanged updates do not advance it.
|
|
79
|
+
#
|
|
80
|
+
# @param object [Symbol, :webhook_endpoint]
|
|
81
|
+
# The object type, which is always webhook_endpoint.
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class WebhookEndpointList < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# The webhook endpoints in this page.
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<OpenAI::Models::Webhooks::WebhookEndpoint>]
|
|
11
|
+
required :data, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Webhooks::WebhookEndpoint] }
|
|
12
|
+
|
|
13
|
+
# @!attribute first_id
|
|
14
|
+
# The ID of the first endpoint in this page.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
required :first_id, String, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute has_more
|
|
20
|
+
# Whether more webhook endpoints are available.
|
|
21
|
+
#
|
|
22
|
+
# @return [Boolean]
|
|
23
|
+
required :has_more, OpenAI::Internal::Type::Boolean
|
|
24
|
+
|
|
25
|
+
# @!attribute last_id
|
|
26
|
+
# The ID of the last endpoint in this page.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
required :last_id, String, nil?: true
|
|
30
|
+
|
|
31
|
+
# @!attribute object
|
|
32
|
+
# The object type, which is always list.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, :list]
|
|
35
|
+
required :object, const: :list
|
|
36
|
+
|
|
37
|
+
# @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
|
|
38
|
+
# @param data [Array<OpenAI::Models::Webhooks::WebhookEndpoint>]
|
|
39
|
+
# The webhook endpoints in this page.
|
|
40
|
+
#
|
|
41
|
+
# @param first_id [String, nil]
|
|
42
|
+
# The ID of the first endpoint in this page.
|
|
43
|
+
#
|
|
44
|
+
# @param has_more [Boolean]
|
|
45
|
+
# Whether more webhook endpoints are available.
|
|
46
|
+
#
|
|
47
|
+
# @param last_id [String, nil]
|
|
48
|
+
# The ID of the last endpoint in this page.
|
|
49
|
+
#
|
|
50
|
+
# @param object [Symbol, :list]
|
|
51
|
+
# The object type, which is always list.
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#test_
|
|
7
|
+
class WebhookEndpointTestResult < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute event_type
|
|
9
|
+
# The event type sent in the test.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :event_type, String
|
|
13
|
+
|
|
14
|
+
# @!attribute object
|
|
15
|
+
# The object type, which is always webhook_endpoint.test.
|
|
16
|
+
#
|
|
17
|
+
# @return [Symbol, :"webhook_endpoint.test"]
|
|
18
|
+
required :object, const: :"webhook_endpoint.test"
|
|
19
|
+
|
|
20
|
+
# @!attribute status_code
|
|
21
|
+
# The HTTP status code returned by the endpoint.
|
|
22
|
+
#
|
|
23
|
+
# @return [Integer]
|
|
24
|
+
required :status_code, Integer
|
|
25
|
+
|
|
26
|
+
# @!attribute success
|
|
27
|
+
# Whether the test request completed. Always true for returned results; use
|
|
28
|
+
# status_code to determine the endpoint response.
|
|
29
|
+
#
|
|
30
|
+
# @return [Boolean]
|
|
31
|
+
required :success, OpenAI::Internal::Type::Boolean
|
|
32
|
+
|
|
33
|
+
# @!attribute webhook_endpoint_id
|
|
34
|
+
# The ID of the webhook endpoint that received the test.
|
|
35
|
+
#
|
|
36
|
+
# @return [String]
|
|
37
|
+
required :webhook_endpoint_id, String
|
|
38
|
+
|
|
39
|
+
# @!method initialize(event_type:, status_code:, success:, webhook_endpoint_id:, object: :"webhook_endpoint.test")
|
|
40
|
+
# @param event_type [String]
|
|
41
|
+
# The event type sent in the test.
|
|
42
|
+
#
|
|
43
|
+
# @param status_code [Integer]
|
|
44
|
+
# The HTTP status code returned by the endpoint.
|
|
45
|
+
#
|
|
46
|
+
# @param success [Boolean]
|
|
47
|
+
# Whether the test request completed. Always true for returned results; use
|
|
48
|
+
# status_code to determine the endpoint response.
|
|
49
|
+
#
|
|
50
|
+
# @param webhook_endpoint_id [String]
|
|
51
|
+
# The ID of the webhook endpoint that received the test.
|
|
52
|
+
#
|
|
53
|
+
# @param object [Symbol, :"webhook_endpoint.test"]
|
|
54
|
+
# The object type, which is always webhook_endpoint.test.
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#create
|
|
7
|
+
class WebhookEndpointWithSecret < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
# The unique ID of the webhook endpoint.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :id, String
|
|
13
|
+
|
|
14
|
+
# @!attribute created_at
|
|
15
|
+
# The Unix timestamp when the endpoint was created.
|
|
16
|
+
#
|
|
17
|
+
# @return [Integer]
|
|
18
|
+
required :created_at, Integer
|
|
19
|
+
|
|
20
|
+
# @!attribute event_types
|
|
21
|
+
# The event types that trigger deliveries to this endpoint.
|
|
22
|
+
#
|
|
23
|
+
# @return [Array<String>]
|
|
24
|
+
required :event_types, OpenAI::Internal::Type::ArrayOf[String]
|
|
25
|
+
|
|
26
|
+
# @!attribute name
|
|
27
|
+
# The human-readable name of the endpoint.
|
|
28
|
+
#
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :name, String
|
|
31
|
+
|
|
32
|
+
# @!attribute object
|
|
33
|
+
# The object type, which is always webhook_endpoint.
|
|
34
|
+
#
|
|
35
|
+
# @return [Symbol, :webhook_endpoint]
|
|
36
|
+
required :object, const: :webhook_endpoint
|
|
37
|
+
|
|
38
|
+
# @!attribute signing_secret
|
|
39
|
+
# The endpoint's signing secret. This is returned only when the endpoint is
|
|
40
|
+
# created or the secret is rotated.
|
|
41
|
+
#
|
|
42
|
+
# @return [String]
|
|
43
|
+
required :signing_secret, String
|
|
44
|
+
|
|
45
|
+
# @!attribute signing_secret_hint
|
|
46
|
+
# A masked hint for the endpoint's signing secret.
|
|
47
|
+
#
|
|
48
|
+
# @return [String, nil]
|
|
49
|
+
required :signing_secret_hint, String, nil?: true
|
|
50
|
+
|
|
51
|
+
# @!attribute url
|
|
52
|
+
# The HTTPS URL that receives webhook deliveries.
|
|
53
|
+
#
|
|
54
|
+
# @return [String]
|
|
55
|
+
required :url, String
|
|
56
|
+
|
|
57
|
+
# @!attribute updated_at
|
|
58
|
+
# The Unix timestamp of the last endpoint configuration or signing-secret change.
|
|
59
|
+
# Initialized at creation; tests and unchanged updates do not advance it.
|
|
60
|
+
#
|
|
61
|
+
# @return [Integer, nil]
|
|
62
|
+
optional :updated_at, Integer
|
|
63
|
+
|
|
64
|
+
# @!method initialize(id:, created_at:, event_types:, name:, signing_secret:, signing_secret_hint:, url:, updated_at: nil, object: :webhook_endpoint)
|
|
65
|
+
# @param id [String]
|
|
66
|
+
# The unique ID of the webhook endpoint.
|
|
67
|
+
#
|
|
68
|
+
# @param created_at [Integer]
|
|
69
|
+
# The Unix timestamp when the endpoint was created.
|
|
70
|
+
#
|
|
71
|
+
# @param event_types [Array<String>]
|
|
72
|
+
# The event types that trigger deliveries to this endpoint.
|
|
73
|
+
#
|
|
74
|
+
# @param name [String]
|
|
75
|
+
# The human-readable name of the endpoint.
|
|
76
|
+
#
|
|
77
|
+
# @param signing_secret [String]
|
|
78
|
+
# The endpoint's signing secret. This is returned only when the endpoint is
|
|
79
|
+
# created or the secret is rotated.
|
|
80
|
+
#
|
|
81
|
+
# @param signing_secret_hint [String, nil]
|
|
82
|
+
# A masked hint for the endpoint's signing secret.
|
|
83
|
+
#
|
|
84
|
+
# @param url [String]
|
|
85
|
+
# The HTTPS URL that receives webhook deliveries.
|
|
86
|
+
#
|
|
87
|
+
# @param updated_at [Integer]
|
|
88
|
+
# The Unix timestamp of the last endpoint configuration or signing-secret change.
|
|
89
|
+
# Initialized at creation; tests and unchanged updates do not advance it.
|
|
90
|
+
#
|
|
91
|
+
# @param object [Symbol, :webhook_endpoint]
|
|
92
|
+
# The object type, which is always webhook_endpoint.
|
|
93
|
+
|
|
94
|
+
# Keep diagnostics safe without changing field access or serialization.
|
|
95
|
+
def to_s = deep_to_h.merge(signing_secret: "[REDACTED]").to_s
|
|
96
|
+
|
|
97
|
+
def inspect
|
|
98
|
+
converted = self.class.recursively_to_h(self, convert: true)
|
|
99
|
+
converted[:signing_secret] = "[REDACTED]"
|
|
100
|
+
"#<#{self.class}:0x#{object_id.to_s(16)} #{converted}>"
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class WebhookEventTypeList < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# The webhook event types available to the authenticated project.
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<String>]
|
|
11
|
+
required :data, OpenAI::Internal::Type::ArrayOf[String]
|
|
12
|
+
|
|
13
|
+
# @!attribute object
|
|
14
|
+
# The object type, which is always list.
|
|
15
|
+
#
|
|
16
|
+
# @return [Symbol, :list]
|
|
17
|
+
required :object, const: :list
|
|
18
|
+
|
|
19
|
+
# @!method initialize(data:, object: :list)
|
|
20
|
+
# @param data [Array<String>]
|
|
21
|
+
# The webhook event types available to the authenticated project.
|
|
22
|
+
#
|
|
23
|
+
# @param object [Symbol, :list]
|
|
24
|
+
# The object type, which is always list.
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#list
|
|
7
|
+
class WebhookListParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute after
|
|
12
|
+
# ID of the last webhook endpoint from the previous page.
|
|
13
|
+
#
|
|
14
|
+
# @return [String, nil]
|
|
15
|
+
optional :after, String, nil?: true
|
|
16
|
+
|
|
17
|
+
# @!attribute limit
|
|
18
|
+
# Maximum number of webhook endpoints to return. Defaults to 20.
|
|
19
|
+
#
|
|
20
|
+
# @return [Integer, nil]
|
|
21
|
+
optional :limit, Integer
|
|
22
|
+
|
|
23
|
+
# @!method initialize(after: nil, limit: nil, request_options: {})
|
|
24
|
+
# @param after [String, nil]
|
|
25
|
+
# ID of the last webhook endpoint from the previous page.
|
|
26
|
+
#
|
|
27
|
+
# @param limit [Integer]
|
|
28
|
+
# Maximum number of webhook endpoints to return. Defaults to 20.
|
|
29
|
+
#
|
|
30
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#retrieve
|
|
7
|
+
class WebhookRetrieveParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute webhook_endpoint_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :webhook_endpoint_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(webhook_endpoint_id:, request_options: {})
|
|
17
|
+
# @param webhook_endpoint_id [String]
|
|
18
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#rotate_secret
|
|
7
|
+
class WebhookRotateSecretParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute webhook_endpoint_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :webhook_endpoint_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute keep_old_secret_active_for_24_hours
|
|
17
|
+
# Whether to keep the previous signing secret valid for 24 hours after rotation.
|
|
18
|
+
# Defaults to false, which invalidates the previous secret immediately.
|
|
19
|
+
#
|
|
20
|
+
# @return [Boolean, nil]
|
|
21
|
+
optional :keep_old_secret_active_for_24_hours, OpenAI::Internal::Type::Boolean
|
|
22
|
+
|
|
23
|
+
# @!method initialize(webhook_endpoint_id:, keep_old_secret_active_for_24_hours: nil, request_options: {})
|
|
24
|
+
# @param webhook_endpoint_id [String]
|
|
25
|
+
#
|
|
26
|
+
# @param keep_old_secret_active_for_24_hours [Boolean]
|
|
27
|
+
# Whether to keep the previous signing secret valid for 24 hours after rotation.
|
|
28
|
+
# Defaults to false, which invalidates the previous secret immediately.
|
|
29
|
+
#
|
|
30
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#test_
|
|
7
|
+
class WebhookTestParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute webhook_endpoint_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :webhook_endpoint_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute event_type
|
|
17
|
+
# The event type to send as a sample delivery.
|
|
18
|
+
#
|
|
19
|
+
# @return [Symbol, OpenAI::Models::Webhooks::WebhookTestParams::EventType]
|
|
20
|
+
required :event_type, enum: -> { OpenAI::Webhooks::WebhookTestParams::EventType }
|
|
21
|
+
|
|
22
|
+
# @!method initialize(webhook_endpoint_id:, event_type:, request_options: {})
|
|
23
|
+
# @param webhook_endpoint_id [String]
|
|
24
|
+
#
|
|
25
|
+
# @param event_type [Symbol, OpenAI::Models::Webhooks::WebhookTestParams::EventType]
|
|
26
|
+
# The event type to send as a sample delivery.
|
|
27
|
+
#
|
|
28
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
29
|
+
|
|
30
|
+
# The event type to send as a sample delivery.
|
|
31
|
+
module EventType
|
|
32
|
+
extend OpenAI::Internal::Type::Enum
|
|
33
|
+
|
|
34
|
+
BATCH_COMPLETED = :"batch.completed"
|
|
35
|
+
BATCH_FAILED = :"batch.failed"
|
|
36
|
+
BATCH_EXPIRED = :"batch.expired"
|
|
37
|
+
BATCH_CANCELLED = :"batch.cancelled"
|
|
38
|
+
RESPONSE_COMPLETED = :"response.completed"
|
|
39
|
+
RESPONSE_FAILED = :"response.failed"
|
|
40
|
+
RESPONSE_CANCELLED = :"response.cancelled"
|
|
41
|
+
RESPONSE_INCOMPLETE = :"response.incomplete"
|
|
42
|
+
EVAL_RUN_SUCCEEDED = :"eval.run.succeeded"
|
|
43
|
+
EVAL_RUN_FAILED = :"eval.run.failed"
|
|
44
|
+
EVAL_RUN_CANCELED = :"eval.run.canceled"
|
|
45
|
+
FINE_TUNING_JOB_SUCCEEDED = :"fine_tuning.job.succeeded"
|
|
46
|
+
FINE_TUNING_JOB_FAILED = :"fine_tuning.job.failed"
|
|
47
|
+
FINE_TUNING_JOB_CANCELLED = :"fine_tuning.job.cancelled"
|
|
48
|
+
REALTIME_CALL_INCOMING = :"realtime.call.incoming"
|
|
49
|
+
VIDEO_COMPLETED = :"video.completed"
|
|
50
|
+
VIDEO_FAILED = :"video.failed"
|
|
51
|
+
SAFETY_ALERT_CREATED = :"safety.alert.created"
|
|
52
|
+
|
|
53
|
+
# @!method self.values
|
|
54
|
+
# @return [Array<Symbol>]
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# @see OpenAI::Resources::Webhooks#update
|
|
7
|
+
class WebhookUpdateParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute webhook_endpoint_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :webhook_endpoint_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute event_types
|
|
17
|
+
# The complete set of event types that should trigger deliveries.
|
|
18
|
+
#
|
|
19
|
+
# @return [Array<Symbol, OpenAI::Models::Webhooks::WebhookUpdateParams::EventType>, nil]
|
|
20
|
+
optional(
|
|
21
|
+
:event_types,
|
|
22
|
+
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Webhooks::WebhookUpdateParams::EventType] }
|
|
23
|
+
)
|
|
24
|
+
|
|
25
|
+
# @!attribute name
|
|
26
|
+
# A new human-readable name for the webhook endpoint.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :name, String
|
|
30
|
+
|
|
31
|
+
# @!attribute url
|
|
32
|
+
# A new HTTPS URL that receives webhook deliveries.
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :url, String
|
|
36
|
+
|
|
37
|
+
# @!method initialize(webhook_endpoint_id:, event_types: nil, name: nil, url: nil, request_options: {})
|
|
38
|
+
# @param webhook_endpoint_id [String]
|
|
39
|
+
#
|
|
40
|
+
# @param event_types [Array<Symbol, OpenAI::Models::Webhooks::WebhookUpdateParams::EventType>]
|
|
41
|
+
# The complete set of event types that should trigger deliveries.
|
|
42
|
+
#
|
|
43
|
+
# @param name [String]
|
|
44
|
+
# A new human-readable name for the webhook endpoint.
|
|
45
|
+
#
|
|
46
|
+
# @param url [String]
|
|
47
|
+
# A new HTTPS URL that receives webhook deliveries.
|
|
48
|
+
#
|
|
49
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
50
|
+
|
|
51
|
+
# The event type to send as a sample delivery.
|
|
52
|
+
module EventType
|
|
53
|
+
extend OpenAI::Internal::Type::Enum
|
|
54
|
+
|
|
55
|
+
BATCH_COMPLETED = :"batch.completed"
|
|
56
|
+
BATCH_FAILED = :"batch.failed"
|
|
57
|
+
BATCH_EXPIRED = :"batch.expired"
|
|
58
|
+
BATCH_CANCELLED = :"batch.cancelled"
|
|
59
|
+
RESPONSE_COMPLETED = :"response.completed"
|
|
60
|
+
RESPONSE_FAILED = :"response.failed"
|
|
61
|
+
RESPONSE_CANCELLED = :"response.cancelled"
|
|
62
|
+
RESPONSE_INCOMPLETE = :"response.incomplete"
|
|
63
|
+
EVAL_RUN_SUCCEEDED = :"eval.run.succeeded"
|
|
64
|
+
EVAL_RUN_FAILED = :"eval.run.failed"
|
|
65
|
+
EVAL_RUN_CANCELED = :"eval.run.canceled"
|
|
66
|
+
FINE_TUNING_JOB_SUCCEEDED = :"fine_tuning.job.succeeded"
|
|
67
|
+
FINE_TUNING_JOB_FAILED = :"fine_tuning.job.failed"
|
|
68
|
+
FINE_TUNING_JOB_CANCELLED = :"fine_tuning.job.cancelled"
|
|
69
|
+
REALTIME_CALL_INCOMING = :"realtime.call.incoming"
|
|
70
|
+
VIDEO_COMPLETED = :"video.completed"
|
|
71
|
+
VIDEO_FAILED = :"video.failed"
|
|
72
|
+
SAFETY_ALERT_CREATED = :"safety.alert.created"
|
|
73
|
+
|
|
74
|
+
# @!method self.values
|
|
75
|
+
# @return [Array<Symbol>]
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
@@ -150,14 +150,18 @@ module OpenAI
|
|
|
150
150
|
)
|
|
151
151
|
end
|
|
152
152
|
|
|
153
|
-
# Updates session metadata
|
|
153
|
+
# Updates session metadata, model, reasoning effort, or service tier. Model
|
|
154
|
+
# settings apply to subsequent turns. Omitted fields are unchanged. See
|
|
154
155
|
# [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
|
|
155
156
|
#
|
|
156
|
-
# @overload update(session_id, metadata: nil, request_options: {})
|
|
157
|
+
# @overload update(session_id, agent: nil, metadata: nil, request_options: {})
|
|
157
158
|
#
|
|
158
159
|
# @param session_id [String]
|
|
159
160
|
# The ID of the session.
|
|
160
161
|
#
|
|
162
|
+
# @param agent [OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent]
|
|
163
|
+
# Model settings for subsequent turns. Omitted fields stay unchanged.
|
|
164
|
+
#
|
|
161
165
|
# @param metadata [Hash{Symbol=>String}, nil]
|
|
162
166
|
# Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
|
|
163
167
|
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
@@ -584,7 +584,7 @@ module OpenAI
|
|
|
584
584
|
#
|
|
585
585
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
586
586
|
#
|
|
587
|
-
# @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
|
|
587
|
+
# @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompactionCompactingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
|
|
588
588
|
#
|
|
589
589
|
# @see OpenAI::Models::Beta::ResponseCreateParams
|
|
590
590
|
def stream_raw(params = {})
|
|
@@ -698,7 +698,7 @@ module OpenAI
|
|
|
698
698
|
#
|
|
699
699
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
700
700
|
#
|
|
701
|
-
# @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
|
|
701
|
+
# @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompactionCompactingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
|
|
702
702
|
#
|
|
703
703
|
# @see OpenAI::Models::Beta::ResponseRetrieveParams
|
|
704
704
|
def retrieve_streaming(response_id, params = {})
|