context.dev 2.8.0 → 2.10.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 (116) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +10 -0
  5. data/lib/context_dev/models/batch_delete_params.rb +22 -0
  6. data/lib/context_dev/models/batch_delete_response.rb +60 -0
  7. data/lib/context_dev/models/batch_get_results_response.rb +46 -4
  8. data/lib/context_dev/models/batch_list_response.rb +13 -4
  9. data/lib/context_dev/models/batch_retrieve_response.rb +13 -4
  10. data/lib/context_dev/models/batch_submit_params.rb +2080 -26
  11. data/lib/context_dev/models/batch_submit_response.rb +125 -531
  12. data/lib/context_dev/models/brand_retrieve_response.rb +50 -1
  13. data/lib/context_dev/models/brand_search_params.rb +41 -3
  14. data/lib/context_dev/models/brand_search_response.rb +3 -2
  15. data/lib/context_dev/models/crawl_controls.rb +21 -15
  16. data/lib/context_dev/models/news_search_params.rb +467 -0
  17. data/lib/context_dev/models/news_search_response.rb +238 -0
  18. data/lib/context_dev/models/parse_handle_params.rb +20 -147
  19. data/lib/context_dev/models/person_enrich_params.rb +176 -0
  20. data/lib/context_dev/models/person_enrich_response.rb +641 -0
  21. data/lib/context_dev/models/utility_prefetch_params.rb +19 -16
  22. data/lib/context_dev/models/utility_prefetch_response.rb +4 -5
  23. data/lib/context_dev/models/web_screenshot_params.rb +3 -30
  24. data/lib/context_dev/models/web_search_response.rb +1 -0
  25. data/lib/context_dev/models/web_web_crawl_md_params.rb +5 -4
  26. data/lib/context_dev/models/web_web_crawl_md_response.rb +30 -1
  27. data/lib/context_dev/models/web_web_scrape_html_params.rb +20 -156
  28. data/lib/context_dev/models/web_web_scrape_html_response.rb +30 -1
  29. data/lib/context_dev/models/web_web_scrape_images_params.rb +12 -124
  30. data/lib/context_dev/models/web_web_scrape_md_params.rb +40 -241
  31. data/lib/context_dev/models/web_web_scrape_md_response.rb +41 -2
  32. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +11 -1
  33. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +3 -2
  34. data/lib/context_dev/models.rb +6 -0
  35. data/lib/context_dev/resources/batch.rb +33 -7
  36. data/lib/context_dev/resources/brand.rb +10 -10
  37. data/lib/context_dev/resources/news.rb +51 -0
  38. data/lib/context_dev/resources/parse.rb +5 -5
  39. data/lib/context_dev/resources/people.rb +56 -0
  40. data/lib/context_dev/resources/utility.rb +7 -6
  41. data/lib/context_dev/resources/web.rb +46 -24
  42. data/lib/context_dev/version.rb +1 -1
  43. data/lib/context_dev.rb +8 -0
  44. data/rbi/context_dev/client.rbi +8 -0
  45. data/rbi/context_dev/models/batch_delete_params.rbi +40 -0
  46. data/rbi/context_dev/models/batch_delete_response.rbi +116 -0
  47. data/rbi/context_dev/models/batch_get_results_response.rbi +85 -3
  48. data/rbi/context_dev/models/batch_list_response.rbi +24 -8
  49. data/rbi/context_dev/models/batch_retrieve_response.rbi +24 -8
  50. data/rbi/context_dev/models/batch_submit_params.rbi +6421 -44
  51. data/rbi/context_dev/models/batch_submit_response.rbi +184 -1151
  52. data/rbi/context_dev/models/brand_retrieve_response.rbi +152 -0
  53. data/rbi/context_dev/models/brand_search_params.rbi +71 -2
  54. data/rbi/context_dev/models/brand_search_response.rbi +4 -2
  55. data/rbi/context_dev/models/crawl_controls.rbi +22 -28
  56. data/rbi/context_dev/models/news_search_params.rbi +1294 -0
  57. data/rbi/context_dev/models/news_search_response.rbi +423 -0
  58. data/rbi/context_dev/models/parse_handle_params.rbi +30 -323
  59. data/rbi/context_dev/models/person_enrich_params.rbi +332 -0
  60. data/rbi/context_dev/models/person_enrich_response.rbi +1295 -0
  61. data/rbi/context_dev/models/utility_prefetch_params.rbi +24 -16
  62. data/rbi/context_dev/models/utility_prefetch_response.rbi +8 -6
  63. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -71
  64. data/rbi/context_dev/models/web_search_response.rbi +5 -0
  65. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +8 -6
  66. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +67 -0
  67. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +30 -363
  68. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +65 -0
  69. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +16 -287
  70. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +57 -558
  71. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +80 -0
  72. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +15 -0
  73. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +4 -2
  74. data/rbi/context_dev/models.rbi +6 -0
  75. data/rbi/context_dev/resources/batch.rbi +32 -10
  76. data/rbi/context_dev/resources/brand.rbi +14 -8
  77. data/rbi/context_dev/resources/news.rbi +46 -0
  78. data/rbi/context_dev/resources/parse.rbi +10 -26
  79. data/rbi/context_dev/resources/people.rbi +47 -0
  80. data/rbi/context_dev/resources/utility.rbi +8 -6
  81. data/rbi/context_dev/resources/web.rbi +49 -66
  82. data/sig/context_dev/client.rbs +4 -0
  83. data/sig/context_dev/models/batch_delete_params.rbs +23 -0
  84. data/sig/context_dev/models/batch_delete_response.rbs +57 -0
  85. data/sig/context_dev/models/batch_get_results_response.rbs +30 -2
  86. data/sig/context_dev/models/batch_list_response.rbs +16 -2
  87. data/sig/context_dev/models/batch_retrieve_response.rbs +16 -2
  88. data/sig/context_dev/models/batch_submit_params.rbs +2666 -15
  89. data/sig/context_dev/models/batch_submit_response.rbs +78 -466
  90. data/sig/context_dev/models/brand_retrieve_response.rbs +62 -0
  91. data/sig/context_dev/models/brand_search_params.rbs +38 -1
  92. data/sig/context_dev/models/crawl_controls.rbs +16 -16
  93. data/sig/context_dev/models/news_search_params.rbs +532 -0
  94. data/sig/context_dev/models/news_search_response.rbs +206 -0
  95. data/sig/context_dev/models/parse_handle_params.rbs +25 -90
  96. data/sig/context_dev/models/person_enrich_params.rbs +199 -0
  97. data/sig/context_dev/models/person_enrich_response.rbs +638 -0
  98. data/sig/context_dev/models/utility_prefetch_params.rbs +2 -1
  99. data/sig/context_dev/models/utility_prefetch_response.rbs +2 -1
  100. data/sig/context_dev/models/web_screenshot_params.rbs +5 -18
  101. data/sig/context_dev/models/web_search_response.rbs +2 -0
  102. data/sig/context_dev/models/web_web_crawl_md_response.rbs +21 -0
  103. data/sig/context_dev/models/web_web_scrape_html_params.rbs +24 -94
  104. data/sig/context_dev/models/web_web_scrape_html_response.rbs +21 -0
  105. data/sig/context_dev/models/web_web_scrape_images_params.rbs +20 -72
  106. data/sig/context_dev/models/web_web_scrape_md_params.rbs +46 -148
  107. data/sig/context_dev/models/web_web_scrape_md_response.rbs +28 -0
  108. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +7 -0
  109. data/sig/context_dev/models.rbs +6 -0
  110. data/sig/context_dev/resources/batch.rbs +8 -2
  111. data/sig/context_dev/resources/brand.rbs +3 -0
  112. data/sig/context_dev/resources/news.rbs +17 -0
  113. data/sig/context_dev/resources/parse.rbs +5 -5
  114. data/sig/context_dev/resources/people.rbs +19 -0
  115. data/sig/context_dev/resources/web.rbs +13 -11
  116. metadata +26 -2
