openai 0.73.0 → 0.74.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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/openai/models/beta/beta_response.rb +15 -6
  5. data/lib/openai/models/beta/beta_responses_client_event.rb +15 -6
  6. data/lib/openai/models/beta/response_create_params.rb +15 -6
  7. data/lib/openai/models/chat/chat_completion.rb +15 -6
  8. data/lib/openai/models/chat/chat_completion_chunk.rb +15 -6
  9. data/lib/openai/models/chat/completion_create_params.rb +15 -6
  10. data/lib/openai/models/responses/response.rb +15 -6
  11. data/lib/openai/models/responses/response_create_params.rb +15 -6
  12. data/lib/openai/models/responses/responses_client_event.rb +15 -6
  13. data/lib/openai/version.rb +1 -1
  14. data/rbi/openai/models/beta/beta_response.rbi +23 -9
  15. data/rbi/openai/models/beta/beta_responses_client_event.rbi +26 -9
  16. data/rbi/openai/models/beta/response_create_params.rbi +26 -9
  17. data/rbi/openai/models/chat/chat_completion.rbi +26 -9
  18. data/rbi/openai/models/chat/chat_completion_chunk.rbi +26 -9
  19. data/rbi/openai/models/chat/completion_create_params.rbi +26 -9
  20. data/rbi/openai/models/responses/response.rbi +23 -9
  21. data/rbi/openai/models/responses/response_create_params.rbi +26 -9
  22. data/rbi/openai/models/responses/responses_client_event.rbi +26 -9
  23. data/rbi/openai/resources/beta/responses.rbi +14 -6
  24. data/rbi/openai/resources/chat/completions.rbi +14 -6
  25. data/rbi/openai/resources/responses.rbi +14 -6
  26. data/sig/openai/models/beta/beta_response.rbs +3 -1
  27. data/sig/openai/models/beta/beta_responses_client_event.rbs +3 -1
  28. data/sig/openai/models/beta/response_create_params.rbs +3 -1
  29. data/sig/openai/models/chat/chat_completion.rbs +3 -1
  30. data/sig/openai/models/chat/chat_completion_chunk.rbs +3 -1
  31. data/sig/openai/models/chat/completion_create_params.rbs +3 -1
  32. data/sig/openai/models/responses/response.rbs +3 -1
  33. data/sig/openai/models/responses/response_create_params.rbs +3 -1
  34. data/sig/openai/models/responses/responses_client_event.rbs +3 -1
  35. metadata +2 -2
data/rbi/openai/models/chat/chat_completion.rbi CHANGED
@@ -52,9 +52,13 @@ module OpenAI
52
52
  # will use 'default'.
53
53
  # - If set to 'default', then the request will be processed with the standard
54
54
  # pricing and performance for the selected model.
55
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
56
- # '[priority](https://openai.com/api-priority-processing/)', then the request
57
- # will be processed with the corresponding service tier.
55
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
56
+ # then the request will be processed with the Flex Processing service tier.
57
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
58
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
59
+ # Responses or Chat Completions. The response will show `service_tier=priority`
60
+ # regardless of if you specify `service_tier=fast` or `priority` in your
61
+ # request.
58
62
  # - When not set, the default behavior is 'auto'.
59
63
  #
60
64
  # When the `service_tier` parameter is set, the response body will include the
@@ -122,9 +126,13 @@ module OpenAI
122
126
  # will use 'default'.
123
127
  # - If set to 'default', then the request will be processed with the standard
124
128
  # pricing and performance for the selected model.
125
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
126
- # '[priority](https://openai.com/api-priority-processing/)', then the request
127
- # will be processed with the corresponding service tier.
129
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
130
+ # then the request will be processed with the Flex Processing service tier.
131
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
132
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
133
+ # Responses or Chat Completions. The response will show `service_tier=priority`
134
+ # regardless of if you specify `service_tier=fast` or `priority` in your
135
+ # request.
128
136
  # - When not set, the default behavior is 'auto'.
129
137
  #
130
138
  # When the `service_tier` parameter is set, the response body will include the
@@ -985,9 +993,13 @@ module OpenAI
985
993
  # will use 'default'.
986
994
  # - If set to 'default', then the request will be processed with the standard
987
995
  # pricing and performance for the selected model.
