deeprails 0.12.0 → 0.14.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ee919b4b7355075fd7166bd63ffa82cb21d9593633f89ea46f07fc6ea9bba9e5
4
- data.tar.gz: f7571dc221d9b1dfade476d9f82ec5ff6d6ff06210633d2b719c9fb187bb4e0b
3
+ metadata.gz: 99806896169071c14d140375abeb0a52f47dd534ce6a44e7ab1777cedac61b93
4
+ data.tar.gz: f01578bea92921017ae14b31de1ec6cfe1fc52517b9bf54d30579a76ebdcb26b
5
5
  SHA512:
6
- metadata.gz: 66998c7bcb53ee7678e66375b37a9e7f71b0620f2c97891cf3f8f56196a15b3f4fa3f0e159403f7c5c09bd5a3fb36db0310c75137fe6ab9a29b0c535efcf270a
7
- data.tar.gz: 6e8b371ff4bdaa0f8ed19edf9eb833e6a0813f48ea6f5d94d5a033ddd73745d96eac693cf0073d18f907d57790181e2c9b82601e30719e4531bc0131de67ea5d
6
+ metadata.gz: c70ecb016265f68b32180f90059a6f78827abe8152cef709da4721b23c4259cf8a10815f1c9ee8280daacc4b991f73ac486f4b8f4e04ae981b2b4bb2bb01aaeb
7
+ data.tar.gz: 2537fc0e6c4d6ce9bbc326ac803f2885ac048a6290b7bbefdcf16607384920c9987f061986eae7338d230cf1dbe89ecb9bd177e275668b1cc9fb8963a544073d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.14.0 (2025-11-12)
4
+
5
+ Full Changelog: [v0.13.0...v0.14.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.13.0...v0.14.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** remove dev server ([59d5dfb](https://github.com/deeprails/deeprails-ruby-sdk/commit/59d5dfbbae7a7cfc6d5a01893a8397c287f47834))
10
+
11
+ ## 0.13.0 (2025-11-11)
12
+
13
+ Full Changelog: [v0.12.0...v0.13.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.12.0...v0.13.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** add retrieve monitor event and examples ([3179cc0](https://github.com/deeprails/deeprails-ruby-sdk/commit/3179cc06df9d92f96abdb4f162887697e133c688))
18
+
3
19
  ## 0.12.0 (2025-11-10)
4
20
 
5
21
  Full Changelog: [v0.11.0...v0.12.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.11.0...v0.12.0)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "deeprails", "~> 0.12.0"
18
+ gem "deeprails", "~> 0.14.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -33,7 +33,7 @@ deeprails = Deeprails::Client.new(
33
33
  defend_create_response = deeprails.defend.create_workflow(
34
34
  improvement_action: "fixit",
35
35
  name: "Push Alert Workflow",
36
- threshold_type: "automatic",
36
+ threshold_type: "custom",
37
37
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
38
38
  web_search: true
39
39
  )
@@ -50,7 +50,7 @@ begin
50
50
  defend = deeprails.defend.create_workflow(
51
51
  improvement_action: "fixit",
52
52
  name: "Push Alert Workflow",
53
- threshold_type: "automatic",
53
+ threshold_type: "custom",
54
54
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
55
55
  web_search: true
56
56
  )
@@ -99,7 +99,7 @@ deeprails = Deeprails::Client.new(
99
99
  deeprails.defend.create_workflow(
100
100
  improvement_action: "fixit",
101
101
  name: "Push Alert Workflow",
102
- threshold_type: "automatic",
102
+ threshold_type: "custom",
103
103
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
104
104
  web_search: true,
105
105
  request_options: {max_retries: 5}
@@ -120,7 +120,7 @@ deeprails = Deeprails::Client.new(
120
120
  deeprails.defend.create_workflow(
121
121
  improvement_action: "fixit",
122
122
  name: "Push Alert Workflow",
123
- threshold_type: "automatic",
123
+ threshold_type: "custom",
124
124
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
125
125
  web_search: true,
126
126
  request_options: {timeout: 5}
@@ -158,7 +158,7 @@ defend_create_response =
158
158
  deeprails.defend.create_workflow(
159
159
  improvement_action: "fixit",
160
160
  name: "Push Alert Workflow",
161
- threshold_type: "automatic",
161
+ threshold_type: "custom",
162
162
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
163
163
  web_search: true,
164
164
  request_options: {
@@ -209,7 +209,7 @@ You can provide typesafe request parameters like so:
209
209
  deeprails.defend.create_workflow(
210
210
  improvement_action: "fixit",
211
211
  name: "Push Alert Workflow",
212
- threshold_type: "automatic",
212
+ threshold_type: "custom",
213
213
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
214
214
  web_search: true
215
215
  )
@@ -222,7 +222,7 @@ Or, equivalently:
222
222
  deeprails.defend.create_workflow(
223
223
  improvement_action: "fixit",
224
224
  name: "Push Alert Workflow",
225
- threshold_type: "automatic",
225
+ threshold_type: "custom",
226
226
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
227
227
  web_search: true
228
228
  )
@@ -231,7 +231,7 @@ deeprails.defend.create_workflow(
231
231
  params = Deeprails::DefendCreateWorkflowParams.new(
232
232
  improvement_action: "fixit",
233
233
  name: "Push Alert Workflow",
234
- threshold_type: "automatic",
234
+ threshold_type: "custom",
235
235
  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
236
236
  web_search: true
237
237
  )
@@ -4,96 +4,100 @@ module Deeprails
4
4
  module Models
5
5
  # @see Deeprails::Resources::Defend#retrieve_workflow
6
6
  class DefendResponse < Deeprails::Internal::Type::BaseModel
7
- # @!attribute name
8
- # Name of the workflow.
9
- #
10
- # @return [String]
11
- required :name, String
12
-
13
- # @!attribute workflow_id
14
- # A unique workflow ID.
15
- #
16
- # @return [String]
17
- required :workflow_id, String
18
-
19
7
  # @!attribute automatic_hallucination_tolerance_levels
20
8
  # Mapping of guardrail metric names to tolerance values. Values can be strings
21
9
  # (`low`, `medium`, `high`) for automatic tolerance levels.
22
10
  #
23
- # @return [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}, nil]
24
- optional :automatic_hallucination_tolerance_levels,
11
+ # @return [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}]
12
+ required :automatic_hallucination_tolerance_levels,
25
13
  -> { Deeprails::Internal::Type::HashOf[enum: Deeprails::DefendResponse::AutomaticHallucinationToleranceLevel] }
26
14
 
27
15
  # @!attribute capabilities
28
16
  # Extended AI capabilities available to the event, if any. Can be `web_search`
29
17
  # and/or `file_search`.
30
18
  #
31
- # @return [Array<Deeprails::Models::DefendResponse::Capability>, nil]
32
- optional :capabilities, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Capability] }
19
+ # @return [Array<Deeprails::Models::DefendResponse::Capability>]
20
+ required :capabilities, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Capability] }
33
21
 
34
22
  # @!attribute created_at
35
23
  # The time the workflow was created in UTC.
36
24
  #
37
- # @return [Time, nil]
38
- optional :created_at, Time
25
+ # @return [Time]
26
+ required :created_at, Time
39
27
 
40
28
  # @!attribute custom_hallucination_threshold_values
41
29
  # Mapping of guardrail metric names to threshold values. Values can be floating
42
30
  # point numbers (0.0-1.0) for custom thresholds.
43
31
  #
44
- # @return [Hash{Symbol=>Float}, nil]
45
- optional :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
32
+ # @return [Hash{Symbol=>Float}]
33
+ required :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
46
34
 
47
35
  # @!attribute description
48
- # Description for the workflow.
36
+ # A description for the workflow, to help you remember what that workflow means to
37
+ # your organization.
49
38
  #
50
- # @return [String, nil]
51
- optional :description, String
39
+ # @return [String]
40
+ required :description, String
52
41
 
53
42
  # @!attribute events
54
43
  # An array of events associated with this workflow.
55
44
  #
56
- # @return [Array<Deeprails::Models::DefendResponse::Event>, nil]
57
- optional :events, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Event] }
45
+ # @return [Array<Deeprails::Models::DefendResponse::Event>]
46
+ required :events, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Event] }
58
47
 
59
48
  # @!attribute files
60
49
  # List of files associated with the workflow. If this is not empty, models can
61
50
  # search these files when performing evaluations or remediations
62
51
  #
63
- # @return [Array<Deeprails::Models::DefendResponse::File>, nil]
64
- optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::File] }
52
+ # @return [Array<Deeprails::Models::DefendResponse::File>]
53
+ required :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::File] }
65
54
 
66
- # @!attribute stats
55
+ # @!attribute name
56
+ # A human-readable name for the workflow that will correspond to it's workflow ID.
67
57
  #
68
- # @return [Deeprails::Models::DefendResponse::Stats, nil]
69
- optional :stats, -> { Deeprails::DefendResponse::Stats }
58
+ # @return [String]
59
+ required :name, String
70
60
 
71
61
  # @!attribute status
72
62
  # Status of the selected workflow. May be `inactive` or `active`. Inactive
73
63
  # workflows will not accept events.
74
64
  #
75
- # @return [Symbol, Deeprails::Models::DefendResponse::Status, nil]
76
- optional :status, enum: -> { Deeprails::DefendResponse::Status }
65
+ # @return [Symbol, Deeprails::Models::DefendResponse::Status]
66
+ required :status, enum: -> { Deeprails::DefendResponse::Status }
77
67
 
78
68
  # @!attribute threshold_type
79
69
  # Type of thresholds used to evaluate the event.
80
70
  #
81
- # @return [Symbol, Deeprails::Models::DefendResponse::ThresholdType, nil]
82
- optional :threshold_type, enum: -> { Deeprails::DefendResponse::ThresholdType }
71
+ # @return [Symbol, Deeprails::Models::DefendResponse::ThresholdType]
72
+ required :threshold_type, enum: -> { Deeprails::DefendResponse::ThresholdType }
83
73
 
84
74
  # @!attribute updated_at
85
75
  # The most recent time the workflow was updated in UTC.
86
76
  #
87
- # @return [Time, nil]
88
- optional :updated_at, Time
77
+ # @return [Time]
78
+ required :updated_at, Time
89
79
 
90
- # @!method initialize(name:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, created_at: nil, custom_hallucination_threshold_values: nil, description: nil, events: nil, files: nil, stats: nil, status: nil, threshold_type: nil, updated_at: nil)
91
- # Some parameter documentations has been truncated, see
92
- # {Deeprails::Models::DefendResponse} for more details.
80
+ # @!attribute workflow_id
81
+ # A unique workflow ID.
93
82
  #
94
- # @param name [String] Name of the workflow.
83
+ # @return [String]
84
+ required :workflow_id, String
85
+
86
+ # @!attribute improvement_action
87
+ # The action used to improve outputs that fail one or more guardrail metrics for
88
+ # the workflow events.
95
89
  #
96
- # @param workflow_id [String] A unique workflow ID.
90
+ # @return [Symbol, Deeprails::Models::DefendResponse::ImprovementAction, nil]
91
+ optional :improvement_action, enum: -> { Deeprails::DefendResponse::ImprovementAction }
92
+
93
+ # @!attribute stats
94
+ #
95
+ # @return [Deeprails::Models::DefendResponse::Stats, nil]
96
+ optional :stats, -> { Deeprails::DefendResponse::Stats }
97
+
98
+ # @!method initialize(automatic_hallucination_tolerance_levels:, capabilities:, created_at:, custom_hallucination_threshold_values:, description:, events:, files:, name:, status:, threshold_type:, updated_at:, workflow_id:, improvement_action: nil, stats: nil)
99
+ # Some parameter documentations has been truncated, see
100
+ # {Deeprails::Models::DefendResponse} for more details.
97
101
  #
98
102
  # @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metric names to tolerance values. Values can be strings (`l
99
103
  #
@@ -103,19 +107,25 @@ module Deeprails
103
107
  #
104
108
  # @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metric names to threshold values. Values can be floating po
105
109
  #
106
- # @param description [String] Description for the workflow.
110
+ # @param description [String] A description for the workflow, to help you remember what that workflow means to
107
111
  #
108
112
  # @param events [Array<Deeprails::Models::DefendResponse::Event>] An array of events associated with this workflow.
109
113
  #
110
114
  # @param files [Array<Deeprails::Models::DefendResponse::File>] List of files associated with the workflow. If this is not empty, models can sea
111
115
  #
112
- # @param stats [Deeprails::Models::DefendResponse::Stats]
116
+ # @param name [String] A human-readable name for the workflow that will correspond to it's workflow ID.
113
117
  #
114
118
  # @param status [Symbol, Deeprails::Models::DefendResponse::Status] Status of the selected workflow. May be `inactive` or `active`. Inactive workf
115
119
  #
116
120
  # @param threshold_type [Symbol, Deeprails::Models::DefendResponse::ThresholdType] Type of thresholds used to evaluate the event.
117
121
  #
118
122
  # @param updated_at [Time] The most recent time the workflow was updated in UTC.
123
+ #
124
+ # @param workflow_id [String] A unique workflow ID.
125
+ #
126
+ # @param improvement_action [Symbol, Deeprails::Models::DefendResponse::ImprovementAction] The action used to improve outputs that fail one or more guardrail metrics for t
127
+ #
128
+ # @param stats [Deeprails::Models::DefendResponse::Stats]
119
129
 
120
130
  module AutomaticHallucinationToleranceLevel
121
131
  extend Deeprails::Internal::Type::Enum
@@ -303,6 +313,48 @@ module Deeprails
303
313
  # @param file_size [Integer]
304
314
  end
305
315
 
316
+ # Status of the selected workflow. May be `inactive` or `active`. Inactive
317
+ # workflows will not accept events.
318
+ #
319
+ # @see Deeprails::Models::DefendResponse#status
320
+ module Status
321
+ extend Deeprails::Internal::Type::Enum
322
+
323
+ INACTIVE = :inactive
324
+ ACTIVE = :active
325
+
326
+ # @!method self.values
327
+ # @return [Array<Symbol>]
328
+ end
329
+
330
+ # Type of thresholds used to evaluate the event.
331
+ #
332
+ # @see Deeprails::Models::DefendResponse#threshold_type
333
+ module ThresholdType
334
+ extend Deeprails::Internal::Type::Enum
335
+
336
+ CUSTOM = :custom
337
+ AUTOMATIC = :automatic
338
+
339
+ # @!method self.values
340
+ # @return [Array<Symbol>]
341
+ end
342
+
343
+ # The action used to improve outputs that fail one or more guardrail metrics for
344
+ # the workflow events.
345
+ #
346
+ # @see Deeprails::Models::DefendResponse#improvement_action
347
+ module ImprovementAction
348
+ extend Deeprails::Internal::Type::Enum
349
+
350
+ REGEN = :regen
351
+ FIXIT = :fixit
352
+ DO_NOTHING = :do_nothing
353
+
354
+ # @!method self.values
355
+ # @return [Array<Symbol>]
356
+ end
357
+
306
358
  # @see Deeprails::Models::DefendResponse#stats
307
359
  class Stats < Deeprails::Internal::Type::BaseModel
308
360
  # @!attribute outputs_below_threshold
@@ -330,33 +382,6 @@ module Deeprails
330
382
  #
331
383
  # @param outputs_processed [Integer] Total number of AI outputs processed by the workflow.
332
384
  end
333
-
334
- # Status of the selected workflow. May be `inactive` or `active`. Inactive
335
- # workflows will not accept events.
336
- #
337
- # @see Deeprails::Models::DefendResponse#status
338
- module Status
339
- extend Deeprails::Internal::Type::Enum
340
-
341
- INACTIVE = :inactive
342
- ACTIVE = :active
343
-
344
- # @!method self.values
345
- # @return [Array<Symbol>]
346
- end
347
-
348
- # Type of thresholds used to evaluate the event.
349
- #
350
- # @see Deeprails::Models::DefendResponse#threshold_type
351
- module ThresholdType
352
- extend Deeprails::Internal::Type::Enum
353
-
354
- CUSTOM = :custom
355
- AUTOMATIC = :automatic
356
-
357
- # @!method self.values
358
- # @return [Array<Symbol>]
359
- end
360
385
  end
361
386
  end
362
387
  end
@@ -4,109 +4,95 @@ module Deeprails
4
4
  module Models
5
5
  # @see Deeprails::Resources::Monitor#retrieve
6
6
  class MonitorDetailResponse < Deeprails::Internal::Type::BaseModel
7
- # @!attribute monitor_id
8
- # A unique monitor ID.
9
- #
10
- # @return [String]
11
- required :monitor_id, String
12
-
13
- # @!attribute name
14
- # Name of this monitor.
15
- #
16
- # @return [String]
17
- required :name, String
18
-
19
- # @!attribute status
20
- # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
21
- # longer record and evaluate events.
22
- #
23
- # @return [Symbol, Deeprails::Models::MonitorDetailResponse::Status]
24
- required :status, enum: -> { Deeprails::MonitorDetailResponse::Status }
25
-
26
7
  # @!attribute capabilities
27
8
  # An array of capabilities associated with this monitor.
28
9
  #
29
- # @return [Array<Deeprails::Models::MonitorDetailResponse::Capability>, nil]
30
- optional :capabilities,
10
+ # @return [Array<Deeprails::Models::MonitorDetailResponse::Capability>]
11
+ required :capabilities,
31
12
  -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::Capability] }
