safetykit 0.37.0 → 0.39.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.
@@ -18,511 +18,26 @@ module SafetyKit
18
18
  sig { returns(String) }
19
19
  attr_accessor :namespace
20
20
 
21
- # Schema mapping field names to their definitions. Use content_type to specify
22
- # which fields contain URLs that should be processed (images, videos, or
23
- # websites), datetime fields, or 'metadata' for fields that should be stored but
24
- # not indexed. Use display_hint to provide UI rendering hints.
25
- sig do
26
- returns(
27
- T.nilable(
28
- T::Hash[Symbol, SafetyKit::DataCreateUploadURLParams::Schema]
29
- )
30
- )
31
- end
32
- attr_reader :schema
33
-
34
- sig do
35
- params(
36
- schema:
37
- T::Hash[
38
- Symbol,
39
- SafetyKit::DataCreateUploadURLParams::Schema::OrHash
40
- ]
41
- ).void
42
- end
43
- attr_writer :schema
44
-
45
21
  sig do
46
22
  params(
47
23
  namespace: String,
48
- schema:
49
- T::Hash[
50
- Symbol,
51
- SafetyKit::DataCreateUploadURLParams::Schema::OrHash
52
- ],
53
24
  request_options: SafetyKit::RequestOptions::OrHash
54
25
  ).returns(T.attached_class)
55
26
  end
56
27
  def self.new(
57
28
  # The namespace to ingest data into
58
29
  namespace:,
59
- # Schema mapping field names to their definitions. Use content_type to specify
60
- # which fields contain URLs that should be processed (images, videos, or
61
- # websites), datetime fields, or 'metadata' for fields that should be stored but
62
- # not indexed. Use display_hint to provide UI rendering hints.
63
- schema: nil,
64
30
  request_options: {}
65
31
  )
66
32
  end
67
33
 
68
34
  sig do
69
35
  override.returns(
70
- {
71
- namespace: String,
72
- schema:
73
- T::Hash[Symbol, SafetyKit::DataCreateUploadURLParams::Schema],
74
- request_options: SafetyKit::RequestOptions
75
- }
36
+ { namespace: String, request_options: SafetyKit::RequestOptions }
76
37
  )
77
38
  end
78
39
  def to_hash
79
40
  end