988
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
989
- # '[priority](https://openai.com/api-priority-processing/)', then the request
990
- # will be processed with the corresponding service tier.
996
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
997
+ # then the request will be processed with the Flex Processing service tier.
998
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
999
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
1000
+ # Responses or Chat Completions. The response will show `service_tier=priority`
1001
+ # regardless of if you specify `service_tier=fast` or `priority` in your
1002
+ # request.
991
1003
  # - When not set, the default behavior is 'auto'.
992
1004
  #
993
1005
  # When the `service_tier` parameter is set, the response body will include the
@@ -1028,6 +1040,11 @@ module OpenAI
1028
1040
  :priority,
1029
1041
  OpenAI::Chat::ChatCompletion::ServiceTier::TaggedSymbol
1030
1042
  )
1043
+ FAST =
1044
+ T.let(
1045
+ :fast,
1046
+ OpenAI::Chat::ChatCompletion::ServiceTier::TaggedSymbol
1047
+ )
1031
1048
 
1032
1049
  sig do
1033
1050
  override.returns(
data/rbi/openai/models/chat/chat_completion_chunk.rbi CHANGED
@@ -56,9 +56,13 @@ module OpenAI
56
56
  # will use 'default'.
57
57
  # - If set to 'default', then the request will be processed with the standard
58
58
  # pricing and performance for the selected model.
59
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
60
- # '[priority](https://openai.com/api-priority-processing/)', then the request
61
- # will be processed with the corresponding service tier.
59
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
60
+ # then the request will be processed with the Flex Processing service tier.
61
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
62
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
63
+ # Responses or Chat Completions. The response will show `service_tier=priority`
64
+ # regardless of if you specify `service_tier=fast` or `priority` in your
65
+ # request.
62
66
  # - When not set, the default behavior is 'auto'.
63
67
  #
64
68
  # When the `service_tier` parameter is set, the response body will include the
@@ -139,9 +143,13 @@ module OpenAI
139
143
  # will use 'default'.
140
144
  # - If set to 'default', then the request will be processed with the standard
141
145
  # pricing and performance for the selected model.
142
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
143
- # '[priority](https://openai.com/api-priority-processing/)', then the request
144
- # will be processed with the corresponding service tier.
146
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
147
+ # then the request will be processed with the Flex Processing service tier.
148
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
149
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
150
+ # Responses or Chat Completions. The response will show `service_tier=priority`
151
+ # regardless of if you specify `service_tier=fast` or `priority` in your
152
+ # request.
145
153
  # - When not set, the default behavior is 'auto'.
146
154
  #
147
155
  # When the `service_tier` parameter is set, the response body will include the
@@ -1409,9 +1417,13 @@ module OpenAI
1409
1417
  # will use 'default'.
1410
1418
  # - If set to 'default', then the request will be processed with the standard
1411
1419
  # pricing and performance for the selected model.
1412
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
1413
- # '[priority](https://openai.com/api-priority-processing/)', then the request
1414
- # will be processed with the corresponding service tier.
1420
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
1421
+ # then the request will be processed with the Flex Processing service tier.
1422
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
1423
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
1424
+ # Responses or Chat Completions. The response will show `service_tier=priority`
1425
+ # regardless of if you specify `service_tier=fast` or `priority` in your
1426
+ # request.
1415
1427
  # - When not set, the default behavior is 'auto'.
1416
1428
  #
1417
1429
  # When the `service_tier` parameter is set, the response body will include the
@@ -1452,6 +1464,11 @@ module OpenAI
1452
1464
  :priority,
1453
1465
  OpenAI::Chat::ChatCompletionChunk::ServiceTier::TaggedSymbol
1454
1466
  )
1467
+ FAST =
1468
+ T.let(
1469
+ :fast,
1470
+ OpenAI::Chat::ChatCompletionChunk::ServiceTier::TaggedSymbol
1471
+ )
1455
1472
 
1456
1473
  sig do
