openai 0.63.0 → 0.64.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 (265) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +1 -1
  4. data/lib/openai/internal/transport/base_client.rb +2 -0
  5. data/lib/openai/models/admin/organization/data_retention_retrieve_params.rb +18 -0
  6. data/lib/openai/models/admin/organization/data_retention_update_params.rb +40 -0
  7. data/lib/openai/models/admin/organization/group.rb +16 -3
  8. data/lib/openai/models/admin/organization/group_retrieve_params.rb +24 -0
  9. data/lib/openai/models/admin/organization/groups/role_list_response.rb +27 -1
  10. data/lib/openai/models/admin/organization/groups/role_retrieve_params.rb +32 -0
  11. data/lib/openai/models/admin/organization/groups/role_retrieve_response.rb +134 -0
  12. data/lib/openai/models/admin/organization/groups/user_retrieve_params.rb +32 -0
  13. data/lib/openai/models/admin/organization/groups/user_retrieve_response.rb +79 -0
  14. data/lib/openai/models/admin/organization/invite_create_params.rb +2 -1
  15. data/lib/openai/models/admin/organization/organization_data_retention.rb +48 -0
  16. data/lib/openai/models/admin/organization/organization_spend_alert.rb +120 -0
  17. data/lib/openai/models/admin/organization/organization_spend_alert_deleted.rb +41 -0
  18. data/lib/openai/models/admin/organization/projects/data_retention_retrieve_params.rb +26 -0
  19. data/lib/openai/models/admin/organization/projects/data_retention_update_params.rb +51 -0
  20. data/lib/openai/models/admin/organization/projects/group_retrieve_params.rb +53 -0
  21. data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb +27 -1
  22. data/lib/openai/models/admin/organization/projects/groups/role_retrieve_params.rb +40 -0
  23. data/lib/openai/models/admin/organization/projects/groups/role_retrieve_response.rb +136 -0
  24. data/lib/openai/models/admin/organization/projects/hosted_tool_permission_retrieve_params.rb +26 -0
  25. data/lib/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rb +150 -0
  26. data/lib/openai/models/admin/organization/projects/model_permission_delete_params.rb +26 -0
  27. data/lib/openai/models/admin/organization/projects/model_permission_retrieve_params.rb +26 -0
  28. data/lib/openai/models/admin/organization/projects/model_permission_update_params.rb +54 -0
  29. data/lib/openai/models/admin/organization/projects/project_data_retention.rb +52 -0
  30. data/lib/openai/models/admin/organization/projects/project_group.rb +16 -3
  31. data/lib/openai/models/admin/organization/projects/project_hosted_tool_permissions.rb +133 -0
  32. data/lib/openai/models/admin/organization/projects/project_model_permissions.rb +56 -0
  33. data/lib/openai/models/admin/organization/projects/project_model_permissions_deleted.rb +35 -0
  34. data/lib/openai/models/admin/organization/projects/project_spend_alert.rb +122 -0
  35. data/lib/openai/models/admin/organization/projects/project_spend_alert_deleted.rb +43 -0
  36. data/lib/openai/models/admin/organization/projects/role_retrieve_params.rb +32 -0
  37. data/lib/openai/models/admin/organization/projects/service_account_update_params.rb +61 -0
  38. data/lib/openai/models/admin/organization/projects/spend_alert_create_params.rb +109 -0
  39. data/lib/openai/models/admin/organization/projects/spend_alert_delete_params.rb +32 -0
  40. data/lib/openai/models/admin/organization/projects/spend_alert_list_params.rb +76 -0
  41. data/lib/openai/models/admin/organization/projects/spend_alert_update_params.rb +116 -0
  42. data/lib/openai/models/admin/organization/projects/users/role_list_response.rb +27 -1
  43. data/lib/openai/models/admin/organization/projects/users/role_retrieve_params.rb +40 -0
  44. data/lib/openai/models/admin/organization/projects/users/role_retrieve_response.rb +136 -0
  45. data/lib/openai/models/admin/organization/role_retrieve_params.rb +24 -0
  46. data/lib/openai/models/admin/organization/spend_alert_create_params.rb +100 -0
  47. data/lib/openai/models/admin/organization/spend_alert_delete_params.rb +24 -0
  48. data/lib/openai/models/admin/organization/spend_alert_list_params.rb +66 -0
  49. data/lib/openai/models/admin/organization/spend_alert_update_params.rb +107 -0
  50. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +148 -3
  51. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +148 -3
  52. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +148 -3
  53. data/lib/openai/models/admin/organization/usage_completions_response.rb +148 -3
  54. data/lib/openai/models/admin/organization/usage_costs_response.rb +148 -3
  55. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +148 -3
  56. data/lib/openai/models/admin/organization/usage_file_search_calls_params.rb +136 -0
  57. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +889 -0
  58. data/lib/openai/models/admin/organization/usage_images_response.rb +148 -3
  59. data/lib/openai/models/admin/organization/usage_moderations_response.rb +148 -3
  60. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +148 -3
  61. data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +157 -0
  62. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +889 -0
  63. data/lib/openai/models/admin/organization/users/role_list_response.rb +27 -1
  64. data/lib/openai/models/admin/organization/users/role_retrieve_params.rb +32 -0
  65. data/lib/openai/models/admin/organization/users/role_retrieve_response.rb +134 -0
  66. data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
  67. data/lib/openai/models/conversations/item_create_params.rb +2 -2
  68. data/lib/openai/models/responses/input_token_count_params.rb +3 -3
  69. data/lib/openai/models/responses/response.rb +3 -3
  70. data/lib/openai/models/responses/response_compact_params.rb +3 -3
  71. data/lib/openai/models/responses/response_create_params.rb +3 -3
  72. data/lib/openai/models/responses/response_input_item.rb +17 -1
  73. data/lib/openai/models/responses/responses_client_event.rb +3 -3
  74. data/lib/openai/resources/admin/organization/data_retention.rb +60 -0
  75. data/lib/openai/resources/admin/organization/groups/roles.rb +28 -0
  76. data/lib/openai/resources/admin/organization/groups/users.rb +28 -0
  77. data/lib/openai/resources/admin/organization/groups.rb +21 -0
  78. data/lib/openai/resources/admin/organization/projects/data_retention.rb +66 -0
  79. data/lib/openai/resources/admin/organization/projects/groups/roles.rb +34 -0
  80. data/lib/openai/resources/admin/organization/projects/groups.rb +32 -0
  81. data/lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb +75 -0
  82. data/lib/openai/resources/admin/organization/projects/model_permissions.rb +89 -0
  83. data/lib/openai/resources/admin/organization/projects/roles.rb +28 -0
  84. data/lib/openai/resources/admin/organization/projects/service_accounts.rb +33 -0
  85. data/lib/openai/resources/admin/organization/projects/spend_alerts.rb +153 -0
  86. data/lib/openai/resources/admin/organization/projects/users/roles.rb +34 -0
  87. data/lib/openai/resources/admin/organization/projects.rb +18 -0
  88. data/lib/openai/resources/admin/organization/roles.rb +21 -0
  89. data/lib/openai/resources/admin/organization/spend_alerts.rb +133 -0
  90. data/lib/openai/resources/admin/organization/usage.rb +94 -0
  91. data/lib/openai/resources/admin/organization/users/roles.rb +28 -0
  92. data/lib/openai/resources/admin/organization.rb +8 -0
  93. data/lib/openai/resources/conversations/items.rb +1 -1
  94. data/lib/openai/resources/conversations.rb +1 -1
  95. data/lib/openai/resources/responses/input_tokens.rb +1 -1
  96. data/lib/openai/resources/responses.rb +3 -3
  97. data/lib/openai/version.rb +1 -1
  98. data/lib/openai.rb +51 -0
  99. data/rbi/openai/models/admin/organization/data_retention_retrieve_params.rbi +34 -0
  100. data/rbi/openai/models/admin/organization/data_retention_update_params.rbi +101 -0
  101. data/rbi/openai/models/admin/organization/group.rbi +39 -3
  102. data/rbi/openai/models/admin/organization/group_retrieve_params.rbi +42 -0
  103. data/rbi/openai/models/admin/organization/groups/role_list_response.rbi +58 -0
  104. data/rbi/openai/models/admin/organization/groups/role_retrieve_params.rbi +52 -0
  105. data/rbi/openai/models/admin/organization/groups/role_retrieve_response.rbi +186 -0
  106. data/rbi/openai/models/admin/organization/groups/user_retrieve_params.rbi +52 -0
  107. data/rbi/openai/models/admin/organization/groups/user_retrieve_response.rbi +128 -0
  108. data/rbi/openai/models/admin/organization/invite_create_params.rbi +4 -2
  109. data/rbi/openai/models/admin/organization/organization_data_retention.rbi +106 -0
  110. data/rbi/openai/models/admin/organization/organization_spend_alert.rbi +225 -0
  111. data/rbi/openai/models/admin/organization/organization_spend_alert_deleted.rbi +58 -0
  112. data/rbi/openai/models/admin/organization/projects/data_retention_retrieve_params.rbi +44 -0
  113. data/rbi/openai/models/admin/organization/projects/data_retention_update_params.rbi +119 -0
  114. data/rbi/openai/models/admin/organization/projects/group_retrieve_params.rbi +115 -0
  115. data/rbi/openai/models/admin/organization/projects/groups/role_list_response.rbi +58 -0
  116. data/rbi/openai/models/admin/organization/projects/groups/role_retrieve_params.rbi +64 -0
  117. data/rbi/openai/models/admin/organization/projects/groups/role_retrieve_response.rbi +188 -0
  118. data/rbi/openai/models/admin/organization/projects/hosted_tool_permission_retrieve_params.rbi +44 -0
  119. data/rbi/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rbi +330 -0
  120. data/rbi/openai/models/admin/organization/projects/model_permission_delete_params.rbi +44 -0
  121. data/rbi/openai/models/admin/organization/projects/model_permission_retrieve_params.rbi +44 -0
  122. data/rbi/openai/models/admin/organization/projects/model_permission_update_params.rbi +107 -0
  123. data/rbi/openai/models/admin/organization/projects/project_data_retention.rbi +118 -0
  124. data/rbi/openai/models/admin/organization/projects/project_group.rbi +44 -3
  125. data/rbi/openai/models/admin/organization/projects/project_hosted_tool_permissions.rbi +281 -0
  126. data/rbi/openai/models/admin/organization/projects/project_model_permissions.rbi +106 -0
  127. data/rbi/openai/models/admin/organization/projects/project_model_permissions_deleted.rbi +50 -0
  128. data/rbi/openai/models/admin/organization/projects/project_spend_alert.rbi +227 -0
  129. data/rbi/openai/models/admin/organization/projects/project_spend_alert_deleted.rbi +59 -0
  130. data/rbi/openai/models/admin/organization/projects/role_retrieve_params.rbi +52 -0
  131. data/rbi/openai/models/admin/organization/projects/service_account_update_params.rbi +126 -0
  132. data/rbi/openai/models/admin/organization/projects/spend_alert_create_params.rbi +220 -0
  133. data/rbi/openai/models/admin/organization/projects/spend_alert_delete_params.rbi +52 -0
  134. data/rbi/openai/models/admin/organization/projects/spend_alert_list_params.rbi +146 -0
  135. data/rbi/openai/models/admin/organization/projects/spend_alert_update_params.rbi +226 -0
  136. data/rbi/openai/models/admin/organization/projects/users/role_list_response.rbi +58 -0
  137. data/rbi/openai/models/admin/organization/projects/users/role_retrieve_params.rbi +59 -0
  138. data/rbi/openai/models/admin/organization/projects/users/role_retrieve_response.rbi +188 -0
  139. data/rbi/openai/models/admin/organization/role_retrieve_params.rbi +42 -0
  140. data/rbi/openai/models/admin/organization/spend_alert_create_params.rbi +212 -0
  141. data/rbi/openai/models/admin/organization/spend_alert_delete_params.rbi +42 -0
  142. data/rbi/openai/models/admin/organization/spend_alert_list_params.rbi +138 -0
  143. data/rbi/openai/models/admin/organization/spend_alert_update_params.rbi +218 -0
  144. data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +186 -0
  145. data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +186 -0
  146. data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +186 -0
  147. data/rbi/openai/models/admin/organization/usage_completions_response.rbi +186 -0
  148. data/rbi/openai/models/admin/organization/usage_costs_response.rbi +186 -0
  149. data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +186 -0
  150. data/rbi/openai/models/admin/organization/usage_file_search_calls_params.rbi +284 -0
  151. data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +1225 -0
  152. data/rbi/openai/models/admin/organization/usage_images_response.rbi +186 -0
  153. data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +186 -0
  154. data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +186 -0
  155. data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +360 -0
  156. data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +1225 -0
  157. data/rbi/openai/models/admin/organization/users/role_list_response.rbi +58 -0
  158. data/rbi/openai/models/admin/organization/users/role_retrieve_params.rbi +52 -0
  159. data/rbi/openai/models/admin/organization/users/role_retrieve_response.rbi +186 -0
  160. data/rbi/openai/models/conversations/conversation_create_params.rbi +3 -0
  161. data/rbi/openai/models/conversations/item_create_params.rbi +3 -0
  162. data/rbi/openai/models/responses/response_input_item.rbi +27 -0
  163. data/rbi/openai/resources/admin/organization/data_retention.rbi +40 -0
  164. data/rbi/openai/resources/admin/organization/groups/roles.rbi +19 -0
  165. data/rbi/openai/resources/admin/organization/groups/users.rbi +19 -0
  166. data/rbi/openai/resources/admin/organization/groups.rbi +14 -0
  167. data/rbi/openai/resources/admin/organization/invites.rbi +2 -1
  168. data/rbi/openai/resources/admin/organization/projects/data_retention.rbi +54 -0
  169. data/rbi/openai/resources/admin/organization/projects/groups/roles.rbi +22 -0
  170. data/rbi/openai/resources/admin/organization/projects/groups.rbi +21 -0
  171. data/rbi/openai/resources/admin/organization/projects/hosted_tool_permissions.rbi +80 -0
  172. data/rbi/openai/resources/admin/organization/projects/model_permissions.rbi +73 -0
  173. data/rbi/openai/resources/admin/organization/projects/roles.rbi +17 -0
  174. data/rbi/openai/resources/admin/organization/projects/service_accounts.rbi +26 -0
  175. data/rbi/openai/resources/admin/organization/projects/spend_alerts.rbi +135 -0
  176. data/rbi/openai/resources/admin/organization/projects/users/roles.rbi +22 -0
  177. data/rbi/openai/resources/admin/organization/projects.rbi +28 -0
  178. data/rbi/openai/resources/admin/organization/roles.rbi +14 -0
  179. data/rbi/openai/resources/admin/organization/spend_alerts.rbi +117 -0
  180. data/rbi/openai/resources/admin/organization/usage.rbi +116 -0
  181. data/rbi/openai/resources/admin/organization/users/roles.rbi +19 -0
  182. data/rbi/openai/resources/admin/organization.rbi +6 -0
  183. data/rbi/openai/resources/conversations/items.rbi +1 -0
  184. data/rbi/openai/resources/conversations.rbi +1 -0
  185. data/sig/openai/models/admin/organization/data_retention_retrieve_params.rbs +19 -0
  186. data/sig/openai/models/admin/organization/data_retention_update_params.rbs +47 -0
  187. data/sig/openai/models/admin/organization/group.rbs +15 -4
  188. data/sig/openai/models/admin/organization/group_retrieve_params.rbs +27 -0
  189. data/sig/openai/models/admin/organization/groups/role_list_response.rbs +21 -0
  190. data/sig/openai/models/admin/organization/groups/role_retrieve_params.rbs +34 -0
  191. data/sig/openai/models/admin/organization/groups/role_retrieve_response.rbs +97 -0
  192. data/sig/openai/models/admin/organization/groups/user_retrieve_params.rbs +34 -0
  193. data/sig/openai/models/admin/organization/groups/user_retrieve_response.rbs +62 -0
  194. data/sig/openai/models/admin/organization/organization_data_retention.rbs +48 -0
  195. data/sig/openai/models/admin/organization/organization_spend_alert.rbs +98 -0
  196. data/sig/openai/models/admin/organization/organization_spend_alert_deleted.rbs +36 -0
  197. data/sig/openai/models/admin/organization/projects/data_retention_retrieve_params.rbs +29 -0
  198. data/sig/openai/models/admin/organization/projects/data_retention_update_params.rbs +58 -0
  199. data/sig/openai/models/admin/organization/projects/group_retrieve_params.rbs +57 -0
  200. data/sig/openai/models/admin/organization/projects/groups/role_list_response.rbs +21 -0
  201. data/sig/openai/models/admin/organization/projects/groups/role_retrieve_params.rbs +40 -0
  202. data/sig/openai/models/admin/organization/projects/groups/role_retrieve_response.rbs +99 -0
  203. data/sig/openai/models/admin/organization/projects/hosted_tool_permission_retrieve_params.rbs +29 -0
  204. data/sig/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rbs +107 -0
  205. data/sig/openai/models/admin/organization/projects/model_permission_delete_params.rbs +29 -0
  206. data/sig/openai/models/admin/organization/projects/model_permission_retrieve_params.rbs +29 -0
  207. data/sig/openai/models/admin/organization/projects/model_permission_update_params.rbs +53 -0
  208. data/sig/openai/models/admin/organization/projects/project_data_retention.rbs +54 -0
  209. data/sig/openai/models/admin/organization/projects/project_group.rbs +15 -4
  210. data/sig/openai/models/admin/organization/projects/project_hosted_tool_permissions.rbs +98 -0
  211. data/sig/openai/models/admin/organization/projects/project_model_permissions.rbs +49 -0
  212. data/sig/openai/models/admin/organization/projects/project_model_permissions_deleted.rbs +30 -0
  213. data/sig/openai/models/admin/organization/projects/project_spend_alert.rbs +100 -0
  214. data/sig/openai/models/admin/organization/projects/project_spend_alert_deleted.rbs +38 -0
  215. data/sig/openai/models/admin/organization/projects/role_retrieve_params.rbs +34 -0
  216. data/sig/openai/models/admin/organization/projects/service_account_update_params.rbs +64 -0
  217. data/sig/openai/models/admin/organization/projects/spend_alert_create_params.rbs +99 -0
  218. data/sig/openai/models/admin/organization/projects/spend_alert_delete_params.rbs +34 -0
  219. data/sig/openai/models/admin/organization/projects/spend_alert_list_params.rbs +73 -0
  220. data/sig/openai/models/admin/organization/projects/spend_alert_update_params.rbs +104 -0
  221. data/sig/openai/models/admin/organization/projects/users/role_list_response.rbs +21 -0
  222. data/sig/openai/models/admin/organization/projects/users/role_retrieve_params.rbs +40 -0
  223. data/sig/openai/models/admin/organization/projects/users/role_retrieve_response.rbs +99 -0
  224. data/sig/openai/models/admin/organization/role_retrieve_params.rbs +27 -0
  225. data/sig/openai/models/admin/organization/spend_alert_create_params.rbs +92 -0
  226. data/sig/openai/models/admin/organization/spend_alert_delete_params.rbs +27 -0
  227. data/sig/openai/models/admin/organization/spend_alert_list_params.rbs +66 -0
  228. data/sig/openai/models/admin/organization/spend_alert_update_params.rbs +97 -0
  229. data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +96 -0
  230. data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +96 -0
  231. data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +96 -0
  232. data/sig/openai/models/admin/organization/usage_completions_response.rbs +96 -0
  233. data/sig/openai/models/admin/organization/usage_costs_response.rbs +96 -0
  234. data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +96 -0
  235. data/sig/openai/models/admin/organization/usage_file_search_calls_params.rbs +123 -0
  236. data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +628 -0
  237. data/sig/openai/models/admin/organization/usage_images_response.rbs +96 -0
  238. data/sig/openai/models/admin/organization/usage_moderations_response.rbs +96 -0
  239. data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +96 -0
  240. data/sig/openai/models/admin/organization/usage_web_search_calls_params.rbs +145 -0
  241. data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +628 -0
  242. data/sig/openai/models/admin/organization/users/role_list_response.rbs +21 -0
  243. data/sig/openai/models/admin/organization/users/role_retrieve_params.rbs +34 -0
  244. data/sig/openai/models/admin/organization/users/role_retrieve_response.rbs +97 -0
  245. data/sig/openai/models/responses/response_input_item.rbs +11 -0
  246. data/sig/openai/resources/admin/organization/data_retention.rbs +20 -0
  247. data/sig/openai/resources/admin/organization/groups/roles.rbs +6 -0
  248. data/sig/openai/resources/admin/organization/groups/users.rbs +6 -0
  249. data/sig/openai/resources/admin/organization/groups.rbs +5 -0
  250. data/sig/openai/resources/admin/organization/projects/data_retention.rbs +24 -0
  251. data/sig/openai/resources/admin/organization/projects/groups/roles.rbs +7 -0
  252. data/sig/openai/resources/admin/organization/projects/groups.rbs +7 -0
  253. data/sig/openai/resources/admin/organization/projects/hosted_tool_permissions.rbs +28 -0
  254. data/sig/openai/resources/admin/organization/projects/model_permissions.rbs +30 -0
  255. data/sig/openai/resources/admin/organization/projects/roles.rbs +6 -0
  256. data/sig/openai/resources/admin/organization/projects/service_accounts.rbs +8 -0
  257. data/sig/openai/resources/admin/organization/projects/spend_alerts.rbs +47 -0
  258. data/sig/openai/resources/admin/organization/projects/users/roles.rbs +7 -0
  259. data/sig/openai/resources/admin/organization/projects.rbs +8 -0
  260. data/sig/openai/resources/admin/organization/roles.rbs +5 -0
  261. data/sig/openai/resources/admin/organization/spend_alerts.rbs +41 -0
  262. data/sig/openai/resources/admin/organization/usage.rbs +29 -0
  263. data/sig/openai/resources/admin/organization/users/roles.rbs +6 -0
  264. data/sig/openai/resources/admin/organization.rbs +4 -0
  265. metadata +155 -2
