openai 0.29.0 → 0.30.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 (178) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/openai/client.rb +4 -0
  5. data/lib/openai/internal/conversation_cursor_page.rb +2 -2
  6. data/lib/openai/models/all_models.rb +2 -0
  7. data/lib/openai/models/beta/chatkit/chat_session.rb +94 -0
  8. data/lib/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rb +22 -0
  9. data/lib/openai/models/beta/chatkit/chat_session_chatkit_configuration.rb +38 -0
  10. data/lib/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rb +125 -0
  11. data/lib/openai/models/beta/chatkit/chat_session_expires_after_param.rb +30 -0
  12. data/lib/openai/models/beta/chatkit/chat_session_file_upload.rb +38 -0
  13. data/lib/openai/models/beta/chatkit/chat_session_history.rb +34 -0
  14. data/lib/openai/models/beta/chatkit/chat_session_rate_limits.rb +22 -0
  15. data/lib/openai/models/beta/chatkit/chat_session_rate_limits_param.rb +22 -0
  16. data/lib/openai/models/beta/chatkit/chat_session_status.rb +20 -0
  17. data/lib/openai/models/beta/chatkit/chat_session_workflow_param.rb +80 -0
  18. data/lib/openai/models/beta/chatkit/chatkit_attachment.rb +69 -0
  19. data/lib/openai/models/beta/chatkit/chatkit_response_output_text.rb +143 -0
  20. data/lib/openai/models/beta/chatkit/chatkit_thread.rb +145 -0
  21. data/lib/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rb +65 -0
  22. data/lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb +374 -0
  23. data/lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb +183 -0
  24. data/lib/openai/models/beta/chatkit/chatkit_widget_item.rb +64 -0
  25. data/lib/openai/models/beta/chatkit/session_cancel_params.rb +18 -0
  26. data/lib/openai/models/beta/chatkit/session_create_params.rb +63 -0
  27. data/lib/openai/models/beta/chatkit/thread_delete_params.rb +18 -0
  28. data/lib/openai/models/beta/chatkit/thread_delete_response.rb +39 -0
  29. data/lib/openai/models/beta/chatkit/thread_list_items_params.rb +66 -0
  30. data/lib/openai/models/beta/chatkit/thread_list_params.rb +75 -0
  31. data/lib/openai/models/beta/chatkit/thread_retrieve_params.rb +18 -0
  32. data/lib/openai/models/beta/chatkit_upload_file_params.rb +28 -0
  33. data/lib/openai/models/beta/chatkit_upload_file_response.rb +25 -0
  34. data/lib/openai/models/beta/chatkit_workflow.rb +78 -0
  35. data/lib/openai/models/beta/file_part.rb +56 -0
  36. data/lib/openai/models/beta/image_part.rb +64 -0
  37. data/lib/openai/models/image_edit_params.rb +4 -2
  38. data/lib/openai/models/image_model.rb +1 -0
  39. data/lib/openai/models/realtime/realtime_session.rb +4 -0
  40. data/lib/openai/models/realtime/realtime_session_create_request.rb +12 -0
  41. data/lib/openai/models/realtime/realtime_session_create_response.rb +12 -0
  42. data/lib/openai/models/responses/tool.rb +5 -2
  43. data/lib/openai/models/responses_model.rb +2 -0
  44. data/lib/openai/models/video.rb +122 -0
  45. data/lib/openai/models/video_create_error.rb +21 -0
  46. data/lib/openai/models/video_create_params.rb +54 -0
  47. data/lib/openai/models/video_delete_params.rb +14 -0
  48. data/lib/openai/models/video_delete_response.rb +35 -0
  49. data/lib/openai/models/video_download_content_params.rb +34 -0
  50. data/lib/openai/models/video_list_params.rb +54 -0
  51. data/lib/openai/models/video_model.rb +15 -0
  52. data/lib/openai/models/video_remix_params.rb +22 -0
  53. data/lib/openai/models/video_retrieve_params.rb +14 -0
  54. data/lib/openai/models/video_seconds.rb +16 -0
  55. data/lib/openai/models/video_size.rb +17 -0
  56. data/lib/openai/models.rb +22 -0
  57. data/lib/openai/resources/beta/chatkit/sessions.rb +71 -0
  58. data/lib/openai/resources/beta/chatkit/threads.rb +126 -0
  59. data/lib/openai/resources/beta/chatkit.rb +50 -0
  60. data/lib/openai/resources/beta.rb +4 -0
  61. data/lib/openai/resources/videos.rb +165 -0
  62. data/lib/openai/version.rb +1 -1
  63. data/lib/openai.rb +46 -0
  64. data/rbi/openai/client.rbi +3 -0
  65. data/rbi/openai/models/all_models.rbi +10 -0
  66. data/rbi/openai/models/beta/chatkit/chat_session.rbi +141 -0
  67. data/rbi/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rbi +35 -0
  68. data/rbi/openai/models/beta/chatkit/chat_session_chatkit_configuration.rbi +87 -0
  69. data/rbi/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rbi +256 -0
  70. data/rbi/openai/models/beta/chatkit/chat_session_expires_after_param.rbi +43 -0
  71. data/rbi/openai/models/beta/chatkit/chat_session_file_upload.rbi +61 -0
  72. data/rbi/openai/models/beta/chatkit/chat_session_history.rbi +52 -0
  73. data/rbi/openai/models/beta/chatkit/chat_session_rate_limits.rbi +37 -0
  74. data/rbi/openai/models/beta/chatkit/chat_session_rate_limits_param.rbi +40 -0
  75. data/rbi/openai/models/beta/chatkit/chat_session_status.rbi +43 -0
  76. data/rbi/openai/models/beta/chatkit/chat_session_workflow_param.rbi +166 -0
  77. data/rbi/openai/models/beta/chatkit/chatkit_attachment.rbi +116 -0
  78. data/rbi/openai/models/beta/chatkit/chatkit_response_output_text.rbi +287 -0
  79. data/rbi/openai/models/beta/chatkit/chatkit_thread.rbi +220 -0
  80. data/rbi/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rbi +94 -0
  81. data/rbi/openai/models/beta/chatkit/chatkit_thread_item_list.rbi +590 -0
  82. data/rbi/openai/models/beta/chatkit/chatkit_thread_user_message_item.rbi +324 -0
  83. data/rbi/openai/models/beta/chatkit/chatkit_widget_item.rbi +87 -0
  84. data/rbi/openai/models/beta/chatkit/session_cancel_params.rbi +34 -0
  85. data/rbi/openai/models/beta/chatkit/session_create_params.rbi +136 -0
  86. data/rbi/openai/models/beta/chatkit/thread_delete_params.rbi +34 -0
  87. data/rbi/openai/models/beta/chatkit/thread_delete_response.rbi +55 -0
  88. data/rbi/openai/models/beta/chatkit/thread_list_items_params.rbi +138 -0
  89. data/rbi/openai/models/beta/chatkit/thread_list_params.rbi +145 -0
  90. data/rbi/openai/models/beta/chatkit/thread_retrieve_params.rbi +34 -0
  91. data/rbi/openai/models/beta/chatkit_upload_file_params.rbi +50 -0
  92. data/rbi/openai/models/beta/chatkit_upload_file_response.rbi +25 -0
  93. data/rbi/openai/models/beta/chatkit_workflow.rbi +134 -0
  94. data/rbi/openai/models/beta/file_part.rbi +74 -0
  95. data/rbi/openai/models/beta/image_part.rbi +82 -0
  96. data/rbi/openai/models/image_edit_params.rbi +6 -3
  97. data/rbi/openai/models/image_model.rbi +2 -0
  98. data/rbi/openai/models/realtime/realtime_session.rbi +20 -0
  99. data/rbi/openai/models/realtime/realtime_session_create_request.rbi +20 -0
  100. data/rbi/openai/models/realtime/realtime_session_create_response.rbi +20 -0
  101. data/rbi/openai/models/responses/tool.rbi +11 -3
  102. data/rbi/openai/models/responses_model.rbi +10 -0
  103. data/rbi/openai/models/video.rbi +143 -0
  104. data/rbi/openai/models/video_create_error.rbi +26 -0
  105. data/rbi/openai/models/video_create_params.rbi +87 -0
  106. data/rbi/openai/models/video_delete_params.rbi +27 -0
  107. data/rbi/openai/models/video_delete_response.rbi +46 -0
  108. data/rbi/openai/models/video_download_content_params.rbi +89 -0
  109. data/rbi/openai/models/video_list_params.rbi +91 -0
  110. data/rbi/openai/models/video_model.rbi +19 -0
  111. data/rbi/openai/models/video_remix_params.rbi +40 -0
  112. data/rbi/openai/models/video_retrieve_params.rbi +27 -0
  113. data/rbi/openai/models/video_seconds.rbi +20 -0
  114. data/rbi/openai/models/video_size.rbi +23 -0
  115. data/rbi/openai/models.rbi +22 -0
  116. data/rbi/openai/resources/beta/chatkit/sessions.rbi +61 -0
  117. data/rbi/openai/resources/beta/chatkit/threads.rbi +110 -0
  118. data/rbi/openai/resources/beta/chatkit.rbi +35 -0
  119. data/rbi/openai/resources/beta.rbi +3 -0
  120. data/rbi/openai/resources/images.rbi +4 -2
  121. data/rbi/openai/resources/videos.rbi +121 -0
  122. data/sig/openai/client.rbs +2 -0
  123. data/sig/openai/models/all_models.rbs +4 -0
  124. data/sig/openai/models/beta/chatkit/chat_session.rbs +69 -0
  125. data/sig/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rbs +17 -0
  126. data/sig/openai/models/beta/chatkit/chat_session_chatkit_configuration.rbs +34 -0
  127. data/sig/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rbs +103 -0
  128. data/sig/openai/models/beta/chatkit/chat_session_expires_after_param.rbs +20 -0
  129. data/sig/openai/models/beta/chatkit/chat_session_file_upload.rbs +30 -0
  130. data/sig/openai/models/beta/chatkit/chat_session_history.rbs +19 -0
  131. data/sig/openai/models/beta/chatkit/chat_session_rate_limits.rbs +18 -0
  132. data/sig/openai/models/beta/chatkit/chat_session_rate_limits_param.rbs +20 -0
  133. data/sig/openai/models/beta/chatkit/chat_session_status.rbs +19 -0
  134. data/sig/openai/models/beta/chatkit/chat_session_workflow_param.rbs +69 -0
  135. data/sig/openai/models/beta/chatkit/chatkit_attachment.rbs +57 -0
  136. data/sig/openai/models/beta/chatkit/chatkit_response_output_text.rbs +114 -0
  137. data/sig/openai/models/beta/chatkit/chatkit_thread.rbs +96 -0
  138. data/sig/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rbs +51 -0
  139. data/sig/openai/models/beta/chatkit/chatkit_thread_item_list.rbs +276 -0
  140. data/sig/openai/models/beta/chatkit/chatkit_thread_user_message_item.rbs +127 -0
  141. data/sig/openai/models/beta/chatkit/chatkit_widget_item.rbs +51 -0
  142. data/sig/openai/models/beta/chatkit/session_cancel_params.rbs +19 -0
  143. data/sig/openai/models/beta/chatkit/session_create_params.rbs +62 -0
  144. data/sig/openai/models/beta/chatkit/thread_delete_params.rbs +19 -0
  145. data/sig/openai/models/beta/chatkit/thread_delete_response.rbs +30 -0
  146. data/sig/openai/models/beta/chatkit/thread_list_items_params.rbs +66 -0
  147. data/sig/openai/models/beta/chatkit/thread_list_params.rbs +73 -0
  148. data/sig/openai/models/beta/chatkit/thread_retrieve_params.rbs +19 -0
  149. data/sig/openai/models/beta/chatkit_upload_file_params.rbs +26 -0
  150. data/sig/openai/models/beta/chatkit_upload_file_response.rbs +14 -0
  151. data/sig/openai/models/beta/chatkit_workflow.rbs +55 -0
  152. data/sig/openai/models/beta/file_part.rbs +42 -0
  153. data/sig/openai/models/beta/image_part.rbs +47 -0
  154. data/sig/openai/models/image_model.rbs +3 -1
  155. data/sig/openai/models/realtime/realtime_session.rbs +8 -0
  156. data/sig/openai/models/realtime/realtime_session_create_request.rbs +8 -0
  157. data/sig/openai/models/realtime/realtime_session_create_response.rbs +8 -0
  158. data/sig/openai/models/responses/tool.rbs +2 -1
  159. data/sig/openai/models/responses_model.rbs +4 -0
  160. data/sig/openai/models/video.rbs +88 -0
  161. data/sig/openai/models/video_create_error.rbs +15 -0
  162. data/sig/openai/models/video_create_params.rbs +58 -0
  163. data/sig/openai/models/video_delete_params.rbs +14 -0
  164. data/sig/openai/models/video_delete_response.rbs +22 -0
  165. data/sig/openai/models/video_download_content_params.rbs +40 -0
  166. data/sig/openai/models/video_list_params.rbs +55 -0
  167. data/sig/openai/models/video_model.rbs +14 -0
  168. data/sig/openai/models/video_remix_params.rbs +23 -0
  169. data/sig/openai/models/video_retrieve_params.rbs +15 -0
  170. data/sig/openai/models/video_seconds.rbs +15 -0
  171. data/sig/openai/models/video_size.rbs +16 -0
  172. data/sig/openai/models.rbs +22 -0
  173. data/sig/openai/resources/beta/chatkit/sessions.rbs +25 -0
  174. data/sig/openai/resources/beta/chatkit/threads.rbs +39 -0
  175. data/sig/openai/resources/beta/chatkit.rbs +18 -0
  176. data/sig/openai/resources/beta.rbs +2 -0
  177. data/sig/openai/resources/videos.rbs +45 -0
  178. metadata +140 -2