@@ -36,71 +36,28 @@ module ContextDev
36
36
  attr_writer :extension
37
37
 
38
38
  # Include image references in Markdown output
39
- sig do
40
- returns(
41
- T.nilable(
42
- T.any(
43
- T::Boolean,
44
- ContextDev::ParseHandleParams::IncludeImages::OrSymbol
45
- )
46
- )
47
- )
48
- end
39
+ sig { returns(T.nilable(T::Boolean)) }
49
40
  attr_reader :include_images
50
41
 
51
- sig do
52
- params(
53
- include_images:
54
- T.any(
55
- T::Boolean,
56
- ContextDev::ParseHandleParams::IncludeImages::OrSymbol
57
- )
58
- ).void
59
- end
42
+ sig { params(include_images: T::Boolean).void }
60
43
  attr_writer :include_images
61
44
 
62
45
  # Preserve hyperlinks in Markdown output
63
- sig do
64
- returns(
65
- T.nilable(
66
- T.any(
67
- T::Boolean,
68
- ContextDev::ParseHandleParams::IncludeLinks::OrSymbol
69
- )
70
- )
71
- )
72
- end
46
+ sig { returns(T.nilable(T::Boolean)) }
73
47
  attr_reader :include_links
74
48
 
75
- sig do
76
- params(
77
- include_links:
78
- T.any(
79
- T::Boolean,
80
- ContextDev::ParseHandleParams::IncludeLinks::OrSymbol
81
- )
82
- ).void
83
- end
49
+ sig { params(include_links: T::Boolean).void }
84
50
  attr_writer :include_links