80
-
81
- class Schema < SafetyKit::Internal::Type::BaseModel
82
- OrHash =
83
- T.type_alias do
84
- T.any(
85
- SafetyKit::DataCreateUploadURLParams::Schema,
86
- SafetyKit::Internal::AnyHash
87
- )
88
- end
89
-
90
- # The parent object namespace this field belongs to, creating a parent-child
91
- # relationship with that namespace.
92
- sig { returns(T.nilable(String)) }
93
- attr_reader :belongs_to
94
-
95
- sig { params(belongs_to: String).void }
96
- attr_writer :belongs_to
97
-
98
- # The type of content (image_url, video_url, audio_url, website_url, datetime,
99
- # metadata, or card). When specified as a URL type, SafetyKit will process the
100
- # URL. Use 'metadata' for fields that should be stored but not indexed.
101
- sig do
102
- returns(
103
- T.nilable(
104
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::OrSymbol
105
- )
106
- )
107
- end
108
- attr_reader :content_type
109
-
110
- sig do
111
- params(
112
- content_type:
113
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::OrSymbol
114
- ).void
115
- end
116
- attr_writer :content_type
117
-
118
- # Display hint for UI rendering of this field
119
- sig do
120
- returns(
121
- T.nilable(SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint)
122
- )
123
- end
124
- attr_reader :display_hint
125
-
126
- sig do
127
- params(
128
- display_hint:
129
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::OrHash
130
- ).void
131
- end
132
- attr_writer :display_hint
133
-
134
- # Maximum amount of this field to include when sending to AI models. For text
135
- # fields, this is the character limit. For array fields (e.g. image URLs), this is
136
- # the maximum number of items.
137
- sig { returns(T.nilable(Integer)) }
138
- attr_reader :field_limit
139
-
140
- sig { params(field_limit: Integer).void }
141
- attr_writer :field_limit
142
-
143
- # Optional parser to apply before indexing this field.
144
- sig do
145
- returns(
146
- T.nilable(
147
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::OrSymbol
148
- )
149
- )
150
- end
151
- attr_reader :ingest_as
152
-
153
- sig do
154
- params(
155
- ingest_as:
156
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::OrSymbol
157
- ).void
158
- end
159
- attr_writer :ingest_as
160
-
161
- # Schema definition for a data field
162
- sig do
163
- params(
164
- belongs_to: String,
165
- content_type:
166
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::OrSymbol,
167
- display_hint:
168
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::OrHash,
169
- field_limit: Integer,
170
- ingest_as:
171
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::OrSymbol
172
- ).returns(T.attached_class)
173
- end
174
- def self.new(
175
- # The parent object namespace this field belongs to, creating a parent-child
176
- # relationship with that namespace.
177
- belongs_to: nil,
178
- # The type of content (image_url, video_url, audio_url, website_url, datetime,
179
- # metadata, or card). When specified as a URL type, SafetyKit will process the
180
- # URL. Use 'metadata' for fields that should be stored but not indexed.
181
- content_type: nil,
182
- # Display hint for UI rendering of this field
183
- display_hint: nil,
184
- # Maximum amount of this field to include when sending to AI models. For text
185
- # fields, this is the character limit. For array fields (e.g. image URLs), this is
186
- # the maximum number of items.
187
- field_limit: nil,
188
- # Optional parser to apply before indexing this field.
189
- ingest_as: nil
190
- )
191
- end
192
-
193
- sig do
194
- override.returns(
195
- {
196
- belongs_to: String,
197
- content_type:
198
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::OrSymbol,
199
- display_hint:
200
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint,
201
- field_limit: Integer,
202
- ingest_as:
203
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::OrSymbol
204
- }
205
- )
206
- end
207
- def to_hash
208
- end
209
-
210
- # The type of content (image_url, video_url, audio_url, website_url, datetime,
211
- # metadata, or card). When specified as a URL type, SafetyKit will process the
212
- # URL. Use 'metadata' for fields that should be stored but not indexed.
213
- module ContentType
214
- extend SafetyKit::Internal::Type::Enum
215
-
216
- TaggedSymbol =
217
- T.type_alias do
218
- T.all(
219
- Symbol,
220
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType
221
- )
222
- end
223
- OrSymbol = T.type_alias { T.any(Symbol, String) }
224
-
225
- IMAGE_URL =
226
- T.let(
227
- :image_url,
228
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
229
- )
230
- VIDEO_URL =
231
- T.let(
232
- :video_url,
233
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
234
- )
235
- AUDIO_URL =
236
- T.let(
237
- :audio_url,
238
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
239
- )
240
- WEBSITE_URL =
241
- T.let(
242
- :website_url,
243
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
244
- )
245
- DATETIME =
246
- T.let(
247
- :datetime,
248
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
249
- )
250
- METADATA =
251
- T.let(
252
- :metadata,
253
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
254
- )
255
- CARD =
256
- T.let(
257
- :card,
258
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
259
- )
260
-
261
- sig do
262
- override.returns(
263
- T::Array[
264
- SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
265
- ]
266
- )
267
- end
268
- def self.values
269
- end
270
- end
271
-
272
- class DisplayHint < SafetyKit::Internal::Type::BaseModel
273
- OrHash =
274
- T.type_alias do
275
- T.any(
276
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint,
277
- SafetyKit::Internal::AnyHash
278
- )
279
- end
280
-
281
- # Hide this field from default UI display.
282
- sig { returns(T.nilable(T::Boolean)) }
283
- attr_reader :hidden
284
-
285
- sig { params(hidden: T::Boolean).void }
286
- attr_writer :hidden
287
-
288
- # Display label to show for this field in the UI
289
- sig { returns(T.nilable(String)) }
290
- attr_reader :name
291
-
292
- sig { params(name: String).void }
293
- attr_writer :name
294
-
295
- # The display hint type
296
- sig do
297
- returns(
298
- T.nilable(
299
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::OrSymbol
300
- )
301
- )
302
- end
303
- attr_reader :type
304
-
305
- sig do
306
- params(
307
- type:
308
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::OrSymbol
309
- ).void
310
- end
311
- attr_writer :type
312
-
313
- # Display hint for UI rendering of this field
314
- sig do
315
- params(
316
- hidden: T::Boolean,
317
- name: String,
318
- type:
319
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::OrSymbol
320
- ).returns(T.attached_class)
321
- end
322
- def self.new(
323
- # Hide this field from default UI display.
324
- hidden: nil,
325
- # Display label to show for this field in the UI
326
- name: nil,
327
- # The display hint type
328
- type: nil
329
- )
330
- end
331
-
332
- sig do
333
- override.returns(
334
- {
335
- hidden: T::Boolean,
336
- name: String,
337
- type:
338
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::OrSymbol
339
- }
340
- )
341
- end
342
- def to_hash
343
- end
344
-
345
- # The display hint type
346
- module Type
347
- extend SafetyKit::Internal::Type::Enum
348
-
349
- TaggedSymbol =
350
- T.type_alias do
351
- T.all(
352
- Symbol,
353
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type
354
- )
355
- end
356
- OrSymbol = T.type_alias { T.any(Symbol, String) }
357
-
358
- TITLE =
359
- T.let(
360
- :title,
361
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
362
- )
363
- SUBTITLE =
364
- T.let(
365
- :subtitle,
366
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
367
- )
368
- CATEGORY =
369
- T.let(
370
- :category,
371
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
372
- )
373
- IDENTIFIER =
374
- T.let(
375
- :identifier,
376
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
377
- )
378
- CANONICAL_URL =
379
- T.let(
380
- :canonical_url,
381
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
382
- )
383
- STATUS =
384
- T.let(
385
- :status,
386
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
387
- )
388
- PRIMARY_TAG_SET =
389
- T.let(
390
- :primary_tag_set,
391
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
392
- )
393
- TAG_SET =
394
- T.let(
395
- :tag_set,
396
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
397
- )
398
- TIMESTAMP =
399
- T.let(
400
- :timestamp,
401
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
402
- )
403
- RATING =
404
- T.let(
405
- :rating,
406
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
407
- )
408
- SUMMARY =
409
- T.let(
410
- :summary,
411
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
412
- )
413
- PROFILE_IMAGE =
414
- T.let(
415
- :profile_image,
416
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
417
- )
418
- PRIMARY_IMAGE =
419
- T.let(
420
- :primary_image,
421
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
422
- )
423
- IMAGE_SET =
424
- T.let(
425
- :image_set,
426
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
427
- )
428
- VIDEO_SET =
429
- T.let(
430
- :video_set,
431
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
432
- )
433
- AUDIO_SET =
434
- T.let(
435
- :audio_set,
436
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
437
- )
438
- BODY =
439
- T.let(
440
- :body,
441
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
442
- )
443
- THREAD =
444
- T.let(
445
- :thread,
446
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
447
- )
448
- MESSAGE =
449
- T.let(
450
- :message,
451
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
452
- )
453
- PROFILE =
454
- T.let(
455
- :profile,
456
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
457
- )
458
- MONEY =
459
- T.let(
460
- :money,
461
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
462
- )
463
- LOCATION =
464
- T.let(
465
- :location,
466
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
467
- )
468
- ATTRIBUTE_GROUP =
469
- T.let(
470
- :attribute_group,
471
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
472
- )
473
- ATTRIBUTE =
474
- T.let(
475
- :attribute,
476
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
477
- )
478
-
479
- sig do
480
- override.returns(
481
- T::Array[
482
- SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
483
- ]
484
- )
485
- end
486
- def self.values
487
- end
488
- end
489
- end
490
-
491
- # Optional parser to apply before indexing this field.
492
- module IngestAs
493
- extend SafetyKit::Internal::Type::Enum
494
-
495
- TaggedSymbol =
496
- T.type_alias do
497
- T.all(
498
- Symbol,
499
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs
500
- )
501
- end
502
- OrSymbol = T.type_alias { T.any(Symbol, String) }
503
-
504
- FLOAT =
505
- T.let(
506
- :float,
507
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::TaggedSymbol
508
- )
509
- DATETIME =
510
- T.let(
511
- :datetime,
512
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::TaggedSymbol
513
- )
514
-
515
- sig do
516
- override.returns(
517
- T::Array[
518
- SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::TaggedSymbol
519
- ]
520
- )
521
- end
522
- def self.values
523
- end
524
- end
525
- end
526
41
  end