@@ -0,0 +1,63 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ module ChatKit
7
+ # @see OpenAI::Resources::Beta::ChatKit::Sessions#create
8
+ class SessionCreateParams < OpenAI::Internal::Type::BaseModel
9
+ extend OpenAI::Internal::Type::RequestParameters::Converter
10
+ include OpenAI::Internal::Type::RequestParameters
11
+
12
+ # @!attribute user
13
+ # A free-form string that identifies your end user; ensures this Session can
14
+ # access other objects that have the same `user` scope.
15
+ #
16
+ # @return [String]
17
+ required :user, String
18
+
19
+ # @!attribute workflow
20
+ # Workflow that powers the session.
21
+ #
22
+ # @return [OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam]
23
+ required :workflow, -> { OpenAI::Beta::ChatKit::ChatSessionWorkflowParam }
24
+
25
+ # @!attribute chatkit_configuration
26
+ # Optional overrides for ChatKit runtime configuration features
27
+ #
28
+ # @return [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam, nil]
29
+ optional :chatkit_configuration, -> { OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam }
30
+
31
+ # @!attribute expires_after
32
+ # Optional override for session expiration timing in seconds from creation.
33
+ # Defaults to 10 minutes.
34
+ #
35
+ # @return [OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam, nil]
36
+ optional :expires_after, -> { OpenAI::Beta::ChatKit::ChatSessionExpiresAfterParam }
37
+
38
+ # @!attribute rate_limits
39
+ # Optional override for per-minute request limits. When omitted, defaults to 10.
40
+ #
41
+ # @return [OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam, nil]
42
+ optional :rate_limits, -> { OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam }
43
+
44
+ # @!method initialize(user:, workflow:, chatkit_configuration: nil, expires_after: nil, rate_limits: nil, request_options: {})
45
+ # Some parameter documentations has been truncated, see
46
+ # {OpenAI::Models::Beta::ChatKit::SessionCreateParams} for more details.
47
+ #
48
+ # @param user [String] A free-form string that identifies your end user; ensures this Session can acces
49
+ #
50
+ # @param workflow [OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam] Workflow that powers the session.
51
+ #
52
+ # @param chatkit_configuration [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam] Optional overrides for ChatKit runtime configuration features
53
+ #
54
+ # @param expires_after [OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam] Optional override for session expiration timing in seconds from creation. Defaul
55
+ #
56
+ # @param rate_limits [OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam] Optional override for per-minute request limits. When omitted, defaults to 10.
57
+ #
58
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
59
+ end
60
+ end
61
+ end
62
+ end
63
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ module ChatKit
7
+ # @see OpenAI::Resources::Beta::ChatKit::Threads#delete
8
+ class ThreadDeleteParams < OpenAI::Internal::Type::BaseModel
9
+ extend OpenAI::Internal::Type::RequestParameters::Converter
10
+ include OpenAI::Internal::Type::RequestParameters
11
+
12
+ # @!method initialize(request_options: {})
13
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ module ChatKit
7
+ # @see OpenAI::Resources::Beta::ChatKit::Threads#delete
8
+ class ThreadDeleteResponse < OpenAI::Internal::Type::BaseModel
9
+ # @!attribute id
10
+ # Identifier of the deleted thread.
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!attribute deleted
16
+ # Indicates that the thread has been deleted.
17
+ #
18
+ # @return [Boolean]
19
+ required :deleted, OpenAI::Internal::Type::Boolean
20
+
21
+ # @!attribute object
22
+ # Type discriminator that is always `chatkit.thread.deleted`.
23
+ #
24
+ # @return [Symbol, :"chatkit.thread.deleted"]
25
+ required :object, const: :"chatkit.thread.deleted"
26
+
27
+ # @!method initialize(id:, deleted:, object: :"chatkit.thread.deleted")
28
+ # Confirmation payload returned after deleting a thread.
29
+ #
30
+ # @param id [String] Identifier of the deleted thread.
31
+ #
32
+ # @param deleted [Boolean] Indicates that the thread has been deleted.
33
+ #
34
+ # @param object [Symbol, :"chatkit.thread.deleted"] Type discriminator that is always `chatkit.thread.deleted`.
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,66 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ module ChatKit
7
+ # @see OpenAI::Resources::Beta::ChatKit::Threads#list_items
8
+ class ThreadListItemsParams < OpenAI::Internal::Type::BaseModel
9
+ extend OpenAI::Internal::Type::RequestParameters::Converter
10
+ include OpenAI::Internal::Type::RequestParameters
11
+
12
+ # @!attribute after
13
+ # List items created after this thread item ID. Defaults to null for the first
14
+ # page.
15
+ #
16
+ # @return [String, nil]
17
+ optional :after, String
18
+
19
+ # @!attribute before
20
+ # List items created before this thread item ID. Defaults to null for the newest
21
+ # results.
22
+ #
23
+ # @return [String, nil]
24
+ optional :before, String
25
+
26
+ # @!attribute limit
27
+ # Maximum number of thread items to return. Defaults to 20.
28
+ #
29
+ # @return [Integer, nil]
30
+ optional :limit, Integer
31
+
32
+ # @!attribute order
33
+ # Sort order for results by creation time. Defaults to `desc`.
34
+ #
35
+ # @return [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::Order, nil]
36
+ optional :order, enum: -> { OpenAI::Beta::ChatKit::ThreadListItemsParams::Order }
37
+
38
+ # @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
39
+ # Some parameter documentations has been truncated, see
40
+ # {OpenAI::Models::Beta::ChatKit::ThreadListItemsParams} for more details.
41
+ #
42
+ # @param after [String] List items created after this thread item ID. Defaults to null for the first pag
43
+ #
44
+ # @param before [String] List items created before this thread item ID. Defaults to null for the newest r
45
+ #
46
+ # @param limit [Integer] Maximum number of thread items to return. Defaults to 20.
47
+ #
48
+ # @param order [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::Order] Sort order for results by creation time. Defaults to `desc`.
49
+ #
50
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
51
+
52
+ # Sort order for results by creation time. Defaults to `desc`.
53
+ module Order
54
+ extend OpenAI::Internal::Type::Enum
55
+
56
+ ASC = :asc
57
+ DESC = :desc
58
+
59
+ # @!method self.values
60
+ # @return [Array<Symbol>]
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,75 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ module ChatKit
7
+ # @see OpenAI::Resources::Beta::ChatKit::Threads#list
8
+ class ThreadListParams < OpenAI::Internal::Type::BaseModel
9
+ extend OpenAI::Internal::Type::RequestParameters::Converter
10
+ include OpenAI::Internal::Type::RequestParameters
11
+
12
+ # @!attribute after
13
+ # List items created after this thread item ID. Defaults to null for the first
14
+ # page.
15
+ #
16
+ # @return [String, nil]
17
+ optional :after, String
18
+
19
+ # @!attribute before
20
+ # List items created before this thread item ID. Defaults to null for the newest
21
+ # results.
22
+ #
23
+ # @return [String, nil]
24
+ optional :before, String
25
+
26
+ # @!attribute limit
27
+ # Maximum number of thread items to return. Defaults to 20.
28
+ #
29
+ # @return [Integer, nil]
30
+ optional :limit, Integer
31
+
32
+ # @!attribute order
33
+ # Sort order for results by creation time. Defaults to `desc`.
34
+ #
35
+ # @return [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListParams::Order, nil]
36
+ optional :order, enum: -> { OpenAI::Beta::ChatKit::ThreadListParams::Order }
37
+
38
+ # @!attribute user
39
+ # Filter threads that belong to this user identifier. Defaults to null to return
40
+ # all users.
41
+ #
42
+ # @return [String, nil]
43
+ optional :user, String
44
+
45
+ # @!method initialize(after: nil, before: nil, limit: nil, order: nil, user: nil, request_options: {})
46
+ # Some parameter documentations has been truncated, see
47
+ # {OpenAI::Models::Beta::ChatKit::ThreadListParams} for more details.
48
+ #
49
+ # @param after [String] List items created after this thread item ID. Defaults to null for the first pag
50
+ #
51
+ # @param before [String] List items created before this thread item ID. Defaults to null for the newest r
52
+ #
53
+ # @param limit [Integer] Maximum number of thread items to return. Defaults to 20.
54
+ #
55
+ # @param order [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListParams::Order] Sort order for results by creation time. Defaults to `desc`.
56
+ #
57
+ # @param user [String] Filter threads that belong to this user identifier. Defaults to null to return a
58
+ #
59
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
60
+
61
+ # Sort order for results by creation time. Defaults to `desc`.
62
+ module Order
63
+ extend OpenAI::Internal::Type::Enum
64
+
65
+ ASC = :asc
66
+ DESC = :desc
67
+
68
+ # @!method self.values
69
+ # @return [Array<Symbol>]
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ module ChatKit
7
+ # @see OpenAI::Resources::Beta::ChatKit::Threads#retrieve
8
+ class ThreadRetrieveParams < OpenAI::Internal::Type::BaseModel
9
+ extend OpenAI::Internal::Type::RequestParameters::Converter
10
+ include OpenAI::Internal::Type::RequestParameters
11
+
12
+ # @!method initialize(request_options: {})
13
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ # @see OpenAI::Resources::Beta::ChatKit#upload_file
7
+ class ChatKitUploadFileParams < OpenAI::Internal::Type::BaseModel
8
+ extend OpenAI::Internal::Type::RequestParameters::Converter
9
+ include OpenAI::Internal::Type::RequestParameters
10
+
11
+ # @!attribute file
12
+ # Binary file contents to store with the ChatKit session. Supports PDFs and PNG,
13
+ # JPG, JPEG, GIF, or WEBP images.
14
+ #
15
+ # @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
16
+ required :file, OpenAI::Internal::Type::FileInput
17
+
18
+ # @!method initialize(file:, request_options: {})
19
+ # Some parameter documentations has been truncated, see
20
+ # {OpenAI::Models::Beta::ChatKitUploadFileParams} for more details.
21
+ #
22
+ # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] Binary file contents to store with the ChatKit session. Supports PDFs and PNG, J
23
+ #
24
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ # Represents either a file or image attachment.
7
+ #
8
+ # @see OpenAI::Resources::Beta::ChatKit#upload_file
9
+ module ChatKitUploadFileResponse
10
+ extend OpenAI::Internal::Type::Union
11
+
12
+ discriminator :type
13
+
14
+ # Metadata for a non-image file uploaded through ChatKit.
15
+ variant :file, -> { OpenAI::Beta::FilePart }
16
+
17
+ # Metadata for an image uploaded through ChatKit.
18
+ variant :image, -> { OpenAI::Beta::ImagePart }
19
+
20
+ # @!method self.variants
21
+ # @return [Array(OpenAI::Models::Beta::FilePart, OpenAI::Models::Beta::ImagePart)]
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,78 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ class ChatKitWorkflow < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # Identifier of the workflow backing the session.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute state_variables
14
+ # State variable key-value pairs applied when invoking the workflow. Defaults to
15
+ # null when no overrides were provided.
16
+ #
17
+ # @return [Hash{Symbol=>String, Boolean, Float}, nil]
18
+ required :state_variables,
19
+ -> { OpenAI::Internal::Type::HashOf[union: OpenAI::Beta::ChatKitWorkflow::StateVariable] },
20
+ nil?: true
21
+
22
+ # @!attribute tracing
23
+ # Tracing settings applied to the workflow.
24
+ #
25
+ # @return [OpenAI::Models::Beta::ChatKitWorkflow::Tracing]
26
+ required :tracing, -> { OpenAI::Beta::ChatKitWorkflow::Tracing }
27
+
28
+ # @!attribute version
29
+ # Specific workflow version used for the session. Defaults to null when using the
30
+ # latest deployment.
31
+ #
32
+ # @return [String, nil]
33
+ required :version, String, nil?: true
34
+
35
+ # @!method initialize(id:, state_variables:, tracing:, version:)
36
+ # Some parameter documentations has been truncated, see
37
+ # {OpenAI::Models::Beta::ChatKitWorkflow} for more details.
38
+ #
39
+ # Workflow metadata and state returned for the session.
40
+ #
41
+ # @param id [String] Identifier of the workflow backing the session.
42
+ #
43
+ # @param state_variables [Hash{Symbol=>String, Boolean, Float}, nil] State variable key-value pairs applied when invoking the workflow. Defaults to n
44
+ #
45
+ # @param tracing [OpenAI::Models::Beta::ChatKitWorkflow::Tracing] Tracing settings applied to the workflow.
46
+ #
47
+ # @param version [String, nil] Specific workflow version used for the session. Defaults to null when using the
48
+
49
+ module StateVariable
50
+ extend OpenAI::Internal::Type::Union
51
+
52
+ variant String
53
+
54
+ variant OpenAI::Internal::Type::Boolean
55
+
56
+ variant Float
57
+
58
+ # @!method self.variants
59
+ # @return [Array(String, Boolean, Float)]
60
+ end
61
+
62
+ # @see OpenAI::Models::Beta::ChatKitWorkflow#tracing
63
+ class Tracing < OpenAI::Internal::Type::BaseModel
64
+ # @!attribute enabled
65
+ # Indicates whether tracing is enabled.
66
+ #
67
+ # @return [Boolean]
68
+ required :enabled, OpenAI::Internal::Type::Boolean
69
+
70
+ # @!method initialize(enabled:)
71
+ # Tracing settings applied to the workflow.
72
+ #
73
+ # @param enabled [Boolean] Indicates whether tracing is enabled.
74
+ end
75
+ end
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ class FilePart < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # Unique identifier for the uploaded file.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute mime_type
14
+ # MIME type reported for the uploaded file. Defaults to null when unknown.
15
+ #
16
+ # @return [String, nil]
17
+ required :mime_type, String, nil?: true
18
+
19
+ # @!attribute name
20
+ # Original filename supplied by the uploader. Defaults to null when unnamed.
21
+ #
22
+ # @return [String, nil]
23
+ required :name, String, nil?: true
24
+
25
+ # @!attribute type
26
+ # Type discriminator that is always `file`.
27
+ #
28
+ # @return [Symbol, :file]
29
+ required :type, const: :file
30
+
31
+ # @!attribute upload_url
32
+ # Signed URL for downloading the uploaded file. Defaults to null when no download
33
+ # link is available.
34
+ #
35
+ # @return [String, nil]
36
+ required :upload_url, String, nil?: true
37
+
38
+ # @!method initialize(id:, mime_type:, name:, upload_url:, type: :file)
39
+ # Some parameter documentations has been truncated, see
40
+ # {OpenAI::Models::Beta::FilePart} for more details.
41
+ #
42
+ # Metadata for a non-image file uploaded through ChatKit.
43
+ #
44
+ # @param id [String] Unique identifier for the uploaded file.
45
+ #
46
+ # @param mime_type [String, nil] MIME type reported for the uploaded file. Defaults to null when unknown.
47
+ #
48
+ # @param name [String, nil] Original filename supplied by the uploader. Defaults to null when unnamed.
49
+ #
50
+ # @param upload_url [String, nil] Signed URL for downloading the uploaded file. Defaults to null when no download
51
+ #
52
+ # @param type [Symbol, :file] Type discriminator that is always `file`.
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,64 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ class ImagePart < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # Unique identifier for the uploaded image.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute mime_type
14
+ # MIME type of the uploaded image.
15
+ #
16
+ # @return [String]
17
+ required :mime_type, String
18
+
19
+ # @!attribute name
20
+ # Original filename for the uploaded image. Defaults to null when unnamed.
21
+ #
22
+ # @return [String, nil]
23
+ required :name, String, nil?: true
24
+
25
+ # @!attribute preview_url
26
+ # Preview URL that can be rendered inline for the image.
27
+ #
28
+ # @return [String]
29
+ required :preview_url, String
30
+
31
+ # @!attribute type
32
+ # Type discriminator that is always `image`.
33
+ #
34
+ # @return [Symbol, :image]
35
+ required :type, const: :image
36
+
37
+ # @!attribute upload_url
38
+ # Signed URL for downloading the uploaded image. Defaults to null when no download
39
+ # link is available.
40
+ #
41
+ # @return [String, nil]
42
+ required :upload_url, String, nil?: true
43
+
44
+ # @!method initialize(id:, mime_type:, name:, preview_url:, upload_url:, type: :image)
45
+ # Some parameter documentations has been truncated, see
46
+ # {OpenAI::Models::Beta::ImagePart} for more details.
47
+ #
48
+ # Metadata for an image uploaded through ChatKit.
49
+ #
50
+ # @param id [String] Unique identifier for the uploaded image.
51
+ #
52
+ # @param mime_type [String] MIME type of the uploaded image.
53
+ #
54
+ # @param name [String, nil] Original filename for the uploaded image. Defaults to null when unnamed.
55
+ #
56
+ # @param preview_url [String] Preview URL that can be rendered inline for the image.
57
+ #
58
+ # @param upload_url [String, nil] Signed URL for downloading the uploaded image. Defaults to null when no download
59
+ #
60
+ # @param type [Symbol, :image] Type discriminator that is always `image`.
61
+ end
62
+ end
63
+ end
64
+ end
@@ -43,7 +43,8 @@ module OpenAI
43
43
  # @!attribute input_fidelity