1457
1474
  override.returns(
data/rbi/openai/models/chat/completion_create_params.rbi CHANGED
@@ -358,9 +358,13 @@ module OpenAI
358
358
  # will use 'default'.
359
359
  # - If set to 'default', then the request will be processed with the standard
360
360
  # pricing and performance for the selected model.
361
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
362
- # '[priority](https://openai.com/api-priority-processing/)', then the request
363
- # will be processed with the corresponding service tier.
361
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
362
+ # then the request will be processed with the Flex Processing service tier.
363
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
364
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
365
+ # Responses or Chat Completions. The response will show `service_tier=priority`
366
+ # regardless of if you specify `service_tier=fast` or `priority` in your
367
+ # request.
364
368
  # - When not set, the default behavior is 'auto'.
365
369
  #
366
370
  # When the `service_tier` parameter is set, the response body will include the
@@ -804,9 +808,13 @@ module OpenAI
804
808
  # will use 'default'.
805
809
  # - If set to 'default', then the request will be processed with the standard
806
810
  # pricing and performance for the selected model.
807
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
808
- # '[priority](https://openai.com/api-priority-processing/)', then the request
809
- # will be processed with the corresponding service tier.
811
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
812
+ # then the request will be processed with the Flex Processing service tier.
813
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
814
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
815
+ # Responses or Chat Completions. The response will show `service_tier=priority`
816
+ # regardless of if you specify `service_tier=fast` or `priority` in your
817
+ # request.
810
818
  # - When not set, the default behavior is 'auto'.
811
819
  #
812
820
  # When the `service_tier` parameter is set, the response body will include the
@@ -1734,9 +1742,13 @@ module OpenAI
1734
1742
  # will use 'default'.
1735
1743
  # - If set to 'default', then the request will be processed with the standard
1736
1744
  # pricing and performance for the selected model.
1737
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
1738
- # '[priority](https://openai.com/api-priority-processing/)', then the request
1739
- # will be processed with the corresponding service tier.
1745
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
1746
+ # then the request will be processed with the Flex Processing service tier.
1747
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
1748
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
1749
+ # Responses or Chat Completions. The response will show `service_tier=priority`
1750
+ # regardless of if you specify `service_tier=fast` or `priority` in your
1751
+ # request.
1740
1752
  # - When not set, the default behavior is 'auto'.
1741
1753
  #
1742
1754
  # When the `service_tier` parameter is set, the response body will include the
@@ -1777,6 +1789,11 @@ module OpenAI
1777
1789
  :priority,
1778
1790
  OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
1779
1791
  )
1792
+ FAST =
1793
+ T.let(
1794
+ :fast,
1795
+ OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
1796
+ )
1780
1797
 
1781
1798
  sig do
1782
1799
  override.returns(
data/rbi/openai/models/responses/response.rbi CHANGED
@@ -275,9 +275,13 @@ module OpenAI
275
275
  # will use 'default'.
276
276
  # - If set to 'default', then the request will be processed with the standard
277
277
  # pricing and performance for the selected model.
278
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
279
- # '[priority](https://openai.com/api-priority-processing/)', then the request
280
- # will be processed with the corresponding service tier.
278
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
279
+ # then the request will be processed with the Flex Processing service tier.
280
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
281
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
282
+ # Responses or Chat Completions. The response will show `service_tier=priority`
283
+ # regardless of if you specify `service_tier=fast` or `priority` in your
284
+ # request.
281
285
  # - When not set, the default behavior is 'auto'.
282
286
  #
283
287
  # When the `service_tier` parameter is set, the response body will include the
@@ -613,9 +617,13 @@ module OpenAI
613
617
  # will use 'default'.
614
618
  # - If set to 'default', then the request will be processed with the standard
615
619
  # pricing and performance for the selected model.
616
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
617
- # '[priority](https://openai.com/api-priority-processing/)', then the request
618
- # will be processed with the corresponding service tier.
620
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
621
+ # then the request will be processed with the Flex Processing service tier.
622
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
623
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
624
+ # Responses or Chat Completions. The response will show `service_tier=priority`
625
+ # regardless of if you specify `service_tier=fast` or `priority` in your
626
+ # request.
619
627
  # - When not set, the default behavior is 'auto'.
620
628
  #
621
629
  # When the `service_tier` parameter is set, the response body will include the
@@ -1559,9 +1567,13 @@ module OpenAI
1559
1567
  # will use 'default'.
1560
1568
  # - If set to 'default', then the request will be processed with the standard
1561
1569
  # pricing and performance for the selected model.
1562
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
1563
- # '[priority](https://openai.com/api-priority-processing/)', then the request
1564
- # will be processed with the corresponding service tier.
1570
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
1571
+ # then the request will be processed with the Flex Processing service tier.
1572
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
1573
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
1574
+ # Responses or Chat Completions. The response will show `service_tier=priority`
1575
+ # regardless of if you specify `service_tier=fast` or `priority` in your
1576
+ # request.
1565
1577
  # - When not set, the default behavior is 'auto'.
1566
1578
  #
1567
1579
  # When the `service_tier` parameter is set, the response body will include the
@@ -1596,6 +1608,8 @@ module OpenAI
1596
1608
  :priority,
1597
1609
  OpenAI::Responses::Response::ServiceTier::TaggedSymbol
1598
1610
  )
