openai 0.106.0 → 0.107.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.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +51 -0
  3. data/README.md +1 -1
  4. data/lib/openai/helpers/live/websocket.rb +12 -141
  5. data/lib/openai/helpers/local_audio/process.rb +13 -3
  6. data/lib/openai/helpers/models/embedding.rb +42 -0
  7. data/lib/openai/helpers/realtime/connection.rb +22 -5
  8. data/lib/openai/helpers/realtime/recovery.rb +11 -5
  9. data/lib/openai/helpers/realtime/translation.rb +37 -169
  10. data/lib/openai/helpers/realtime/unknown_server_event.rb +5 -12
  11. data/lib/openai/helpers/responses_websocket/connection.rb +56 -35
  12. data/lib/openai/helpers/responses_websocket/unknown_server_event.rb +2 -14
  13. data/lib/openai/helpers/websocket/async_websocket_transport.rb +8 -6
  14. data/lib/openai/helpers/websocket/client_request.rb +1 -1
  15. data/lib/openai/helpers/websocket/connection.rb +21 -10
  16. data/lib/openai/helpers/websocket/connection_manager.rb +2 -1
  17. data/lib/openai/helpers/websocket/protocol.rb +160 -0
  18. data/lib/openai/helpers/websocket/typed_connection.rb +22 -16
  19. data/lib/openai/helpers/websocket/typed_resource.rb +15 -0
  20. data/lib/openai/internal/transport/base_client.rb +1 -1
  21. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +12 -1
  22. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +12 -1
  23. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +12 -1
  24. data/lib/openai/models/admin/organization/usage_completions_response.rb +12 -1
  25. data/lib/openai/models/admin/organization/usage_costs_response.rb +12 -1
  26. data/lib/openai/models/admin/organization/usage_decisions_response.rb +12 -1
  27. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +12 -1
  28. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +12 -1
  29. data/lib/openai/models/admin/organization/usage_images_response.rb +12 -1
  30. data/lib/openai/models/admin/organization/usage_moderations_response.rb +12 -1
  31. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +12 -1
  32. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +12 -1
  33. data/lib/openai/models/beta/beta_response_input_item.rb +10 -1
  34. data/lib/openai/models/responses/response_input_item.rb +10 -1
  35. data/lib/openai/version.rb +1 -1
  36. data/lib/openai.rb +1 -0
  37. data/rbi/openai/client.rbi +1 -8
  38. data/rbi/openai/helpers/realtime/translation.rbi +0 -5
  39. data/rbi/openai/helpers/realtime/unknown_server_event.rbi +6 -0
  40. data/rbi/openai/helpers/websocket.rbi +44 -6
  41. data/rbi/openai/internal/transport/base_client.rbi +2 -6
  42. data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +12 -0
  43. data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +12 -0
  44. data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +12 -0
  45. data/rbi/openai/models/admin/organization/usage_completions_response.rbi +12 -0
  46. data/rbi/openai/models/admin/organization/usage_costs_response.rbi +12 -0
  47. data/rbi/openai/models/admin/organization/usage_decisions_response.rbi +12 -0
  48. data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +12 -0
  49. data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +12 -0
  50. data/rbi/openai/models/admin/organization/usage_images_response.rbi +12 -0
  51. data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +12 -0
  52. data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +12 -0
  53. data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +12 -0
  54. data/rbi/openai/models/beta/beta_response_input_item.rbi +14 -1
  55. data/rbi/openai/models/responses/response_input_item.rbi +10 -1
  56. data/realtime.md +22 -3
  57. data/sig/openai/client.rbs +1 -1
  58. data/sig/openai/helpers/realtime/translation.rbs +0 -2
  59. data/sig/openai/helpers/realtime/unknown_server_event.rbs +2 -0
  60. data/sig/openai/helpers/websocket.rbs +23 -6
  61. data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +10 -0
  62. data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +10 -0
  63. data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +10 -0
  64. data/sig/openai/models/admin/organization/usage_completions_response.rbs +10 -0
  65. data/sig/openai/models/admin/organization/usage_costs_response.rbs +10 -0
  66. data/sig/openai/models/admin/organization/usage_decisions_response.rbs +10 -0
  67. data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +10 -0
  68. data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +10 -0
  69. data/sig/openai/models/admin/organization/usage_images_response.rbs +10 -0
  70. data/sig/openai/models/admin/organization/usage_moderations_response.rbs +10 -0
  71. data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +10 -0
  72. data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +10 -0
  73. data/sig/openai/models/beta/beta_response_input_item.rbs +8 -0
  74. data/sig/openai/models/responses/response_input_item.rbs +8 -3
  75. metadata +3 -1