44
44
  # Control how much effort the model will exert to match the style and features,
45
45
  # especially facial features, of input images. This parameter is only supported
46
- # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
46
+ # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
47
+ # `low`. Defaults to `low`.
47
48
  #
48
49
  # @return [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
49
50
  optional :input_fidelity, enum: -> { OpenAI::ImageEditParams::InputFidelity }, nil?: true
@@ -206,7 +207,8 @@ module OpenAI
206
207
 
207
208
  # Control how much effort the model will exert to match the style and features,
208
209
  # especially facial features, of input images. This parameter is only supported
209
- # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
210
+ # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
211
+ # `low`. Defaults to `low`.
210
212
  module InputFidelity
211
213
  extend OpenAI::Internal::Type::Enum
212
214
 
@@ -8,6 +8,7 @@ module OpenAI
8
8
  DALL_E_2 = :"dall-e-2"
9
9
  DALL_E_3 = :"dall-e-3"
10
10
  GPT_IMAGE_1 = :"gpt-image-1"
11
+ GPT_IMAGE_1_MINI = :"gpt-image-1-mini"
11
12
 
12
13
  # @!method self.values
13
14
  # @return [Array<Symbol>]
@@ -316,6 +316,10 @@ module OpenAI
316
316
  GPT_4O_REALTIME_PREVIEW_2025_06_03 = :"gpt-4o-realtime-preview-2025-06-03"