1611
+ FAST =
1612
+ T.let(:fast, OpenAI::Responses::Response::ServiceTier::TaggedSymbol)
1599
1613
 
1600
1614
  sig do
1601
1615
  override.returns(
data/rbi/openai/models/responses/response_create_params.rbi CHANGED
@@ -278,9 +278,13 @@ module OpenAI
278
278
  # will use 'default'.
279
279
  # - If set to 'default', then the request will be processed with the standard
280
280
  # pricing and performance for the selected model.
281
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
282
- # '[priority](https://openai.com/api-priority-processing/)', then the request
283
- # will be processed with the corresponding service tier.
281
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
282
+ # then the request will be processed with the Flex Processing service tier.
283
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
284
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
285
+ # Responses or Chat Completions. The response will show `service_tier=priority`
286
+ # regardless of if you specify `service_tier=fast` or `priority` in your
287
+ # request.
284
288
  # - When not set, the default behavior is 'auto'.
285
289
  #
286
290
  # When the `service_tier` parameter is set, the response body will include the
@@ -731,9 +735,13 @@ module OpenAI
731
735
  # will use 'default'.
732
736
  # - If set to 'default', then the request will be processed with the standard
733
737
  # pricing and performance for the selected model.
734
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
735
- # '[priority](https://openai.com/api-priority-processing/)', then the request
736
- # will be processed with the corresponding service tier.
738
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
739
+ # then the request will be processed with the Flex Processing service tier.
740
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
741
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
742
+ # Responses or Chat Completions. The response will show `service_tier=priority`
743
+ # regardless of if you specify `service_tier=fast` or `priority` in your
744
+ # request.
737
745
  # - When not set, the default behavior is 'auto'.
738
746
  #
739
747
  # When the `service_tier` parameter is set, the response body will include the
@@ -1528,9 +1536,13 @@ module OpenAI
1528
1536
  # will use 'default'.
1529
1537
  # - If set to 'default', then the request will be processed with the standard
1530
1538
  # pricing and performance for the selected model.
1531
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
1532
- # '[priority](https://openai.com/api-priority-processing/)', then the request
1533
- # will be processed with the corresponding service tier.
1539
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
1540
+ # then the request will be processed with the Flex Processing service tier.
1541
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
1542
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
1543
+ # Responses or Chat Completions. The response will show `service_tier=priority`
1544
+ # regardless of if you specify `service_tier=fast` or `priority` in your
1545
+ # request.
1534
1546
  # - When not set, the default behavior is 'auto'.
1535
1547
  #
1536
1548
  # When the `service_tier` parameter is set, the response body will include the
@@ -1574,6 +1586,11 @@ module OpenAI
1574
1586
  :priority,
1575
1587
  OpenAI::Responses::ResponseCreateParams::ServiceTier::TaggedSymbol
1576
1588
  )
1589
+ FAST =
1590
+ T.let(
1591
+ :fast,
1592
+ OpenAI::Responses::ResponseCreateParams::ServiceTier::TaggedSymbol
1593
+ )
1577
1594
 
1578
1595
  sig do