32
13
 
33
14
  # @!attribute created_at
34
15
  # The time the monitor was created in UTC.
35
16
  #
36
- # @return [Time, nil]
37
- optional :created_at, Time
38
-
39
- # @!attribute description
40
- # Description of this monitor.
41
- #
42
- # @return [String, nil]
43
- optional :description, String
17
+ # @return [Time]
18
+ required :created_at, Time
44
19
 
45
20
  # @!attribute evaluations
46
21
  # An array of all evaluations performed by this monitor. Each one corresponds to a
47
22
  # separate monitor event.
48
23
  #
49
- # @return [Array<Deeprails::Models::MonitorDetailResponse::Evaluation>, nil]
50
- optional :evaluations,
24
+ # @return [Array<Deeprails::Models::MonitorDetailResponse::Evaluation>]
25
+ required :evaluations,
51
26
  -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::Evaluation] }
52
27
 
53
28
  # @!attribute files
54
29
  # An array of files associated with this monitor.
55
30
  #
56
- # @return [Array<Deeprails::Models::MonitorDetailResponse::File>, nil]
57
- optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::File] }
31
+ # @return [Array<Deeprails::Models::MonitorDetailResponse::File>]
32
+ required :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::File] }
33
+
34
+ # @!attribute monitor_id
35
+ # A unique monitor ID.
36
+ #
37
+ # @return [String]
38
+ required :monitor_id, String
39
+
40
+ # @!attribute name
41
+ # Name of this monitor.
42
+ #
43
+ # @return [String]
44
+ required :name, String
58
45
 