85
51
 
86
- # When true for PDF inputs, detect and OCR images embedded in the selected pages,
87
- # inserting recognized text at each image's position in page reading order while
88
- # preserving the PDF text layer. pdf.start/pdf.end limit the inclusive page range.
89
- # When false, all OCR is disabled, including the automatic scanned-PDF fallback.
90
- sig do
91
- returns(
92
- T.nilable(
93
- T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::OrSymbol)
94
- )
95
- )
96
- end
52
+ # When true for PDF inputs, OCR the selected pages that have no usable text layer
53
+ # (scans), replacing each recovered page's text with the OCR result while pages
54
+ # with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
55
+ # range. Billed at 1 credit per page OCR actually recovered, on top of the base
56
+ # request cost. When false, no OCR runs.
57
+ sig { returns(T.nilable(T::Boolean)) }
97
58
  attr_reader :ocr
98
59
 
99
- sig do
100
- params(
101
- ocr: T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::OrSymbol)
102
- ).void
103
- end
60
+ sig { params(ocr: T::Boolean).void }
104
61
  attr_writer :ocr
105
62
 
106
63
  # PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
@@ -111,27 +68,10 @@ module ContextDev
111
68
  attr_writer :pdf
112
69
 
113
70
  # Shorten base64-encoded image data in the Markdown output
114
- sig do
115
- returns(
116
- T.nilable(
117
- T.any(
118
- T::Boolean,
119
- ContextDev::ParseHandleParams::ShortenBase64Images::OrSymbol
120
- )
121
- )
122
- )
123
- end
71
+ sig { returns(T.nilable(T::Boolean)) }
124
72
  attr_reader :shorten_base64_images
125
73
 
126
- sig do
127
- params(
128
- shorten_base64_images:
129
- T.any(
130
- T::Boolean,
131
- ContextDev::ParseHandleParams::ShortenBase64Images::OrSymbol
132
- )
133
- ).void
134
- end
74
+ sig { params(shorten_base64_images: T::Boolean).void }
135
75
  attr_writer :shorten_base64_images
136
76
 
137
77
  # Optional comma-separated caller-defined tags for tracking this request. Tags are
@@ -144,27 +84,10 @@ module ContextDev
144
84
  attr_writer :tags
145
85
 
146
86
  # Extract only the main content from HTML-like inputs
147
- sig do
148
- returns(
149
- T.nilable(
150
- T.any(
151
- T::Boolean,
152
- ContextDev::ParseHandleParams::UseMainContentOnly::OrSymbol
153
- )
154
- )
155
- )
156
- end
87
+ sig { returns(T.nilable(T::Boolean)) }
157
88
  attr_reader :use_main_content_only
158
89
 
159
- sig do
160
- params(
161
- use_main_content_only:
162
- T.any(
163
- T::Boolean,
164
- ContextDev::ParseHandleParams::UseMainContentOnly::OrSymbol
165
- )
166
- ).void
167
- end
90
+ sig { params(use_main_content_only: T::Boolean).void }
168
91
  attr_writer :use_main_content_only
169
92
 
170
93
  # Set to enabled to bypass shared caches and omit request and response content
@@ -182,29 +105,13 @@ module ContextDev
182
105
  body: ContextDev::Internal::FileInput,
183
106
  client: String,
184
107
  extension: ContextDev::ParseHandleParams::Extension::OrSymbol,
185
- include_images:
186
- T.any(
187
- T::Boolean,
188
- ContextDev::ParseHandleParams::IncludeImages::OrSymbol
189
- ),
190
- include_links:
191
- T.any(
192
- T::Boolean,
193
- ContextDev::ParseHandleParams::IncludeLinks::OrSymbol
194
- ),
195
- ocr: T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::OrSymbol),
108
+ include_images: T::Boolean,
109
+ include_links: T::Boolean,
110
+ ocr: T::Boolean,
196
111
  pdf: ContextDev::ParseHandleParams::Pdf::OrHash,
197
- shorten_base64_images:
198
- T.any(
199
- T::Boolean,
200
- ContextDev::ParseHandleParams::ShortenBase64Images::OrSymbol
201
- ),
112
+ shorten_base64_images: T::Boolean,
202
113
  tags: T::Array[String],