1579
1596
  override.returns(
data/rbi/openai/models/responses/responses_client_event.rbi CHANGED
@@ -279,9 +279,13 @@ module OpenAI
279
279
  # will use 'default'.
280
280
  # - If set to 'default', then the request will be processed with the standard
281
281
  # pricing and performance for the selected model.
282
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
283
- # '[priority](https://openai.com/api-priority-processing/)', then the request
284
- # will be processed with the corresponding service tier.
282
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
283
+ # then the request will be processed with the Flex Processing service tier.
284
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
285
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
286
+ # Responses or Chat Completions. The response will show `service_tier=priority`
287
+ # regardless of if you specify `service_tier=fast` or `priority` in your
288
+ # request.
285
289
  # - When not set, the default behavior is 'auto'.
286
290
  #
287
291
  # When the `service_tier` parameter is set, the response body will include the
@@ -734,9 +738,13 @@ module OpenAI
734
738
  # will use 'default'.
735
739
  # - If set to 'default', then the request will be processed with the standard
736
740
  # pricing and performance for the selected model.
737
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
738
- # '[priority](https://openai.com/api-priority-processing/)', then the request
739
- # will be processed with the corresponding service tier.
741
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
742
+ # then the request will be processed with the Flex Processing service tier.
743
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
744
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
745
+ # Responses or Chat Completions. The response will show `service_tier=priority`
746
+ # regardless of if you specify `service_tier=fast` or `priority` in your
747
+ # request.
740
748
  # - When not set, the default behavior is 'auto'.
741
749
  #
742
750
  # When the `service_tier` parameter is set, the response body will include the
@@ -1540,9 +1548,13 @@ module OpenAI
1540
1548
  # will use 'default'.
1541
1549
  # - If set to 'default', then the request will be processed with the standard
1542
1550
  # pricing and performance for the selected model.
1543
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
1544
- # '[priority](https://openai.com/api-priority-processing/)', then the request
1545
- # will be processed with the corresponding service tier.
1551
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
1552
+ # then the request will be processed with the Flex Processing service tier.
1553
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
1554
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
1555
+ # Responses or Chat Completions. The response will show `service_tier=priority`
1556
+ # regardless of if you specify `service_tier=fast` or `priority` in your
1557
+ # request.
1546
1558
  # - When not set, the default behavior is 'auto'.
1547
1559
  #
1548
1560
  # When the `service_tier` parameter is set, the response body will include the
@@ -1586,6 +1598,11 @@ module OpenAI
1586
1598
  :priority,
1587
1599
  OpenAI::Responses::ResponsesClientEvent::ServiceTier::TaggedSymbol
1588
1600
  )
1601
+ FAST =
1602
+ T.let(
1603
+ :fast,
1604
+ OpenAI::Responses::ResponsesClientEvent::ServiceTier::TaggedSymbol
1605
+ )
1589
1606
 
1590
1607
  sig do