@@ -91,6 +91,7 @@ module OpenAI
91
91
  ?batch: bool?,
92
92
  ?input_audio_tokens: Integer,
93
93
  ?:input_cache_write_12h_tokens => Integer,
94
+ ?:input_cache_write_30m_tokens => Integer?,
94
95
  ?input_cache_write_tokens: Integer,
95
96
  ?input_cached_audio_tokens: Integer,
96
97
  ?input_cached_image_tokens: Integer,
@@ -152,6 +153,10 @@ module OpenAI
152
153
  # retention period.
153
154
  def input_cache_write_12h_tokens=: (Integer) -> Integer
154
155
 
156
+ # The aggregated number of input tokens written to the cache with a 30-minute
157
+ # retention period. May be absent or null for older responses.
158
+ attr_accessor input_cache_write_30m_tokens: Integer?
159
+
155
160
  # The aggregated number of input tokens written to the cache with a 30-minute
156
161
  # retention period.
157
162
  attr_reader input_cache_write_tokens: Integer?
@@ -268,6 +273,9 @@ module OpenAI
268
273
  # @param input_cache_write_12h_tokens
269
274
  # The aggregated number of input tokens written to the cache with a 12-hour
270
275
  # retention period.
276
+ # @param input_cache_write_30m_tokens
277
+ # The aggregated number of input tokens written to the cache with a 30-minute
278
+ # retention period. May be absent or null for older responses.
271
279
  # @param input_cache_write_tokens
272
280
  # The aggregated number of input tokens written to the cache with a 30-minute
273
281
  # retention period.
@@ -315,6 +323,7 @@ module OpenAI
315
323
  ?batch: bool?,
316
324
  ?input_audio_tokens: Integer,
317
325
  ?input_cache_write_12h_tokens: Integer,
326
+ ?input_cache_write_30m_tokens: Integer?,
318
327
  ?input_cache_write_tokens: Integer,
319
328
  ?input_cached_audio_tokens: Integer,
320
329
  ?input_cached_image_tokens: Integer,
@@ -343,6 +352,7 @@ module OpenAI
343
352
  ?batch: bool?,
344
353
  ?input_audio_tokens: Integer,
345
354
  ?:input_cache_write_12h_tokens => Integer,
355
+ ?:input_cache_write_30m_tokens => Integer?,
346
356
  ?input_cache_write_tokens: Integer,
347
357
  ?input_cached_audio_tokens: Integer,
348
358
  ?input_cached_image_tokens: Integer,
@@ -91,6 +91,7 @@ module OpenAI
91
91
  ?batch: bool?,
92
92
  ?input_audio_tokens: Integer,
93
93
  ?:input_cache_write_12h_tokens => Integer,
94
+ ?:input_cache_write_30m_tokens => Integer?,
94
95
  ?input_cache_write_tokens: Integer,
95
96
  ?input_cached_audio_tokens: Integer,
96
97
  ?input_cached_image_tokens: Integer,
@@ -152,6 +153,10 @@ module OpenAI
152
153
  # retention period.
153
154
  def input_cache_write_12h_tokens=: (Integer) -> Integer
154
155
 
156
+ # The aggregated number of input tokens written to the cache with a 30-minute
157
+ # retention period. May be absent or null for older responses.
158
+ attr_accessor input_cache_write_30m_tokens: Integer?
159
+
155
160
  # The aggregated number of input tokens written to the cache with a 30-minute
156
161
  # retention period.
157
162
  attr_reader input_cache_write_tokens: Integer?
@@ -268,6 +273,9 @@ module OpenAI
268
273
  # @param input_cache_write_12h_tokens
269
274
  # The aggregated number of input tokens written to the cache with a 12-hour
270
275
  # retention period.