59
46
  # @!attribute stats
60
47
  # Contains five fields used for stats of this monitor: total evaluations,
61
48
  # completed evaluations, failed evaluations, queued evaluations, and in progress
62
49
  # evaluations.
63
50
  #
64
- # @return [Deeprails::Models::MonitorDetailResponse::Stats, nil]
65
- optional :stats, -> { Deeprails::MonitorDetailResponse::Stats }
51
+ # @return [Deeprails::Models::MonitorDetailResponse::Stats]
52
+ required :stats, -> { Deeprails::MonitorDetailResponse::Stats }
53
+
54
+ # @!attribute status
55
+ # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
56
+ # longer record and evaluate events.
57
+ #
58
+ # @return [Symbol, Deeprails::Models::MonitorDetailResponse::Status]
59
+ required :status, enum: -> { Deeprails::MonitorDetailResponse::Status }
66
60
 
67
61
  # @!attribute updated_at
68
62
  # The most recent time the monitor was modified in UTC.
69
63
  #
70
- # @return [Time, nil]
71
- optional :updated_at, Time
64
+ # @return [Time]
65
+ required :updated_at, Time
66
+
67
+ # @!attribute description
68
+ # Description of this monitor.
69
+ #
70
+ # @return [String, nil]
71
+ optional :description, String
72
72
 