317
317
  GPT_4O_MINI_REALTIME_PREVIEW = :"gpt-4o-mini-realtime-preview"
318
318
  GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 = :"gpt-4o-mini-realtime-preview-2024-12-17"
319
+ GPT_REALTIME_MINI = :"gpt-realtime-mini"
320
+ GPT_REALTIME_MINI_2025_10_06 = :"gpt-realtime-mini-2025-10-06"
321
+ GPT_AUDIO_MINI = :"gpt-audio-mini"
322
+ GPT_AUDIO_MINI_2025_10_06 = :"gpt-audio-mini-2025-10-06"
319
323
 
320
324
  # @!method self.values
321
325
  # @return [Array<Symbol>]
@@ -183,6 +183,14 @@ module OpenAI
183
183
 
184
184
  variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model::GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 }
185
185
 
186
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model::GPT_REALTIME_MINI }
187
+
188
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model::GPT_REALTIME_MINI_2025_10_06 }
189
+
190
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model::GPT_AUDIO_MINI }
191
+
192
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model::GPT_AUDIO_MINI_2025_10_06 }
193
+
186
194
  # @!method self.variants
187
195
  # @return [Array(String, Symbol)]
188
196
 
@@ -200,6 +208,10 @@ module OpenAI
200
208
  GPT_4O_REALTIME_PREVIEW_2025_06_03 = :"gpt-4o-realtime-preview-2025-06-03"
