openai 0.10.0 → 0.11.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 (105) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +79 -1
  4. data/lib/openai/client.rb +11 -0
  5. data/lib/openai/errors.rb +3 -0
  6. data/lib/openai/models/all_models.rb +4 -0
  7. data/lib/openai/models/chat/chat_completion.rb +32 -31
  8. data/lib/openai/models/chat/chat_completion_chunk.rb +30 -29
  9. data/lib/openai/models/chat/completion_create_params.rb +34 -31
  10. data/lib/openai/models/images_response.rb +92 -1
  11. data/lib/openai/models/responses/response.rb +59 -35
  12. data/lib/openai/models/responses/response_create_params.rb +64 -39
  13. data/lib/openai/models/responses/response_function_web_search.rb +115 -1
  14. data/lib/openai/models/responses/response_includable.rb +8 -6
  15. data/lib/openai/models/responses/tool_choice_mcp.rb +40 -0
  16. data/lib/openai/models/responses/tool_choice_types.rb +0 -3
  17. data/lib/openai/models/responses_model.rb +4 -0
  18. data/lib/openai/models/webhooks/batch_cancelled_webhook_event.rb +84 -0
  19. data/lib/openai/models/webhooks/batch_completed_webhook_event.rb +84 -0
  20. data/lib/openai/models/webhooks/batch_expired_webhook_event.rb +84 -0
  21. data/lib/openai/models/webhooks/batch_failed_webhook_event.rb +84 -0
  22. data/lib/openai/models/webhooks/eval_run_canceled_webhook_event.rb +84 -0
  23. data/lib/openai/models/webhooks/eval_run_failed_webhook_event.rb +84 -0
  24. data/lib/openai/models/webhooks/eval_run_succeeded_webhook_event.rb +84 -0
  25. data/lib/openai/models/webhooks/fine_tuning_job_cancelled_webhook_event.rb +85 -0
  26. data/lib/openai/models/webhooks/fine_tuning_job_failed_webhook_event.rb +85 -0
  27. data/lib/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rb +85 -0
  28. data/lib/openai/models/webhooks/response_cancelled_webhook_event.rb +85 -0
  29. data/lib/openai/models/webhooks/response_completed_webhook_event.rb +85 -0
  30. data/lib/openai/models/webhooks/response_failed_webhook_event.rb +84 -0
  31. data/lib/openai/models/webhooks/response_incomplete_webhook_event.rb +85 -0
  32. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +59 -0
  33. data/lib/openai/models/webhooks/webhook_unwrap_params.rb +16 -0
  34. data/lib/openai/models.rb +2 -0
  35. data/lib/openai/resources/chat/completions.rb +2 -2
  36. data/lib/openai/resources/responses.rb +14 -6
  37. data/lib/openai/resources/webhooks.rb +124 -0
  38. data/lib/openai/version.rb +1 -1
  39. data/lib/openai.rb +18 -0
  40. data/rbi/openai/client.rbi +3 -0
  41. data/rbi/openai/models/all_models.rbi +20 -0
  42. data/rbi/openai/models/chat/chat_completion.rbi +47 -42
  43. data/rbi/openai/models/chat/chat_completion_chunk.rbi +47 -42
  44. data/rbi/openai/models/chat/completion_create_params.rbi +51 -42
  45. data/rbi/openai/models/images_response.rbi +146 -0
  46. data/rbi/openai/models/responses/response.rbi +75 -44
  47. data/rbi/openai/models/responses/response_create_params.rbi +91 -55
  48. data/rbi/openai/models/responses/response_function_web_search.rbi +163 -0
  49. data/rbi/openai/models/responses/response_includable.rbi +17 -11
  50. data/rbi/openai/models/responses/tool_choice_mcp.rbi +53 -0
  51. data/rbi/openai/models/responses/tool_choice_types.rbi +0 -5
  52. data/rbi/openai/models/responses_model.rbi +20 -0
  53. data/rbi/openai/models/webhooks/batch_cancelled_webhook_event.rbi +154 -0
  54. data/rbi/openai/models/webhooks/batch_completed_webhook_event.rbi +154 -0
  55. data/rbi/openai/models/webhooks/batch_expired_webhook_event.rbi +150 -0
  56. data/rbi/openai/models/webhooks/batch_failed_webhook_event.rbi +149 -0
  57. data/rbi/openai/models/webhooks/eval_run_canceled_webhook_event.rbi +154 -0
  58. data/rbi/openai/models/webhooks/eval_run_failed_webhook_event.rbi +151 -0
  59. data/rbi/openai/models/webhooks/eval_run_succeeded_webhook_event.rbi +154 -0
  60. data/rbi/openai/models/webhooks/fine_tuning_job_cancelled_webhook_event.rbi +158 -0
  61. data/rbi/openai/models/webhooks/fine_tuning_job_failed_webhook_event.rbi +156 -0
  62. data/rbi/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rbi +158 -0
  63. data/rbi/openai/models/webhooks/response_cancelled_webhook_event.rbi +154 -0
  64. data/rbi/openai/models/webhooks/response_completed_webhook_event.rbi +154 -0
  65. data/rbi/openai/models/webhooks/response_failed_webhook_event.rbi +154 -0
  66. data/rbi/openai/models/webhooks/response_incomplete_webhook_event.rbi +155 -0
  67. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +40 -0
  68. data/rbi/openai/models/webhooks/webhook_unwrap_params.rbi +32 -0
  69. data/rbi/openai/models.rbi +2 -0
  70. data/rbi/openai/resources/chat/completions.rbi +34 -30
  71. data/rbi/openai/resources/responses.rbi +62 -38
  72. data/rbi/openai/resources/webhooks.rbi +68 -0
  73. data/sig/openai/client.rbs +2 -0
  74. data/sig/openai/models/all_models.rbs +8 -0
  75. data/sig/openai/models/chat/chat_completion.rbs +2 -1
  76. data/sig/openai/models/chat/chat_completion_chunk.rbs +2 -1
  77. data/sig/openai/models/chat/completion_create_params.rbs +2 -1
  78. data/sig/openai/models/images_response.rbs +83 -0
  79. data/sig/openai/models/responses/response.rbs +13 -1
  80. data/sig/openai/models/responses/response_create_params.rbs +13 -1
  81. data/sig/openai/models/responses/response_function_web_search.rbs +54 -0
  82. data/sig/openai/models/responses/response_includable.rbs +7 -5
  83. data/sig/openai/models/responses/tool_choice_mcp.rbs +23 -0
  84. data/sig/openai/models/responses/tool_choice_types.rbs +0 -2
  85. data/sig/openai/models/responses_model.rbs +8 -0
  86. data/sig/openai/models/webhooks/batch_cancelled_webhook_event.rbs +66 -0
  87. data/sig/openai/models/webhooks/batch_completed_webhook_event.rbs +66 -0
  88. data/sig/openai/models/webhooks/batch_expired_webhook_event.rbs +66 -0
  89. data/sig/openai/models/webhooks/batch_failed_webhook_event.rbs +66 -0
  90. data/sig/openai/models/webhooks/eval_run_canceled_webhook_event.rbs +66 -0
  91. data/sig/openai/models/webhooks/eval_run_failed_webhook_event.rbs +66 -0
  92. data/sig/openai/models/webhooks/eval_run_succeeded_webhook_event.rbs +66 -0
  93. data/sig/openai/models/webhooks/fine_tuning_job_cancelled_webhook_event.rbs +66 -0
  94. data/sig/openai/models/webhooks/fine_tuning_job_failed_webhook_event.rbs +66 -0
  95. data/sig/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rbs +66 -0
  96. data/sig/openai/models/webhooks/response_cancelled_webhook_event.rbs +66 -0
  97. data/sig/openai/models/webhooks/response_completed_webhook_event.rbs +66 -0
  98. data/sig/openai/models/webhooks/response_failed_webhook_event.rbs +66 -0
  99. data/sig/openai/models/webhooks/response_incomplete_webhook_event.rbs +66 -0
  100. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +27 -0
  101. data/sig/openai/models/webhooks/webhook_unwrap_params.rbs +17 -0
  102. data/sig/openai/models.rbs +2 -0
  103. data/sig/openai/resources/responses.rbs +4 -0
  104. data/sig/openai/resources/webhooks.rbs +33 -0
  105. metadata +56 -2
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class BatchCancelledWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the batch API request was cancelled.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::BatchCancelledWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `batch.cancelled`.
27
+ #
28
+ # @return [Symbol, :"batch.cancelled"]
29
+ required :type, const: :"batch.cancelled"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::BatchCancelledWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"batch.cancelled")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::BatchCancelledWebhookEvent} for more details.
40
+ #
41
+ # Sent when a batch API request has been cancelled.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the batch API request was cancelled.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"batch.cancelled"] The type of the event. Always `batch.cancelled`.
52
+
53
+ # @see OpenAI::Models::Webhooks::BatchCancelledWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the batch API request.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::BatchCancelledWebhookEvent::Data} for more details.
64
+ #
65
+ # Event data payload.
66
+ #
67
+ # @param id [String] The unique ID of the batch API request.
68
+ end
69
+
70
+ # The object of the event. Always `event`.
71
+ #
72
+ # @see OpenAI::Models::Webhooks::BatchCancelledWebhookEvent#object
73
+ module Object
74
+ extend OpenAI::Internal::Type::Enum
75
+
76
+ EVENT = :event
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class BatchCompletedWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the batch API request was completed.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::BatchCompletedWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::BatchCompletedWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `batch.completed`.
27
+ #
28
+ # @return [Symbol, :"batch.completed"]
29
+ required :type, const: :"batch.completed"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::BatchCompletedWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"batch.completed")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::BatchCompletedWebhookEvent} for more details.
40
+ #
41
+ # Sent when a batch API request has been completed.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the batch API request was completed.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::BatchCompletedWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"batch.completed"] The type of the event. Always `batch.completed`.
52
+
53
+ # @see OpenAI::Models::Webhooks::BatchCompletedWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the batch API request.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::BatchCompletedWebhookEvent::Data} for more details.
64
+ #
65
+ # Event data payload.
66
+ #
67
+ # @param id [String] The unique ID of the batch API request.
68
+ end
69
+
70
+ # The object of the event. Always `event`.
71
+ #
72
+ # @see OpenAI::Models::Webhooks::BatchCompletedWebhookEvent#object
73
+ module Object
74
+ extend OpenAI::Internal::Type::Enum
75
+
76
+ EVENT = :event
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class BatchExpiredWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the batch API request expired.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::BatchExpiredWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::BatchExpiredWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `batch.expired`.
27
+ #
28
+ # @return [Symbol, :"batch.expired"]
29
+ required :type, const: :"batch.expired"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::BatchExpiredWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"batch.expired")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::BatchExpiredWebhookEvent} for more details.
40
+ #
41
+ # Sent when a batch API request has expired.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the batch API request expired.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::BatchExpiredWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"batch.expired"] The type of the event. Always `batch.expired`.
52
+
53
+ # @see OpenAI::Models::Webhooks::BatchExpiredWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the batch API request.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::BatchExpiredWebhookEvent::Data} for more details.
64
+ #
65
+ # Event data payload.
66
+ #
67
+ # @param id [String] The unique ID of the batch API request.
68
+ end
69
+
70
+ # The object of the event. Always `event`.
71
+ #
72
+ # @see OpenAI::Models::Webhooks::BatchExpiredWebhookEvent#object
73
+ module Object
74
+ extend OpenAI::Internal::Type::Enum
75
+
76
+ EVENT = :event
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class BatchFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the batch API request failed.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::BatchFailedWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::BatchFailedWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `batch.failed`.
27
+ #
28
+ # @return [Symbol, :"batch.failed"]
29
+ required :type, const: :"batch.failed"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::BatchFailedWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::BatchFailedWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"batch.failed")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::BatchFailedWebhookEvent} for more details.
40
+ #
41
+ # Sent when a batch API request has failed.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the batch API request failed.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::BatchFailedWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::BatchFailedWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"batch.failed"] The type of the event. Always `batch.failed`.
52
+
53
+ # @see OpenAI::Models::Webhooks::BatchFailedWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the batch API request.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::BatchFailedWebhookEvent::Data} for more details.
64
+ #
65
+ # Event data payload.
66
+ #
67
+ # @param id [String] The unique ID of the batch API request.
68
+ end
69
+
70
+ # The object of the event. Always `event`.
71
+ #
72
+ # @see OpenAI::Models::Webhooks::BatchFailedWebhookEvent#object
73
+ module Object
74
+ extend OpenAI::Internal::Type::Enum
75
+
76
+ EVENT = :event
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class EvalRunCanceledWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the eval run was canceled.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::EvalRunCanceledWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `eval.run.canceled`.
27
+ #
28
+ # @return [Symbol, :"eval.run.canceled"]
29
+ required :type, const: :"eval.run.canceled"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::EvalRunCanceledWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"eval.run.canceled")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent} for more details.
40
+ #
41
+ # Sent when an eval run has been canceled.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the eval run was canceled.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"eval.run.canceled"] The type of the event. Always `eval.run.canceled`.
52
+
53
+ # @see OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the eval run.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent::Data} for more details.
64
+ #
65
+ # Event data payload.
66
+ #
67
+ # @param id [String] The unique ID of the eval run.
68
+ end
69
+
70
+ # The object of the event. Always `event`.
71
+ #
72
+ # @see OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent#object
73
+ module Object
74
+ extend OpenAI::Internal::Type::Enum
75
+
76
+ EVENT = :event
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class EvalRunFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the eval run failed.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::EvalRunFailedWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `eval.run.failed`.
27
+ #
28
+ # @return [Symbol, :"eval.run.failed"]
29
+ required :type, const: :"eval.run.failed"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::EvalRunFailedWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"eval.run.failed")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent} for more details.
40
+ #
41
+ # Sent when an eval run has failed.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the eval run failed.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"eval.run.failed"] The type of the event. Always `eval.run.failed`.
52
+
53
+ # @see OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the eval run.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent::Data} for more details.
64
+ #
65
+ # Event data payload.
66
+ #
67
+ # @param id [String] The unique ID of the eval run.
68
+ end
69
+
70
+ # The object of the event. Always `event`.
71
+ #
72
+ # @see OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent#object
73
+ module Object
74
+ extend OpenAI::Internal::Type::Enum
75
+
76
+ EVENT = :event
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class EvalRunSucceededWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the eval run succeeded.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::EvalRunSucceededWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `eval.run.succeeded`.
27
+ #
28
+ # @return [Symbol, :"eval.run.succeeded"]
29
+ required :type, const: :"eval.run.succeeded"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::EvalRunSucceededWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"eval.run.succeeded")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent} for more details.
40
+ #
41
+ # Sent when an eval run has succeeded.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the eval run succeeded.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"eval.run.succeeded"] The type of the event. Always `eval.run.succeeded`.
52
+
53
+ # @see OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the eval run.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent::Data} for more details.
64
+ #
65
+ # Event data payload.
66
+ #
67
+ # @param id [String] The unique ID of the eval run.
68
+ end
69
+
70
+ # The object of the event. Always `event`.
71
+ #
72
+ # @see OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent#object
73
+ module Object
74
+ extend OpenAI::Internal::Type::Enum
75
+
76
+ EVENT = :event
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ class FineTuningJobCancelledWebhookEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
15
+ #
16
+ # @return [Integer]
17
+ required :created_at, Integer
18
+
19
+ # @!attribute data
20
+ # Event data payload.
21
+ #
22
+ # @return [OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent::Data]
23
+ required :data, -> { OpenAI::Webhooks::FineTuningJobCancelledWebhookEvent::Data }
24
+
25
+ # @!attribute type
26
+ # The type of the event. Always `fine_tuning.job.cancelled`.
27
+ #
28
+ # @return [Symbol, :"fine_tuning.job.cancelled"]
29
+ required :type, const: :"fine_tuning.job.cancelled"
30
+
31
+ # @!attribute object
32
+ # The object of the event. Always `event`.
33
+ #
34
+ # @return [Symbol, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent::Object, nil]
35
+ optional :object, enum: -> { OpenAI::Webhooks::FineTuningJobCancelledWebhookEvent::Object }
36
+
37
+ # @!method initialize(id:, created_at:, data:, object: nil, type: :"fine_tuning.job.cancelled")
38
+ # Some parameter documentations has been truncated, see
39
+ # {OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent} for more details.
40
+ #
41
+ # Sent when a fine-tuning job has been cancelled.
42
+ #
43
+ # @param id [String] The unique ID of the event.
44
+ #
45
+ # @param created_at [Integer] The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
46
+ #
47
+ # @param data [OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent::Data] Event data payload.
48
+ #
49
+ # @param object [Symbol, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent::Object] The object of the event. Always `event`.
50
+ #
51
+ # @param type [Symbol, :"fine_tuning.job.cancelled"] The type of the event. Always `fine_tuning.job.cancelled`.
52
+
53
+ # @see OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent#data
54
+ class Data < OpenAI::Internal::Type::BaseModel
55
+ # @!attribute id
56
+ # The unique ID of the fine-tuning job.
57
+ #
58
+ # @return [String]
59
+ required :id, String
60
+
61
+ # @!method initialize(id:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent::Data} for more
64
+ # details.
65
+ #
66
+ # Event data payload.
67
+ #
68
+ # @param id [String] The unique ID of the fine-tuning job.
69
+ end
70
+
71
+ # The object of the event. Always `event`.
72
+ #
73
+ # @see OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent#object
74
+ module Object
75
+ extend OpenAI::Internal::Type::Enum
76
+
77
+ EVENT = :event
78
+
79
+ # @!method self.values
80
+ # @return [Array<Symbol>]
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end