73
- # @!method initialize(monitor_id:, name:, status:, capabilities: nil, created_at: nil, description: nil, evaluations: nil, files: nil, stats: nil, updated_at: nil)
73
+ # @!method initialize(capabilities:, created_at:, evaluations:, files:, monitor_id:, name:, stats:, status:, updated_at:, description: nil)
74
74
  # Some parameter documentations has been truncated, see
75
75
  # {Deeprails::Models::MonitorDetailResponse} for more details.
76
76
  #
77
- # @param monitor_id [String] A unique monitor ID.
78
- #
79
- # @param name [String] Name of this monitor.
80
- #
81
- # @param status [Symbol, Deeprails::Models::MonitorDetailResponse::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
82
- #
83
77
  # @param capabilities [Array<Deeprails::Models::MonitorDetailResponse::Capability>] An array of capabilities associated with this monitor.
84
78
  #
85
79
  # @param created_at [Time] The time the monitor was created in UTC.
86
80
  #
87
- # @param description [String] Description of this monitor.
88
- #
89
81
  # @param evaluations [Array<Deeprails::Models::MonitorDetailResponse::Evaluation>] An array of all evaluations performed by this monitor. Each one corresponds to
90
82
  #
91
83
  # @param files [Array<Deeprails::Models::MonitorDetailResponse::File>] An array of files associated with this monitor.