276
+ # @param input_cache_write_30m_tokens
277
+ # The aggregated number of input tokens written to the cache with a 30-minute
278
+ # retention period. May be absent or null for older responses.
271
279
  # @param input_cache_write_tokens
272
280
  # The aggregated number of input tokens written to the cache with a 30-minute
273
281
  # retention period.
@@ -315,6 +323,7 @@ module OpenAI
315
323
  ?batch: bool?,
316
324
  ?input_audio_tokens: Integer,
317
325
  ?input_cache_write_12h_tokens: Integer,
326
+ ?input_cache_write_30m_tokens: Integer?,
318
327
  ?input_cache_write_tokens: Integer,
319
328
  ?input_cached_audio_tokens: Integer,
320
329
  ?input_cached_image_tokens: Integer,
@@ -343,6 +352,7 @@ module OpenAI
343
352
  ?batch: bool?,
344
353
  ?input_audio_tokens: Integer,
345
354
  ?:input_cache_write_12h_tokens => Integer,
355
+ ?:input_cache_write_30m_tokens => Integer?,
346
356
  ?input_cache_write_tokens: Integer,
347
357
  ?input_cached_audio_tokens: Integer,
348
358
  ?input_cached_image_tokens: Integer,
@@ -91,6 +91,7 @@ module OpenAI
91
91
  ?batch: bool?,
92
92
  ?input_audio_tokens: Integer,
93
93
  ?:input_cache_write_12h_tokens => Integer,
94
+ ?:input_cache_write_30m_tokens => Integer?,
94
95
  ?input_cache_write_tokens: Integer,
95
96
  ?input_cached_audio_tokens: Integer,
96
97
  ?input_cached_image_tokens: Integer,
@@ -152,6 +153,10 @@ module OpenAI
152
153
  # retention period.
153
154
  def input_cache_write_12h_tokens=: (Integer) -> Integer
154
155
 
156
+ # The aggregated number of input tokens written to the cache with a 30-minute
157
+ # retention period. May be absent or null for older responses.
158
+ attr_accessor input_cache_write_30m_tokens: Integer?
159
+
155
160
  # The aggregated number of input tokens written to the cache with a 30-minute
156
161
  # retention period.
157
162
  attr_reader input_cache_write_tokens: Integer?
@@ -268,6 +273,9 @@ module OpenAI
268
273
  # @param input_cache_write_12h_tokens
269
274
  # The aggregated number of input tokens written to the cache with a 12-hour
270
275
  # retention period.
276
+ # @param input_cache_write_30m_tokens
277
+ # The aggregated number of input tokens written to the cache with a 30-minute
278
+ # retention period. May be absent or null for older responses.
271
279
  # @param input_cache_write_tokens
272
280
  # The aggregated number of input tokens written to the cache with a 30-minute
273
281
  # retention period.
@@ -315,6 +323,7 @@ module OpenAI
315
323
  ?batch: bool?,
316
324
  ?input_audio_tokens: Integer,
317
325
  ?input_cache_write_12h_tokens: Integer,
326
+ ?input_cache_write_30m_tokens: Integer?,
318
327
  ?input_cache_write_tokens: Integer,
319
328
  ?input_cached_audio_tokens: Integer,
320
329
  ?input_cached_image_tokens: Integer,
@@ -343,6 +352,7 @@ module OpenAI
343
352
  ?batch: bool?,
344
353
  ?input_audio_tokens: Integer,
345
354
  ?:input_cache_write_12h_tokens => Integer,
355
+ ?:input_cache_write_30m_tokens => Integer?,
346
356
  ?input_cache_write_tokens: Integer,
347
357
  ?input_cached_audio_tokens: Integer,
348
358
  ?input_cached_image_tokens: Integer,
@@ -91,6 +91,7 @@ module OpenAI
91
91
  ?batch: bool?,
92
92
  ?input_audio_tokens: Integer,
93
93
  ?:input_cache_write_12h_tokens => Integer,
94
+ ?:input_cache_write_30m_tokens => Integer?,
94
95
  ?input_cache_write_tokens: Integer,
95
96
  ?input_cached_audio_tokens: Integer,
96
97
  ?input_cached_image_tokens: Integer,
@@ -152,6 +153,10 @@ module OpenAI
152
153
  # retention period.