527
42
  end
528
43
  end
@@ -21,8 +21,6 @@ module SafetyKit
21
21
 
22
22
  DataObject = SafetyKit::Models::DataObject
23
23
 
24
- DataUpdateSettingsParams = SafetyKit::Models::DataUpdateSettingsParams
25
-
26
24
  DeletionRequestCreateParams = SafetyKit::Models::DeletionRequestCreateParams
27
25
 
28
26
  StreamAddFrameParams = SafetyKit::Models::StreamAddFrameParams
@@ -33,22 +33,12 @@ module SafetyKit
33
33
  sig do
34
34
  params(
35
35
  namespace: String,
36
- schema:
37
- T::Hash[
38
- Symbol,
39
- SafetyKit::DataCreateUploadURLParams::Schema::OrHash
40
- ],
41
36
  request_options: SafetyKit::RequestOptions::OrHash
42
37
  ).returns(SafetyKit::Models::DataCreateUploadURLResponse)
43
38
  end
44
39
  def create_upload_url(
45
40
  # The namespace to ingest data into
46
41
  namespace,
47
- # Schema mapping field names to their definitions. Use content_type to specify
48
- # which fields contain URLs that should be processed (images, videos, or
49
- # websites), datetime fields, or 'metadata' for fields that should be stored but
50
- # not indexed. Use display_hint to provide UI rendering hints.
51
- schema: nil,
52
42
  request_options: {}
53
43
  )
54
44
  end
@@ -92,31 +82,6 @@ module SafetyKit
92
82
  )
93
83
  end
94
84
 
95
- # Create or replace settings for a namespace, primarily used to change the schema
96
- # associated with the namespace.
97
- sig do
98
- params(
99
- namespace: String,
100
- schema:
101
- T::Hash[
102
- Symbol,
103
- SafetyKit::DataUpdateSettingsParams::Schema::OrHash
104
- ],
105
- request_options: SafetyKit::RequestOptions::OrHash
106
- ).returns(SafetyKit::Models::DataUpdateSettingsResponse)
107
- end
108
- def update_settings(
109
- # The namespace to ingest data into
110
- namespace,
111
- # Schema mapping field names to their definitions. Use content_type to specify
112
- # which fields contain URLs that should be processed (images, videos, or
113
- # websites), datetime fields, or 'metadata' for fields that should be stored but
114
- # not indexed. Use display_hint to provide UI rendering hints.
115
- schema:,
116
- request_options: {}
117
- )
118
- end
119
-
120
85
  # @api private
121
86
  sig { params(client: SafetyKit::Client).returns(T.attached_class) }
122
87
  def self.new(client:)