92
84
  #
85
+ # @param monitor_id [String] A unique monitor ID.
86
+ #
87
+ # @param name [String] Name of this monitor.
88
+ #
93
89
  # @param stats [Deeprails::Models::MonitorDetailResponse::Stats] Contains five fields used for stats of this monitor: total evaluations, complete
94
90
  #
91
+ # @param status [Symbol, Deeprails::Models::MonitorDetailResponse::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
92
+ #
95
93
  # @param updated_at [Time] The most recent time the monitor was modified in UTC.
96
-
97
- # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
98
- # longer record and evaluate events.
99
94
  #
100
- # @see Deeprails::Models::MonitorDetailResponse#status
101
- module Status
102
- extend Deeprails::Internal::Type::Enum
103
-
104
- ACTIVE = :active
105
- INACTIVE = :inactive
106
-
107
- # @!method self.values
108
- # @return [Array<Symbol>]
109
- end
95
+ # @param description [String] Description of this monitor.
110
96
 
111
97
  class Capability < Deeprails::Internal::Type::BaseModel
112
98
  # @!attribute capability
@@ -372,6 +358,20 @@ module Deeprails
372
358
  #
373
359
  # @param total_evaluations [Integer] Total number of evaluations performed by this monitor.
374
360
  end
361
+
362
+ # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
363
+ # longer record and evaluate events.
364
+ #
365
+ # @see Deeprails::Models::MonitorDetailResponse#status
366
+ module Status
367
+ extend Deeprails::Internal::Type::Enum
368
+
369
+ ACTIVE = :active
370
+ INACTIVE = :inactive
371
+
372
+ # @!method self.values
373
+ # @return [Array<Symbol>]
374
+ end
375
375
  end
376
376
  end
377
377
  end
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Deeprails
4
4
  module Models
5
+ # @see Deeprails::Resources::Monitor#retrieve_event
5
6
  class MonitorEventDetailResponse < Deeprails::Internal::Type::BaseModel
6
7
  # @!attribute capabilities
7
8
  # The capabilities associated with the monitor event.
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Deeprails
4
+ module Models
5
+ # @see Deeprails::Resources::Monitor#retrieve_event
6
+ class MonitorRetrieveEventParams < Deeprails::Internal::Type::BaseModel
7
+ extend Deeprails::Internal::Type::RequestParameters::Converter
8
+ include Deeprails::Internal::Type::RequestParameters
9
+
10
+ # @!attribute monitor_id
11
+ #
12
+ # @return [String]
13
+ required :monitor_id, String
14
+
15
+ # @!method initialize(monitor_id:, request_options: {})
16
+ # @param monitor_id [String]
17
+ # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end