1591
1608
  override.returns(
data/rbi/openai/resources/beta/responses.rbi CHANGED
@@ -262,9 +262,13 @@ module OpenAI
262
262
  # will use 'default'.
263
263
  # - If set to 'default', then the request will be processed with the standard
264
264
  # pricing and performance for the selected model.
265
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
266
- # '[priority](https://openai.com/api-priority-processing/)', then the request
267
- # will be processed with the corresponding service tier.
265
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
266
+ # then the request will be processed with the Flex Processing service tier.
267
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
268
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
269
+ # Responses or Chat Completions. The response will show `service_tier=priority`
270
+ # regardless of if you specify `service_tier=fast` or `priority` in your
271
+ # request.
268
272
  # - When not set, the default behavior is 'auto'.
269
273
  #
270
274
  # When the `service_tier` parameter is set, the response body will include the
@@ -605,9 +609,13 @@ module OpenAI
605
609
  # will use 'default'.
606
610
  # - If set to 'default', then the request will be processed with the standard
607
611
  # pricing and performance for the selected model.
608
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
609
- # '[priority](https://openai.com/api-priority-processing/)', then the request
610
- # will be processed with the corresponding service tier.
612
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
613
+ # then the request will be processed with the Flex Processing service tier.
614
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
615
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
616
+ # Responses or Chat Completions. The response will show `service_tier=priority`
617
+ # regardless of if you specify `service_tier=fast` or `priority` in your
618
+ # request.
611
619
  # - When not set, the default behavior is 'auto'.
612
620
  #
613
621
  # When the `service_tier` parameter is set, the response body will include the
data/rbi/openai/resources/chat/completions.rbi CHANGED
@@ -302,9 +302,13 @@ module OpenAI
302
302
  # will use 'default'.
303
303
  # - If set to 'default', then the request will be processed with the standard
304
304
  # pricing and performance for the selected model.
305
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
306
- # '[priority](https://openai.com/api-priority-processing/)', then the request
307
- # will be processed with the corresponding service tier.
305
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
306
+ # then the request will be processed with the Flex Processing service tier.
307
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
308
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
309
+ # Responses or Chat Completions. The response will show `service_tier=priority`
310
+ # regardless of if you specify `service_tier=fast` or `priority` in your
311
+ # request.
308
312
  # - When not set, the default behavior is 'auto'.
309
313
  #
310
314
  # When the `service_tier` parameter is set, the response body will include the
@@ -666,9 +670,13 @@ module OpenAI
666
670
  # will use 'default'.
667
671
  # - If set to 'default', then the request will be processed with the standard
668
672
  # pricing and performance for the selected model.
669
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
670
- # '[priority](https://openai.com/api-priority-processing/)', then the request
671
- # will be processed with the corresponding service tier.
673
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
674
+ # then the request will be processed with the Flex Processing service tier.
675
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
676
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
677
+ # Responses or Chat Completions. The response will show `service_tier=priority`
678
+ # regardless of if you specify `service_tier=fast` or `priority` in your
679
+ # request.
672
680
  # - When not set, the default behavior is 'auto'.
673
681
  #
674
682
  # When the `service_tier` parameter is set, the response body will include the
data/rbi/openai/resources/responses.rbi CHANGED
@@ -259,9 +259,13 @@ module OpenAI
259
259
  # will use 'default'.
260
260
  # - If set to 'default', then the request will be processed with the standard
261
261
  # pricing and performance for the selected model.
262
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
263
- # '[priority](https://openai.com/api-priority-processing/)', then the request
264
- # will be processed with the corresponding service tier.
262
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
263
+ # then the request will be processed with the Flex Processing service tier.
264
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
265
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
266
+ # Responses or Chat Completions. The response will show `service_tier=priority`
267
+ # regardless of if you specify `service_tier=fast` or `priority` in your
268
+ # request.
265
269
  # - When not set, the default behavior is 'auto'.
266
270
  #
267
271
  # When the `service_tier` parameter is set, the response body will include the
@@ -595,9 +599,13 @@ module OpenAI
595
599
  # will use 'default'.
596
600
  # - If set to 'default', then the request will be processed with the standard
597
601
  # pricing and performance for the selected model.
598
- # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
599
- # '[priority](https://openai.com/api-priority-processing/)', then the request
600
- # will be processed with the corresponding service tier.
602
+ # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
603
+ # then the request will be processed with the Flex Processing service tier.
604
+ # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
605
+ # include the `service_tier=fast` or `service_tier=priority` parameter for
606
+ # Responses or Chat Completions. The response will show `service_tier=priority`
607
+ # regardless of if you specify `service_tier=fast` or `priority` in your
608
+ # request.
601
609
  # - When not set, the default behavior is 'auto'.
602
610
  #
603
611
  # When the `service_tier` parameter is set, the response body will include the
data/sig/openai/models/beta/beta_response.rbs CHANGED
@@ -826,7 +826,8 @@ module OpenAI
826
826
  end
827
827
  end
828
828
 
829
- type service_tier = :auto | :default | :flex | :scale | :priority
829
+ type service_tier =
830
+ :auto | :default | :flex | :scale | :priority | :fast
830
831
 
831
832
  module ServiceTier
832
833
  extend OpenAI::Internal::Type::Enum
@@ -836,6 +837,7 @@ module OpenAI
836
837
  FLEX: :flex
837
838
  SCALE: :scale
838
839
  PRIORITY: :priority
840
+ FAST: :fast
839
841
 
840
842
  def self?.values: -> ::Array[OpenAI::Models::Beta::BetaResponse::service_tier]
841
843
  end
data/sig/openai/models/beta/beta_responses_client_event.rbs CHANGED
@@ -727,7 +727,8 @@ module OpenAI
727
727
  end
728
728
  end
729
729
 
730
- type service_tier = :auto | :default | :flex | :scale | :priority
730
+ type service_tier =
731
+ :auto | :default | :flex | :scale | :priority | :fast
731
732
 
732
733
  module ServiceTier
733
734
  extend OpenAI::Internal::Type::Enum
@@ -737,6 +738,7 @@ module OpenAI
737
738
  FLEX: :flex
738
739
  SCALE: :scale
739
740
  PRIORITY: :priority
741
+ FAST: :fast
740
742
 
741
743
  def self?.values: -> ::Array[OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::service_tier]
742
744
  end
data/sig/openai/models/beta/response_create_params.rbs CHANGED
@@ -720,7 +720,8 @@ module OpenAI
720
720
  end
721
721
  end
722
722
 
723
- type service_tier = :auto | :default | :flex | :scale | :priority
723
+ type service_tier =
724
+ :auto | :default | :flex | :scale | :priority | :fast
724
725
 
725
726
  module ServiceTier
726
727
  extend OpenAI::Internal::Type::Enum
@@ -730,6 +731,7 @@ module OpenAI
730
731
  FLEX: :flex
731
732
  SCALE: :scale
732
733
  PRIORITY: :priority
734
+ FAST: :fast
733
735
 
734
736
  def self?.values: -> ::Array[OpenAI::Models::Beta::ResponseCreateParams::service_tier]
735
737
  end
data/sig/openai/models/chat/chat_completion.rbs CHANGED
@@ -370,7 +370,8 @@ module OpenAI
370
370
  end
371
371
  end
372
372
 
373
- type service_tier = :auto | :default | :flex | :scale | :priority
373
+ type service_tier =
374
+ :auto | :default | :flex | :scale | :priority | :fast
374
375
 
375
376
  module ServiceTier
376
377
  extend OpenAI::Internal::Type::Enum
@@ -380,6 +381,7 @@ module OpenAI
380
381
  FLEX: :flex
381
382
  SCALE: :scale
382
383
  PRIORITY: :priority
384
+ FAST: :fast
383
385
 
384
386
  def self?.values: -> ::Array[OpenAI::Models::Chat::ChatCompletion::service_tier]
385
387
  end
data/sig/openai/models/chat/chat_completion_chunk.rbs CHANGED
@@ -515,7 +515,8 @@ module OpenAI
515
515
  end
516
516
  end
517
517
 
518
- type service_tier = :auto | :default | :flex | :scale | :priority
518
+ type service_tier =
519
+ :auto | :default | :flex | :scale | :priority | :fast
519
520
 
520
521
  module ServiceTier
521
522
  extend OpenAI::Internal::Type::Enum
@@ -525,6 +526,7 @@ module OpenAI
525
526
  FLEX: :flex
526
527
  SCALE: :scale
527
528
  PRIORITY: :priority
529
+ FAST: :fast
528
530
 
529
531
  def self?.values: -> ::Array[OpenAI::Models::Chat::ChatCompletionChunk::service_tier]
530
532
  end
data/sig/openai/models/chat/completion_create_params.rbs CHANGED
@@ -476,7 +476,8 @@ module OpenAI
476
476
  def self?.variants: -> ::Array[OpenAI::Models::Chat::CompletionCreateParams::response_format]
477
477
  end
478
478
 
479
- type service_tier = :auto | :default | :flex | :scale | :priority
479
+ type service_tier =
480
+ :auto | :default | :flex | :scale | :priority | :fast
480
481
 
481
482
  module ServiceTier
482
483
  extend OpenAI::Internal::Type::Enum
@@ -486,6 +487,7 @@ module OpenAI
486
487
  FLEX: :flex
487
488
  SCALE: :scale
488
489
  PRIORITY: :priority
490
+ FAST: :fast
489
491
 
490
492
  def self?.values: -> ::Array[OpenAI::Models::Chat::CompletionCreateParams::service_tier]
491
493
  end
data/sig/openai/models/responses/response.rbs CHANGED
@@ -519,7 +519,8 @@ module OpenAI
519
519
  def self?.values: -> ::Array[OpenAI::Models::Responses::Response::prompt_cache_retention]
520
520
  end
521
521
 
522
- type service_tier = :auto | :default | :flex | :scale | :priority
522
+ type service_tier =
523
+ :auto | :default | :flex | :scale | :priority | :fast
523
524
 
524
525
  module ServiceTier
525
526
  extend OpenAI::Internal::Type::Enum
@@ -529,6 +530,7 @@ module OpenAI
529
530
  FLEX: :flex
530
531
  SCALE: :scale
531
532
  PRIORITY: :priority
533
+ FAST: :fast
532
534
 
533
535
  def self?.values: -> ::Array[OpenAI::Models::Responses::Response::service_tier]
534
536
  end
data/sig/openai/models/responses/response_create_params.rbs CHANGED
@@ -385,7 +385,8 @@ module OpenAI
385
385
  def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::prompt_cache_retention]
386
386
  end
387
387
 
388
- type service_tier = :auto | :default | :flex | :scale | :priority
388
+ type service_tier =
389
+ :auto | :default | :flex | :scale | :priority | :fast
389
390
 
390
391
  module ServiceTier
391
392
  extend OpenAI::Internal::Type::Enum
@@ -395,6 +396,7 @@ module OpenAI
395
396
  FLEX: :flex
396
397
  SCALE: :scale
397
398
  PRIORITY: :priority
399
+ FAST: :fast
398
400
 
399
401
  def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::service_tier]
400
402
  end