203
- use_main_content_only:
204
- T.any(
205
- T::Boolean,
206
- ContextDev::ParseHandleParams::UseMainContentOnly::OrSymbol
207
- ),
114
+ use_main_content_only: T::Boolean,
208
115
  zdr: ContextDev::ParseHandleParams::Zdr::OrSymbol,
209
116
  request_options: ContextDev::RequestOptions::OrHash
210
117
  ).returns(T.attached_class)
@@ -220,10 +127,11 @@ module ContextDev
220
127
  include_images: nil,
221
128
  # Preserve hyperlinks in Markdown output
222
129
  include_links: nil,
223
- # When true for PDF inputs, detect and OCR images embedded in the selected pages,
224
- # inserting recognized text at each image's position in page reading order while
225
- # preserving the PDF text layer. pdf.start/pdf.end limit the inclusive page range.
226
- # When false, all OCR is disabled, including the automatic scanned-PDF fallback.
130
+ # When true for PDF inputs, OCR the selected pages that have no usable text layer
131
+ # (scans), replacing each recovered page's text with the OCR result while pages
132
+ # with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
133
+ # range. Billed at 1 credit per page OCR actually recovered, on top of the base
134
+ # request cost. When false, no OCR runs.
227
135
  ocr: nil,
228
136
  # PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
229
137
  pdf: nil,
@@ -250,30 +158,13 @@ module ContextDev
250
158
  body: ContextDev::Internal::FileInput,
251
159
  client: String,
252
160
  extension: ContextDev::ParseHandleParams::Extension::OrSymbol,
253
- include_images:
254
- T.any(
255
- T::Boolean,
256
- ContextDev::ParseHandleParams::IncludeImages::OrSymbol
257
- ),
258
- include_links:
259
- T.any(
260
- T::Boolean,
261
- ContextDev::ParseHandleParams::IncludeLinks::OrSymbol
262
- ),
263
- ocr:
264
- T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::OrSymbol),
161
+ include_images: T::Boolean,
162
+ include_links: T::Boolean,
163
+ ocr: T::Boolean,
265
164
  pdf: ContextDev::ParseHandleParams::Pdf,
266
- shorten_base64_images:
267
- T.any(
268
- T::Boolean,
269
- ContextDev::ParseHandleParams::ShortenBase64Images::OrSymbol
270
- ),
165
+ shorten_base64_images: T::Boolean,
271
166
  tags: T::Array[String],
272
- use_main_content_only:
273
- T.any(
274
- T::Boolean,
275
- ContextDev::ParseHandleParams::UseMainContentOnly::OrSymbol
276
- ),
167
+ use_main_content_only: T::Boolean,
277
168
  zdr: ContextDev::ParseHandleParams::Zdr::OrSymbol,
278
169
  request_options: ContextDev::RequestOptions
279
170
  }
@@ -440,110 +331,6 @@ module ContextDev
440
331
  end
441
332
  end
442
333
 