201
209
  GPT_4O_MINI_REALTIME_PREVIEW = :"gpt-4o-mini-realtime-preview"
202
210
  GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 = :"gpt-4o-mini-realtime-preview-2024-12-17"
211
+ GPT_REALTIME_MINI = :"gpt-realtime-mini"
212
+ GPT_REALTIME_MINI_2025_10_06 = :"gpt-realtime-mini-2025-10-06"
213
+ GPT_AUDIO_MINI = :"gpt-audio-mini"
214
+ GPT_AUDIO_MINI_2025_10_06 = :"gpt-audio-mini-2025-10-06"
203
215
 
204
216
  # @!endgroup
205
217
  end
@@ -584,6 +584,14 @@ module OpenAI
584
584
 
585
585
  variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Model::GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 }
586
586
 
587
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Model::GPT_REALTIME_MINI }
588
+
589
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Model::GPT_REALTIME_MINI_2025_10_06 }
590
+
591
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Model::GPT_AUDIO_MINI }
592
+
593
+ variant const: -> { OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Model::GPT_AUDIO_MINI_2025_10_06 }
594
+
587
595
  # @!method self.variants
588
596
  # @return [Array(String, Symbol)]
589
597
 
@@ -601,6 +609,10 @@ module OpenAI
601
609
  GPT_4O_REALTIME_PREVIEW_2025_06_03 = :"gpt-4o-realtime-preview-2025-06-03"