153
154
  def input_cache_write_12h_tokens=: (Integer) -> Integer
154
155
 
156
+ # The aggregated number of input tokens written to the cache with a 30-minute
157
+ # retention period. May be absent or null for older responses.
158
+ attr_accessor input_cache_write_30m_tokens: Integer?
159
+
155
160
  # The aggregated number of input tokens written to the cache with a 30-minute
156
161
  # retention period.
157
162
  attr_reader input_cache_write_tokens: Integer?
@@ -268,6 +273,9 @@ module OpenAI
268
273
  # @param input_cache_write_12h_tokens
269
274
  # The aggregated number of input tokens written to the cache with a 12-hour
270
275
  # retention period.
276
+ # @param input_cache_write_30m_tokens
277
+ # The aggregated number of input tokens written to the cache with a 30-minute
278
+ # retention period. May be absent or null for older responses.
271
279
  # @param input_cache_write_tokens
272
280
  # The aggregated number of input tokens written to the cache with a 30-minute
273
281
  # retention period.
@@ -315,6 +323,7 @@ module OpenAI
315
323
  ?batch: bool?,
316
324
  ?input_audio_tokens: Integer,
317
325
  ?input_cache_write_12h_tokens: Integer,
326
+ ?input_cache_write_30m_tokens: Integer?,
318
327
  ?input_cache_write_tokens: Integer,
319
328
  ?input_cached_audio_tokens: Integer,
320
329
  ?input_cached_image_tokens: Integer,
@@ -343,6 +352,7 @@ module OpenAI
343
352
  ?batch: bool?,
344
353
  ?input_audio_tokens: Integer,
345
354
  ?:input_cache_write_12h_tokens => Integer,
355
+ ?:input_cache_write_30m_tokens => Integer?,
346
356
  ?input_cache_write_tokens: Integer,
347
357
  ?input_cached_audio_tokens: Integer,
348
358
  ?input_cached_image_tokens: Integer,
@@ -91,6 +91,7 @@ module OpenAI
91
91
  ?batch: bool?,
92
92
  ?input_audio_tokens: Integer,
93
93
  ?:input_cache_write_12h_tokens => Integer,
94
+ ?:input_cache_write_30m_tokens => Integer?,
94
95
  ?input_cache_write_tokens: Integer,
95
96
  ?input_cached_audio_tokens: Integer,
96
97
  ?input_cached_image_tokens: Integer,
@@ -152,6 +153,10 @@ module OpenAI
152
153
  # retention period.
153
154
  def input_cache_write_12h_tokens=: (Integer) -> Integer
154
155
 
156
+ # The aggregated number of input tokens written to the cache with a 30-minute
157
+ # retention period. May be absent or null for older responses.
158
+ attr_accessor input_cache_write_30m_tokens: Integer?
159
+
155
160
  # The aggregated number of input tokens written to the cache with a 30-minute
156
161
  # retention period.
157
162
  attr_reader input_cache_write_tokens: Integer?
@@ -268,6 +273,9 @@ module OpenAI
268
273
  # @param input_cache_write_12h_tokens
269
274
  # The aggregated number of input tokens written to the cache with a 12-hour
270
275
  # retention period.
276
+ # @param input_cache_write_30m_tokens
277
+ # The aggregated number of input tokens written to the cache with a 30-minute
278
+ # retention period. May be absent or null for older responses.
271
279
  # @param input_cache_write_tokens
272
280
  # The aggregated number of input tokens written to the cache with a 30-minute
273
281
  # retention period.
@@ -315,6 +323,7 @@ module OpenAI
315
323
  ?batch: bool?,
316
324
  ?input_audio_tokens: Integer,
317
325
  ?input_cache_write_12h_tokens: Integer,
326
+ ?input_cache_write_30m_tokens: Integer?,
318
327
  ?input_cache_write_tokens: Integer,
319
328
  ?input_cached_audio_tokens: Integer,
320
329
  ?input_cached_image_tokens: Integer,
@@ -343,6 +352,7 @@ module OpenAI
343
352
  ?batch: bool?,
344
353
  ?input_audio_tokens: Integer,
345
354
  ?:input_cache_write_12h_tokens => Integer,
355
+ ?:input_cache_write_30m_tokens => Integer?,
346
356
  ?input_cache_write_tokens: Integer,