@@ -0,0 +1,889 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Admin
6
+ module Organization
7
+ # @see OpenAI::Resources::Admin::Organization::Usage#file_search_calls
8
+ class UsageFileSearchCallsResponse < OpenAI::Internal::Type::BaseModel
9
+ # @!attribute data
10
+ #
11
+ # @return [Array<OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data>]
12
+ required :data,
13
+ -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data] }
14
+
15
+ # @!attribute has_more
16
+ #
17
+ # @return [Boolean]
18
+ required :has_more, OpenAI::Internal::Type::Boolean
19
+
20
+ # @!attribute next_page
21
+ #
22
+ # @return [String, nil]
23
+ required :next_page, String, nil?: true
24
+
25
+ # @!attribute object
26
+ #
27
+ # @return [Symbol, :page]
28
+ required :object, const: :page
29
+
30
+ # @!method initialize(data:, has_more:, next_page:, object: :page)
31
+ # @param data [Array<OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data>]
32
+ # @param has_more [Boolean]
33
+ # @param next_page [String, nil]
34
+ # @param object [Symbol, :page]
35
+
36
+ class Data < OpenAI::Internal::Type::BaseModel
37
+ # @!attribute end_time
38
+ #
39
+ # @return [Integer]
40
+ required :end_time, Integer
41
+
42
+ # @!attribute object
43
+ #
44
+ # @return [Symbol, :bucket]
45
+ required :object, const: :bucket
46
+
47
+ # @!attribute results
48
+ #
49
+ # @return [Array<OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageVectorStoresResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageFileSearchesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult>]
50
+ required :results,
51
+ -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result] }
52
+
53
+ # @!attribute start_time
54
+ #
55
+ # @return [Integer]
56
+ required :start_time, Integer
57
+
58
+ # @!method initialize(end_time:, results:, start_time:, object: :bucket)
59
+ # @param end_time [Integer]
60
+ # @param results [Array<OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageVectorStoresResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageFileSearchesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult>]
61
+ # @param start_time [Integer]
62
+ # @param object [Symbol, :bucket]
63
+
64
+ # The aggregated completions usage details of the specific time bucket.
65
+ module Result
66
+ extend OpenAI::Internal::Type::Union
67
+
68
+ discriminator :object
69
+
70
+ # The aggregated completions usage details of the specific time bucket.
71
+ variant :"organization.usage.completions.result",
72
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult }
73
+
74
+ # The aggregated embeddings usage details of the specific time bucket.
75
+ variant :"organization.usage.embeddings.result",
76
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageEmbeddingsResult }
77
+
78
+ # The aggregated moderations usage details of the specific time bucket.
79
+ variant :"organization.usage.moderations.result",
80
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageModerationsResult }
81
+
82
+ # The aggregated images usage details of the specific time bucket.
83
+ variant :"organization.usage.images.result",
84
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageImagesResult }
85
+
86
+ # The aggregated audio speeches usage details of the specific time bucket.
87
+ variant :"organization.usage.audio_speeches.result",
88
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioSpeechesResult }
89
+
90
+ # The aggregated audio transcriptions usage details of the specific time bucket.
91
+ variant :"organization.usage.audio_transcriptions.result",
92
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult }
93
+
94
+ # The aggregated vector stores usage details of the specific time bucket.
95
+ variant :"organization.usage.vector_stores.result",
96
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageVectorStoresResult }
97
+
98
+ # The aggregated code interpreter sessions usage details of the specific time bucket.
99
+ variant :"organization.usage.code_interpreter_sessions.result",
100
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult }
101
+
102
+ # The aggregated file search calls usage details of the specific time bucket.
103
+ variant :"organization.usage.file_searches.result",
104
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageFileSearchesResult }
105
+
106
+ # The aggregated web search calls usage details of the specific time bucket.
107
+ variant :"organization.usage.web_searches.result",
108
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult }
109
+
110
+ # The aggregated costs details of the specific time bucket.
111
+ variant :"organization.costs.result",
112
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult }
113
+
114
+ class OrganizationUsageCompletionsResult < OpenAI::Internal::Type::BaseModel
115
+ # @!attribute input_tokens
116
+ # The aggregated number of text input tokens used, including cached tokens. For
117
+ # customers subscribe to scale tier, this includes scale tier tokens.
118
+ #
119
+ # @return [Integer]
120
+ required :input_tokens, Integer
121
+
122
+ # @!attribute num_model_requests
123
+ # The count of requests made to the model.
124
+ #
125
+ # @return [Integer]
126
+ required :num_model_requests, Integer
127
+
128
+ # @!attribute object
129
+ #
130
+ # @return [Symbol, :"organization.usage.completions.result"]
131
+ required :object, const: :"organization.usage.completions.result"
132
+
133
+ # @!attribute output_tokens
134
+ # The aggregated number of text output tokens used. For customers subscribe to
135
+ # scale tier, this includes scale tier tokens.
136
+ #
137
+ # @return [Integer]
138
+ required :output_tokens, Integer
139
+
140
+ # @!attribute api_key_id
141
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
142
+ # usage result.
143
+ #
144
+ # @return [String, nil]
145
+ optional :api_key_id, String, nil?: true
146
+
147
+ # @!attribute batch
148
+ # When `group_by=batch`, this field tells whether the grouped usage result is
149
+ # batch or not.
150
+ #
151
+ # @return [Boolean, nil]
152
+ optional :batch, OpenAI::Internal::Type::Boolean, nil?: true
153
+
154
+ # @!attribute input_audio_tokens
155
+ # The aggregated number of audio input tokens used, including cached tokens.
156
+ #
157
+ # @return [Integer, nil]
158
+ optional :input_audio_tokens, Integer
159
+
160
+ # @!attribute input_cached_tokens
161
+ # The aggregated number of text input tokens that has been cached from previous
162
+ # requests. For customers subscribe to scale tier, this includes scale tier
163
+ # tokens.
164
+ #
165
+ # @return [Integer, nil]
166
+ optional :input_cached_tokens, Integer
167
+
168
+ # @!attribute model
169
+ # When `group_by=model`, this field provides the model name of the grouped usage
170
+ # result.
171
+ #
172
+ # @return [String, nil]
173
+ optional :model, String, nil?: true
174
+
175
+ # @!attribute output_audio_tokens
176
+ # The aggregated number of audio output tokens used.
177
+ #
178
+ # @return [Integer, nil]
179
+ optional :output_audio_tokens, Integer
180
+
181
+ # @!attribute project_id
182
+ # When `group_by=project_id`, this field provides the project ID of the grouped
183
+ # usage result.
184
+ #
185
+ # @return [String, nil]
186
+ optional :project_id, String, nil?: true
187
+
188
+ # @!attribute service_tier
189
+ # When `group_by=service_tier`, this field provides the service tier of the
190
+ # grouped usage result.
191
+ #
192
+ # @return [String, nil]
193
+ optional :service_tier, String, nil?: true
194
+
195
+ # @!attribute user_id
196
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
197
+ # result.
198
+ #
199
+ # @return [String, nil]
200
+ optional :user_id, String, nil?: true
201
+
202
+ # @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cached_tokens: nil, model: nil, output_audio_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
203
+ # Some parameter documentations has been truncated, see
204
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult}
205
+ # for more details.
206
+ #
207
+ # The aggregated completions usage details of the specific time bucket.
208
+ #
209
+ # @param input_tokens [Integer] The aggregated number of text input tokens used, including cached tokens. For cu
210
+ #
211
+ # @param num_model_requests [Integer] The count of requests made to the model.
212
+ #
213
+ # @param output_tokens [Integer] The aggregated number of text output tokens used. For customers subscribe to sca
214
+ #
215
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
216
+ #
217
+ # @param batch [Boolean, nil] When `group_by=batch`, this field tells whether the grouped usage result is batc
218
+ #
219
+ # @param input_audio_tokens [Integer] The aggregated number of audio input tokens used, including cached tokens.
220
+ #
221
+ # @param input_cached_tokens [Integer] The aggregated number of text input tokens that has been cached from previous re
222
+ #
223
+ # @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
224
+ #
225
+ # @param output_audio_tokens [Integer] The aggregated number of audio output tokens used.
226
+ #
227
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
228
+ #
229
+ # @param service_tier [String, nil] When `group_by=service_tier`, this field provides the service tier of the groupe
230
+ #
231
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
232
+ #
233
+ # @param object [Symbol, :"organization.usage.completions.result"]
234
+ end
235
+
236
+ class OrganizationUsageEmbeddingsResult < OpenAI::Internal::Type::BaseModel
237
+ # @!attribute input_tokens
238
+ # The aggregated number of input tokens used.
239
+ #
240
+ # @return [Integer]
241
+ required :input_tokens, Integer
242
+
243
+ # @!attribute num_model_requests
244
+ # The count of requests made to the model.
245
+ #
246
+ # @return [Integer]
247
+ required :num_model_requests, Integer
248
+
249
+ # @!attribute object
250
+ #
251
+ # @return [Symbol, :"organization.usage.embeddings.result"]
252
+ required :object, const: :"organization.usage.embeddings.result"
253
+
254
+ # @!attribute api_key_id
255
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
256
+ # usage result.
257
+ #
258
+ # @return [String, nil]
259
+ optional :api_key_id, String, nil?: true
260
+
261
+ # @!attribute model
262
+ # When `group_by=model`, this field provides the model name of the grouped usage
263
+ # result.
264
+ #
265
+ # @return [String, nil]
266
+ optional :model, String, nil?: true
267
+
268
+ # @!attribute project_id
269
+ # When `group_by=project_id`, this field provides the project ID of the grouped
270
+ # usage result.
271
+ #
272
+ # @return [String, nil]
273
+ optional :project_id, String, nil?: true
274
+
275
+ # @!attribute user_id
276
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
277
+ # result.
278
+ #
279
+ # @return [String, nil]
280
+ optional :user_id, String, nil?: true
281
+
282
+ # @!method initialize(input_tokens:, num_model_requests:, api_key_id: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.embeddings.result")
283
+ # Some parameter documentations has been truncated, see
284
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageEmbeddingsResult}
285
+ # for more details.
286
+ #
287
+ # The aggregated embeddings usage details of the specific time bucket.
288
+ #
289
+ # @param input_tokens [Integer] The aggregated number of input tokens used.
290
+ #
291
+ # @param num_model_requests [Integer] The count of requests made to the model.
292
+ #
293
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
294
+ #
295
+ # @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
296
+ #
297
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
298
+ #
299
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
300
+ #
301
+ # @param object [Symbol, :"organization.usage.embeddings.result"]
302
+ end
303
+
304
+ class OrganizationUsageModerationsResult < OpenAI::Internal::Type::BaseModel
305
+ # @!attribute input_tokens
306
+ # The aggregated number of input tokens used.
307
+ #
308
+ # @return [Integer]
309
+ required :input_tokens, Integer
310
+
311
+ # @!attribute num_model_requests
312
+ # The count of requests made to the model.
313
+ #
314
+ # @return [Integer]
315
+ required :num_model_requests, Integer
316
+
317
+ # @!attribute object
318
+ #
319
+ # @return [Symbol, :"organization.usage.moderations.result"]
320
+ required :object, const: :"organization.usage.moderations.result"
321
+
322
+ # @!attribute api_key_id
323
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
324
+ # usage result.
325
+ #
326
+ # @return [String, nil]
327
+ optional :api_key_id, String, nil?: true
328
+
329
+ # @!attribute model
330
+ # When `group_by=model`, this field provides the model name of the grouped usage
331
+ # result.
332
+ #
333
+ # @return [String, nil]
334
+ optional :model, String, nil?: true
335
+
336
+ # @!attribute project_id
337
+ # When `group_by=project_id`, this field provides the project ID of the grouped
338
+ # usage result.
339
+ #
340
+ # @return [String, nil]
341
+ optional :project_id, String, nil?: true
342
+
343
+ # @!attribute user_id
344
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
345
+ # result.
346
+ #
347
+ # @return [String, nil]
348
+ optional :user_id, String, nil?: true
349
+
350
+ # @!method initialize(input_tokens:, num_model_requests:, api_key_id: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.moderations.result")
351
+ # Some parameter documentations has been truncated, see
352
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageModerationsResult}
353
+ # for more details.
354
+ #
355
+ # The aggregated moderations usage details of the specific time bucket.
356
+ #
357
+ # @param input_tokens [Integer] The aggregated number of input tokens used.
358
+ #
359
+ # @param num_model_requests [Integer] The count of requests made to the model.
360
+ #
361
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
362
+ #
363
+ # @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
364
+ #
365
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
366
+ #
367
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
368
+ #
369
+ # @param object [Symbol, :"organization.usage.moderations.result"]
370
+ end
371
+
372
+ class OrganizationUsageImagesResult < OpenAI::Internal::Type::BaseModel
373
+ # @!attribute images
374
+ # The number of images processed.
375
+ #
376
+ # @return [Integer]
377
+ required :images, Integer
378
+
379
+ # @!attribute num_model_requests
380
+ # The count of requests made to the model.
381
+ #
382
+ # @return [Integer]
383
+ required :num_model_requests, Integer
384
+
385
+ # @!attribute object
386
+ #
387
+ # @return [Symbol, :"organization.usage.images.result"]
388
+ required :object, const: :"organization.usage.images.result"
389
+
390
+ # @!attribute api_key_id
391
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
392
+ # usage result.
393
+ #
394
+ # @return [String, nil]
395
+ optional :api_key_id, String, nil?: true
396
+
397
+ # @!attribute model
398
+ # When `group_by=model`, this field provides the model name of the grouped usage
399
+ # result.
400
+ #
401
+ # @return [String, nil]
402
+ optional :model, String, nil?: true
403
+
404
+ # @!attribute project_id
405
+ # When `group_by=project_id`, this field provides the project ID of the grouped
406
+ # usage result.
407
+ #
408
+ # @return [String, nil]
409
+ optional :project_id, String, nil?: true
410
+
411
+ # @!attribute size
412
+ # When `group_by=size`, this field provides the image size of the grouped usage
413
+ # result.
414
+ #
415
+ # @return [String, nil]
416
+ optional :size, String, nil?: true
417
+
418
+ # @!attribute source
419
+ # When `group_by=source`, this field provides the source of the grouped usage
420
+ # result, possible values are `image.generation`, `image.edit`, `image.variation`.
421
+ #
422
+ # @return [String, nil]
423
+ optional :source, String, nil?: true
424
+
425
+ # @!attribute user_id
426
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
427
+ # result.
428
+ #
429
+ # @return [String, nil]
430
+ optional :user_id, String, nil?: true
431
+
432
+ # @!method initialize(images:, num_model_requests:, api_key_id: nil, model: nil, project_id: nil, size: nil, source: nil, user_id: nil, object: :"organization.usage.images.result")
433
+ # Some parameter documentations has been truncated, see
434
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageImagesResult}
435
+ # for more details.
436
+ #
437
+ # The aggregated images usage details of the specific time bucket.
438
+ #
439
+ # @param images [Integer] The number of images processed.
440
+ #
441
+ # @param num_model_requests [Integer] The count of requests made to the model.
442
+ #
443
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
444
+ #
445
+ # @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
446
+ #
447
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
448
+ #
449
+ # @param size [String, nil] When `group_by=size`, this field provides the image size of the grouped usage re
450
+ #
451
+ # @param source [String, nil] When `group_by=source`, this field provides the source of the grouped usage resu
452
+ #
453
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
454
+ #
455
+ # @param object [Symbol, :"organization.usage.images.result"]
456
+ end
457
+
458
+ class OrganizationUsageAudioSpeechesResult < OpenAI::Internal::Type::BaseModel
459
+ # @!attribute characters
460
+ # The number of characters processed.
461
+ #
462
+ # @return [Integer]
463
+ required :characters, Integer
464
+
465
+ # @!attribute num_model_requests
466
+ # The count of requests made to the model.
467
+ #
468
+ # @return [Integer]
469
+ required :num_model_requests, Integer
470
+
471
+ # @!attribute object
472
+ #
473
+ # @return [Symbol, :"organization.usage.audio_speeches.result"]
474
+ required :object, const: :"organization.usage.audio_speeches.result"
475
+
476
+ # @!attribute api_key_id
477
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
478
+ # usage result.
479
+ #
480
+ # @return [String, nil]
481
+ optional :api_key_id, String, nil?: true
482
+
483
+ # @!attribute model
484
+ # When `group_by=model`, this field provides the model name of the grouped usage
485
+ # result.
486
+ #
487
+ # @return [String, nil]
488
+ optional :model, String, nil?: true
489
+
490
+ # @!attribute project_id
491
+ # When `group_by=project_id`, this field provides the project ID of the grouped
492
+ # usage result.
493
+ #
494
+ # @return [String, nil]
495
+ optional :project_id, String, nil?: true
496
+
497
+ # @!attribute user_id
498
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
499
+ # result.
500
+ #
501
+ # @return [String, nil]
502
+ optional :user_id, String, nil?: true
503
+
504
+ # @!method initialize(characters:, num_model_requests:, api_key_id: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.audio_speeches.result")
505
+ # Some parameter documentations has been truncated, see
506
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioSpeechesResult}
507
+ # for more details.
508
+ #
509
+ # The aggregated audio speeches usage details of the specific time bucket.
510
+ #
511
+ # @param characters [Integer] The number of characters processed.
512
+ #
513
+ # @param num_model_requests [Integer] The count of requests made to the model.
514
+ #
515
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
516
+ #
517
+ # @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
518
+ #
519
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
520
+ #
521
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
522
+ #
523
+ # @param object [Symbol, :"organization.usage.audio_speeches.result"]
524
+ end
525
+
526
+ class OrganizationUsageAudioTranscriptionsResult < OpenAI::Internal::Type::BaseModel
527
+ # @!attribute num_model_requests
528
+ # The count of requests made to the model.
529
+ #
530
+ # @return [Integer]
531
+ required :num_model_requests, Integer
532
+
533
+ # @!attribute object
534
+ #
535
+ # @return [Symbol, :"organization.usage.audio_transcriptions.result"]
536
+ required :object, const: :"organization.usage.audio_transcriptions.result"
537
+
538
+ # @!attribute seconds
539
+ # The number of seconds processed.
540
+ #
541
+ # @return [Integer]
542
+ required :seconds, Integer
543
+
544
+ # @!attribute api_key_id
545
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
546
+ # usage result.
547
+ #
548
+ # @return [String, nil]
549
+ optional :api_key_id, String, nil?: true
550
+
551
+ # @!attribute model
552
+ # When `group_by=model`, this field provides the model name of the grouped usage
553
+ # result.
554
+ #
555
+ # @return [String, nil]
556
+ optional :model, String, nil?: true
557
+
558
+ # @!attribute project_id
559
+ # When `group_by=project_id`, this field provides the project ID of the grouped
560
+ # usage result.
561
+ #
562
+ # @return [String, nil]
563
+ optional :project_id, String, nil?: true
564
+
565
+ # @!attribute user_id
566
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
567
+ # result.
568
+ #
569
+ # @return [String, nil]
570
+ optional :user_id, String, nil?: true
571
+
572
+ # @!method initialize(num_model_requests:, seconds:, api_key_id: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.audio_transcriptions.result")
573
+ # Some parameter documentations has been truncated, see
574
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult}
575
+ # for more details.
576
+ #
577
+ # The aggregated audio transcriptions usage details of the specific time bucket.
578
+ #
579
+ # @param num_model_requests [Integer] The count of requests made to the model.
580
+ #
581
+ # @param seconds [Integer] The number of seconds processed.
582
+ #
583
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
584
+ #
585
+ # @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
586
+ #
587
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
588
+ #
589
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
590
+ #
591
+ # @param object [Symbol, :"organization.usage.audio_transcriptions.result"]
592
+ end
593
+
594
+ class OrganizationUsageVectorStoresResult < OpenAI::Internal::Type::BaseModel
595
+ # @!attribute object
596
+ #
597
+ # @return [Symbol, :"organization.usage.vector_stores.result"]
598
+ required :object, const: :"organization.usage.vector_stores.result"
599
+
600
+ # @!attribute usage_bytes
601
+ # The vector stores usage in bytes.
602
+ #
603
+ # @return [Integer]
604
+ required :usage_bytes, Integer
605
+
606
+ # @!attribute project_id
607
+ # When `group_by=project_id`, this field provides the project ID of the grouped
608
+ # usage result.
609
+ #
610
+ # @return [String, nil]
611
+ optional :project_id, String, nil?: true
612
+
613
+ # @!method initialize(usage_bytes:, project_id: nil, object: :"organization.usage.vector_stores.result")
614
+ # Some parameter documentations has been truncated, see
615
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageVectorStoresResult}
616
+ # for more details.
617
+ #
618
+ # The aggregated vector stores usage details of the specific time bucket.
619
+ #
620
+ # @param usage_bytes [Integer] The vector stores usage in bytes.
621
+ #
622
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
623
+ #
624
+ # @param object [Symbol, :"organization.usage.vector_stores.result"]
625
+ end
626
+
627
+ class OrganizationUsageCodeInterpreterSessionsResult < OpenAI::Internal::Type::BaseModel
628
+ # @!attribute num_sessions
629
+ # The number of code interpreter sessions.
630
+ #
631
+ # @return [Integer]
632
+ required :num_sessions, Integer
633
+
634
+ # @!attribute object
635
+ #
636
+ # @return [Symbol, :"organization.usage.code_interpreter_sessions.result"]
637
+ required :object, const: :"organization.usage.code_interpreter_sessions.result"
638
+
639
+ # @!attribute project_id
640
+ # When `group_by=project_id`, this field provides the project ID of the grouped
641
+ # usage result.
642
+ #
643
+ # @return [String, nil]
644
+ optional :project_id, String, nil?: true
645
+
646
+ # @!method initialize(num_sessions:, project_id: nil, object: :"organization.usage.code_interpreter_sessions.result")
647
+ # Some parameter documentations has been truncated, see
648
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult}
649
+ # for more details.
650
+ #
651
+ # The aggregated code interpreter sessions usage details of the specific time
652
+ # bucket.
653
+ #
654
+ # @param num_sessions [Integer] The number of code interpreter sessions.
655
+ #
656
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
657
+ #
658
+ # @param object [Symbol, :"organization.usage.code_interpreter_sessions.result"]
659
+ end
660
+
661
+ class OrganizationUsageFileSearchesResult < OpenAI::Internal::Type::BaseModel
662
+ # @!attribute num_requests
663
+ # The count of file search calls.
664
+ #
665
+ # @return [Integer]
666
+ required :num_requests, Integer
667
+
668
+ # @!attribute object
669
+ #
670
+ # @return [Symbol, :"organization.usage.file_searches.result"]
671
+ required :object, const: :"organization.usage.file_searches.result"
672
+
673
+ # @!attribute api_key_id
674
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
675
+ # usage result.
676
+ #
677
+ # @return [String, nil]
678
+ optional :api_key_id, String, nil?: true
679
+
680
+ # @!attribute project_id
681
+ # When `group_by=project_id`, this field provides the project ID of the grouped
682
+ # usage result.
683
+ #
684
+ # @return [String, nil]
685
+ optional :project_id, String, nil?: true
686
+
687
+ # @!attribute user_id
688
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
689
+ # result.
690
+ #
691
+ # @return [String, nil]
692
+ optional :user_id, String, nil?: true
693
+
694
+ # @!attribute vector_store_id
695
+ # When `group_by=vector_store_id`, this field provides the vector store ID of the
696
+ # grouped usage result.
697
+ #
698
+ # @return [String, nil]
699
+ optional :vector_store_id, String, nil?: true
700
+
701
+ # @!method initialize(num_requests:, api_key_id: nil, project_id: nil, user_id: nil, vector_store_id: nil, object: :"organization.usage.file_searches.result")
702
+ # Some parameter documentations has been truncated, see
703
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageFileSearchesResult}
704
+ # for more details.
705
+ #
706
+ # The aggregated file search calls usage details of the specific time bucket.
707
+ #
708
+ # @param num_requests [Integer] The count of file search calls.
709
+ #
710
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
711
+ #
712
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
713
+ #
714
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
715
+ #
716
+ # @param vector_store_id [String, nil] When `group_by=vector_store_id`, this field provides the vector store ID of the
717
+ #
718
+ # @param object [Symbol, :"organization.usage.file_searches.result"]
719
+ end
720
+
721
+ class OrganizationUsageWebSearchesResult < OpenAI::Internal::Type::BaseModel
722
+ # @!attribute num_model_requests
723
+ # The count of model requests.
724
+ #
725
+ # @return [Integer]
726
+ required :num_model_requests, Integer
727
+
728
+ # @!attribute num_requests
729
+ # The count of web search calls.
730
+ #
731
+ # @return [Integer]
732
+ required :num_requests, Integer
733
+
734
+ # @!attribute object
735
+ #
736
+ # @return [Symbol, :"organization.usage.web_searches.result"]
737
+ required :object, const: :"organization.usage.web_searches.result"
738
+
739
+ # @!attribute api_key_id
740
+ # When `group_by=api_key_id`, this field provides the API key ID of the grouped
741
+ # usage result.
742
+ #
743
+ # @return [String, nil]
744
+ optional :api_key_id, String, nil?: true
745
+
746
+ # @!attribute context_level
747
+ # When `group_by=context_level`, this field provides the search context size of
748
+ # the grouped usage result.
749
+ #
750
+ # @return [String, nil]
751
+ optional :context_level, String, nil?: true
752
+
753
+ # @!attribute model
754
+ # When `group_by=model`, this field provides the model name of the grouped usage
755
+ # result.
756
+ #
757
+ # @return [String, nil]
758
+ optional :model, String, nil?: true
759
+
760
+ # @!attribute project_id
761
+ # When `group_by=project_id`, this field provides the project ID of the grouped
762
+ # usage result.
763
+ #
764
+ # @return [String, nil]
765
+ optional :project_id, String, nil?: true
766
+
767
+ # @!attribute user_id
768
+ # When `group_by=user_id`, this field provides the user ID of the grouped usage
769
+ # result.
770
+ #
771
+ # @return [String, nil]
772
+ optional :user_id, String, nil?: true
773
+
774
+ # @!method initialize(num_model_requests:, num_requests:, api_key_id: nil, context_level: nil, model: nil, project_id: nil, user_id: nil, object: :"organization.usage.web_searches.result")
775
+ # Some parameter documentations has been truncated, see
776
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult}
777
+ # for more details.
778
+ #
779
+ # The aggregated web search calls usage details of the specific time bucket.
780
+ #
781
+ # @param num_model_requests [Integer] The count of model requests.
782
+ #
783
+ # @param num_requests [Integer] The count of web search calls.
784
+ #
785
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API key ID of the grouped us
786
+ #
787
+ # @param context_level [String, nil] When `group_by=context_level`, this field provides the search context size of th
788
+ #
789
+ # @param model [String, nil] When `group_by=model`, this field provides the model name of the grouped usage r
790
+ #
791
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped us
792
+ #
793
+ # @param user_id [String, nil] When `group_by=user_id`, this field provides the user ID of the grouped usage re
794
+ #
795
+ # @param object [Symbol, :"organization.usage.web_searches.result"]
796
+ end
797
+
798
+ class OrganizationCostsResult < OpenAI::Internal::Type::BaseModel
799
+ # @!attribute object
800
+ #
801
+ # @return [Symbol, :"organization.costs.result"]
802
+ required :object, const: :"organization.costs.result"
803
+
804
+ # @!attribute amount
805
+ # The monetary value in its associated currency.
806
+ #
807
+ # @return [OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult::Amount, nil]
808
+ optional :amount,
809
+ -> { OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult::Amount }
810
+
811
+ # @!attribute api_key_id
812
+ # When `group_by=api_key_id`, this field provides the API Key ID of the grouped
813
+ # costs result.
814
+ #
815
+ # @return [String, nil]
816
+ optional :api_key_id, String, nil?: true
817
+
818
+ # @!attribute line_item
819
+ # When `group_by=line_item`, this field provides the line item of the grouped
820
+ # costs result.
821
+ #
822
+ # @return [String, nil]
823
+ optional :line_item, String, nil?: true
824
+
825
+ # @!attribute project_id
826
+ # When `group_by=project_id`, this field provides the project ID of the grouped
827
+ # costs result.
828
+ #
829
+ # @return [String, nil]
830
+ optional :project_id, String, nil?: true
831
+
832
+ # @!attribute quantity
833
+ # When `group_by=line_item`, this field provides the quantity of the grouped costs
834
+ # result.
835
+ #
836
+ # @return [Float, nil]
837
+ optional :quantity, Float, nil?: true
838
+
839
+ # @!method initialize(amount: nil, api_key_id: nil, line_item: nil, project_id: nil, quantity: nil, object: :"organization.costs.result")
840
+ # Some parameter documentations has been truncated, see
841
+ # {OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult}
842
+ # for more details.
843
+ #
844
+ # The aggregated costs details of the specific time bucket.
845
+ #
846
+ # @param amount [OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult::Amount] The monetary value in its associated currency.
847
+ #
848
+ # @param api_key_id [String, nil] When `group_by=api_key_id`, this field provides the API Key ID of the grouped co
849
+ #
850
+ # @param line_item [String, nil] When `group_by=line_item`, this field provides the line item of the grouped cost
851
+ #
852
+ # @param project_id [String, nil] When `group_by=project_id`, this field provides the project ID of the grouped co
853
+ #
854
+ # @param quantity [Float, nil] When `group_by=line_item`, this field provides the quantity of the grouped costs
855
+ #
856
+ # @param object [Symbol, :"organization.costs.result"]
857
+
858
+ # @see OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult#amount
859
+ class Amount < OpenAI::Internal::Type::BaseModel
860
+ # @!attribute currency
861
+ # Lowercase ISO-4217 currency e.g. "usd"
862
+ #
863
+ # @return [String, nil]
864
+ optional :currency, String
865
+
866
+ # @!attribute value
867
+ # The numeric value of the cost.
868
+ #
869
+ # @return [Float, nil]
870
+ optional :value, Float
871
+
872
+ # @!method initialize(currency: nil, value: nil)
873
+ # The monetary value in its associated currency.
874
+ #
875
+ # @param currency [String] Lowercase ISO-4217 currency e.g. "usd"
876
+ #
877
+ # @param value [Float] The numeric value of the cost.
878
+ end
879
+ end
880
+
881
+ # @!method self.variants
882
+ # @return [Array(OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageEmbeddingsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageModerationsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageImagesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioSpeechesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageAudioTranscriptionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageVectorStoresResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageCodeInterpreterSessionsResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageFileSearchesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult, OpenAI::Models::Admin::Organization::UsageFileSearchCallsResponse::Data::Result::OrganizationCostsResult)]
883
+ end
884
+ end
885
+ end
886
+ end
887
+ end
888
+ end
889
+ end