602
610
  GPT_4O_MINI_REALTIME_PREVIEW = :"gpt-4o-mini-realtime-preview"
603
611
  GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 = :"gpt-4o-mini-realtime-preview-2024-12-17"
612
+ GPT_REALTIME_MINI = :"gpt-realtime-mini"
613
+ GPT_REALTIME_MINI_2025_10_06 = :"gpt-realtime-mini-2025-10-06"
614
+ GPT_AUDIO_MINI = :"gpt-audio-mini"
615
+ GPT_AUDIO_MINI_2025_10_06 = :"gpt-audio-mini-2025-10-06"
604
616
 
605
617
  # @!endgroup
606
618
  end
@@ -427,7 +427,8 @@ module OpenAI
427
427
  # @!attribute input_fidelity
428
428
  # Control how much effort the model will exert to match the style and features,
429
429
  # especially facial features, of input images. This parameter is only supported
430
- # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
430
+ # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
431
+ # `low`. Defaults to `low`.
431
432
  #
432
433
  # @return [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil]
433
434
  optional :input_fidelity,
@@ -534,7 +535,8 @@ module OpenAI
534
535
 
535
536
  # Control how much effort the model will exert to match the style and features,
536
537
  # especially facial features, of input images. This parameter is only supported
537
- # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
538
+ # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
539
+ # `low`. Defaults to `low`.
538
540
  #
539
541
  # @see OpenAI::Models::Responses::Tool::ImageGeneration#input_fidelity
540
542
  module InputFidelity
@@ -581,6 +583,7 @@ module OpenAI
581
583
  extend OpenAI::Internal::Type::Enum
582
584
 
583
585
  GPT_IMAGE_1 = :"gpt-image-1"
586
+ GPT_IMAGE_1_MINI = :"gpt-image-1-mini"
584
587
 
585
588
  # @!method self.values
586
589
  # @return [Array<Symbol>]
@@ -25,6 +25,8 @@ module OpenAI
25
25
  COMPUTER_USE_PREVIEW = :"computer-use-preview"
26
26
  COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
27
27
  GPT_5_CODEX = :"gpt-5-codex"
28
+ GPT_5_PRO = :"gpt-5-pro"
29
+ GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
28
30
 
29
31
  # @!method self.values
30
32
  # @return [Array<Symbol>]