443
- # Include image references in Markdown output
444
- module IncludeImages
445
- extend ContextDev::Internal::Type::Union
446
-
447
- Variants =
448
- T.type_alias do
449
- T.any(
450
- T::Boolean,
451
- ContextDev::ParseHandleParams::IncludeImages::TaggedSymbol
452
- )
453
- end
454
-
455
- sig do
456
- override.returns(
457
- T::Array[ContextDev::ParseHandleParams::IncludeImages::Variants]
458
- )
459
- end
460
- def self.variants
461
- end
462
-
463
- TaggedSymbol =
464
- T.type_alias do
465
- T.all(Symbol, ContextDev::ParseHandleParams::IncludeImages)
466
- end
467
- OrSymbol = T.type_alias { T.any(Symbol, String) }
468
-
469
- TRUE =
470
- T.let(
471
- :true,
472
- ContextDev::ParseHandleParams::IncludeImages::TaggedSymbol
473
- )
474
- FALSE =
475
- T.let(
476
- :false,
477
- ContextDev::ParseHandleParams::IncludeImages::TaggedSymbol
478
- )
479
- end
480
-
481
- # Preserve hyperlinks in Markdown output
482
- module IncludeLinks
483
- extend ContextDev::Internal::Type::Union
484
-
485
- Variants =
486
- T.type_alias do
487
- T.any(
488
- T::Boolean,
489
- ContextDev::ParseHandleParams::IncludeLinks::TaggedSymbol
490
- )
491
- end
492
-
493
- sig do
494
- override.returns(
495
- T::Array[ContextDev::ParseHandleParams::IncludeLinks::Variants]
496
- )
497
- end
498
- def self.variants
499
- end
500
-
501
- TaggedSymbol =
502
- T.type_alias do
503
- T.all(Symbol, ContextDev::ParseHandleParams::IncludeLinks)
504
- end
505
- OrSymbol = T.type_alias { T.any(Symbol, String) }
506
-
507
- TRUE =
508
- T.let(
509
- :true,
510
- ContextDev::ParseHandleParams::IncludeLinks::TaggedSymbol
511
- )
512
- FALSE =
513
- T.let(
514
- :false,
515
- ContextDev::ParseHandleParams::IncludeLinks::TaggedSymbol
516
- )
517
- end
518
-
519
- # When true for PDF inputs, detect and OCR images embedded in the selected pages,
520
- # inserting recognized text at each image's position in page reading order while
521
- # preserving the PDF text layer. pdf.start/pdf.end limit the inclusive page range.
522
- # When false, all OCR is disabled, including the automatic scanned-PDF fallback.
523
- module Ocr
524
- extend ContextDev::Internal::Type::Union
525
-
526
- Variants =
527
- T.type_alias do
528
- T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::TaggedSymbol)
529
- end
530
-
531
- sig do
532
- override.returns(
533
- T::Array[ContextDev::ParseHandleParams::Ocr::Variants]
534
- )
535
- end
536
- def self.variants
537
- end
538
-
539
- TaggedSymbol =
540
- T.type_alias { T.all(Symbol, ContextDev::ParseHandleParams::Ocr) }
541
- OrSymbol = T.type_alias { T.any(Symbol, String) }
542
-
543
- TRUE = T.let(:true, ContextDev::ParseHandleParams::Ocr::TaggedSymbol)
544
- FALSE = T.let(:false, ContextDev::ParseHandleParams::Ocr::TaggedSymbol)
545
- end
546
-
547
334
  class Pdf < ContextDev::Internal::Type::BaseModel
548
335
  OrHash =
549
336
  T.type_alias do
@@ -584,86 +371,6 @@ module ContextDev
584
371
  end
585
372
  end
586
373
 
587
- # Shorten base64-encoded image data in the Markdown output
588
- module ShortenBase64Images
589
- extend ContextDev::Internal::Type::Union
590
-
591
- Variants =
592
- T.type_alias do
593
- T.any(
594
- T::Boolean,
595
- ContextDev::ParseHandleParams::ShortenBase64Images::TaggedSymbol
596
- )
597
- end
598
-
599
- sig do
600
- override.returns(
601
- T::Array[
602
- ContextDev::ParseHandleParams::ShortenBase64Images::Variants
603
- ]
604
- )
605
- end
606
- def self.variants
607
- end
608
-
609
- TaggedSymbol =
610
- T.type_alias do
611
- T.all(Symbol, ContextDev::ParseHandleParams::ShortenBase64Images)
612
- end
613
- OrSymbol = T.type_alias { T.any(Symbol, String) }
614
-
615
- TRUE =
616
- T.let(
617
- :true,
618
- ContextDev::ParseHandleParams::ShortenBase64Images::TaggedSymbol
619
- )
620
- FALSE =
621
- T.let(
622
- :false,
623
- ContextDev::ParseHandleParams::ShortenBase64Images::TaggedSymbol
624
- )
625
- end
626
-
627
- # Extract only the main content from HTML-like inputs
628
- module UseMainContentOnly
629
- extend ContextDev::Internal::Type::Union
630
-
631
- Variants =
632
- T.type_alias do
633
- T.any(
634
- T::Boolean,
635
- ContextDev::ParseHandleParams::UseMainContentOnly::TaggedSymbol
636
- )
637
- end
638
-
639
- sig do
640
- override.returns(
641
- T::Array[
642
- ContextDev::ParseHandleParams::UseMainContentOnly::Variants
643
- ]
644
- )
645
- end
646
- def self.variants
647
- end
648
-
649
- TaggedSymbol =
650
- T.type_alias do
651
- T.all(Symbol, ContextDev::ParseHandleParams::UseMainContentOnly)
652
- end
653
- OrSymbol = T.type_alias { T.any(Symbol, String) }
654
-
655
- TRUE =
656
- T.let(
657
- :true,
658
- ContextDev::ParseHandleParams::UseMainContentOnly::TaggedSymbol
659
- )
660
- FALSE =
661
- T.let(
662
- :false,
663
- ContextDev::ParseHandleParams::UseMainContentOnly::TaggedSymbol
664
- )
665
- end
666
-
667
374
  # Set to enabled to bypass shared caches and omit request and response content
668
375
  # from retained usage logs. Requires zero data retention to be enabled for your
669
376
  # organization (contact support@context.dev), otherwise the request fails with