347
357
  ?input_cached_audio_tokens: Integer,
348
358
  ?input_cached_image_tokens: Integer,
@@ -2756,6 +2756,7 @@ module OpenAI
2756
2756
  type compaction_trigger =
2757
2757
  {
2758
2758
  ?type: :compaction_trigger,
2759
+ ?id: String?,
2759
2760
  ?agent: OpenAI::Beta::BetaResponseInputItem::CompactionTrigger::Agent?
2760
2761
  }
2761
2762
 
@@ -2763,20 +2764,27 @@ module OpenAI
2763
2764
  # The type of the item. Always `compaction_trigger`.
2764
2765
  attr_accessor type: :compaction_trigger
2765
2766
 
2767
+ # The unique ID of this compaction trigger.
2768
+ attr_accessor id: String?
2769
+
2766
2770
  # The agent that produced this item.
2767
2771
  attr_accessor agent: OpenAI::Beta::BetaResponseInputItem::CompactionTrigger::Agent?
2768
2772
 
2773
+ # @param id
2774
+ # The unique ID of this compaction trigger.
2769
2775
  # @param agent
2770
2776
  # The agent that produced this item.
2771
2777
  # @param type
2772
2778
  # The type of the item. Always `compaction_trigger`.
2773
2779
  def initialize: (
2780
+ ?id: String?,
2774
2781
  ?agent: OpenAI::Beta::BetaResponseInputItem::CompactionTrigger::Agent?,
2775
2782
  ?type: :compaction_trigger
2776
2783
  ) -> void
2777
2784
 
2778
2785
  def to_hash: -> {
2779
2786
  ?type: :compaction_trigger,
2787
+ ?id: String?,
2780
2788
  ?agent: OpenAI::Beta::BetaResponseInputItem::CompactionTrigger::Agent?
2781
2789
  }
2782
2790
 
@@ -1907,17 +1907,22 @@ module OpenAI
1907
1907
  end
1908
1908
  end
1909
1909
 
1910
- type compaction_trigger = { ?type: :compaction_trigger }
1910
+ type compaction_trigger = { ?type: :compaction_trigger, ?id: String? }
1911
1911
 
1912
1912
  class CompactionTrigger < OpenAI::Internal::Type::BaseModel
1913
1913
  # The type of the item. Always `compaction_trigger`.
1914
1914
  attr_accessor type: :compaction_trigger
1915
1915
 
1916
+ # The unique ID of this compaction trigger.
1917
+ attr_accessor id: String?
1918
+
1919
+ # @param id
1920
+ # The unique ID of this compaction trigger.
1916
1921
  # @param type
1917
1922
  # The type of the item. Always `compaction_trigger`.
1918
- def initialize: (?type: :compaction_trigger) -> void
1923
+ def initialize: (?id: String?, ?type: :compaction_trigger) -> void
1919
1924
 
1920
- def to_hash: -> { ?type: :compaction_trigger }
1925
+ def to_hash: -> { ?type: :compaction_trigger, ?id: String? }
1921
1926
  end
1922
1927
 
1923
1928
  type item_reference =
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.106.0
4
+ version: 0.107.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAI
@@ -114,6 +114,7 @@ files:
114
114
  - lib/openai/helpers/local_audio/errors.rb
115
115
  - lib/openai/helpers/local_audio/process.rb
116
116
  - lib/openai/helpers/models/chat/parsed.rb
117
+ - lib/openai/helpers/models/embedding.rb
117
118
  - lib/openai/helpers/models/responses/parsed.rb
118
119
  - lib/openai/helpers/models/responses/response.rb
119
120
  - lib/openai/helpers/models/webhooks/webhook_endpoint_with_secret.rb
@@ -173,6 +174,7 @@ files:
173
174
  - lib/openai/helpers/websocket/protocol.rb
174
175
  - lib/openai/helpers/websocket/resource.rb
175
176
  - lib/openai/helpers/websocket/typed_connection.rb
177
+ - lib/openai/helpers/websocket/typed_resource.rb
176
178
  - lib/openai/http_client.rb
177
179
  - lib/openai/internal.rb
178
180
  - lib/openai/internal/conversation_cursor_page.rb