context.dev 2.4.0 → 2.6.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 (187) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +4 -0
  5. data/lib/context_dev/models/ai_extract_product_params.rb +9 -1
  6. data/lib/context_dev/models/ai_extract_products_params.rb +18 -2
  7. data/lib/context_dev/models/batch_cancel_params.rb +22 -0
  8. data/lib/context_dev/models/batch_cancel_response.rb +354 -0
  9. data/lib/context_dev/models/batch_get_results_params.rb +42 -0
  10. data/lib/context_dev/models/batch_get_results_response.rb +463 -0
  11. data/lib/context_dev/models/batch_list_params.rb +94 -0
  12. data/lib/context_dev/models/batch_list_response.rb +388 -0
  13. data/lib/context_dev/models/batch_retrieve_params.rb +22 -0
  14. data/lib/context_dev/models/batch_retrieve_response.rb +390 -0
  15. data/lib/context_dev/models/batch_submit_params.rb +56 -0
  16. data/lib/context_dev/models/batch_submit_response.rb +614 -0
  17. data/lib/context_dev/models/brand_retrieve_params.rb +109 -22
  18. data/lib/context_dev/models/brand_retrieve_response.rb +4 -6
  19. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +32 -3
  20. data/lib/context_dev/models/error.rb +26 -0
  21. data/lib/context_dev/models/error_count.rb +26 -0
  22. data/lib/context_dev/models/industry_retrieve_naics_params.rb +11 -1
  23. data/lib/context_dev/models/industry_retrieve_sic_params.rb +11 -1
  24. data/lib/context_dev/models/monitor_create_params.rb +147 -132
  25. data/lib/context_dev/models/monitor_create_response.rb +40 -15
  26. data/lib/context_dev/models/monitor_get_credit_usage_params.rb +30 -0
  27. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +59 -0
  28. data/lib/context_dev/models/monitor_get_limits_params.rb +14 -0
  29. data/lib/context_dev/models/monitor_get_limits_response.rb +52 -0
  30. data/lib/context_dev/models/monitor_list_account_changes_params.rb +16 -7
  31. data/lib/context_dev/models/monitor_list_account_changes_response.rb +2 -1
  32. data/lib/context_dev/models/monitor_list_account_runs_params.rb +7 -10
  33. data/lib/context_dev/models/monitor_list_changes_params.rb +8 -4
  34. data/lib/context_dev/models/monitor_list_changes_response.rb +2 -1
  35. data/lib/context_dev/models/monitor_list_params.rb +18 -19
  36. data/lib/context_dev/models/monitor_list_response.rb +27 -12
  37. data/lib/context_dev/models/monitor_list_runs_params.rb +7 -10
  38. data/lib/context_dev/models/monitor_retrieve_change_response.rb +2 -1
  39. data/lib/context_dev/models/monitor_retrieve_response.rb +27 -12
  40. data/lib/context_dev/models/monitor_update_params.rb +27 -12
  41. data/lib/context_dev/models/monitor_update_response.rb +27 -12
  42. data/lib/context_dev/models/parse_handle_params.rb +199 -33
  43. data/lib/context_dev/models/utility_prefetch_params.rb +9 -1
  44. data/lib/context_dev/models/web_extract_competitors_params.rb +11 -1
  45. data/lib/context_dev/models/web_extract_fonts_params.rb +14 -4
  46. data/lib/context_dev/models/web_extract_params.rb +19 -1
  47. data/lib/context_dev/models/web_extract_styleguide_params.rb +14 -4
  48. data/lib/context_dev/models/web_screenshot_params.rb +69 -18
  49. data/lib/context_dev/models/web_screenshot_response.rb +3 -2
  50. data/lib/context_dev/models/web_search_params.rb +9 -1
  51. data/lib/context_dev/models/web_web_crawl_md_params.rb +34 -1
  52. data/lib/context_dev/models/web_web_scrape_html_params.rb +268 -29
  53. data/lib/context_dev/models/web_web_scrape_html_response.rb +93 -1
  54. data/lib/context_dev/models/web_web_scrape_images_params.rb +208 -19
  55. data/lib/context_dev/models/web_web_scrape_md_params.rb +352 -38
  56. data/lib/context_dev/models/web_web_scrape_md_response.rb +93 -1
  57. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +45 -1
  58. data/lib/context_dev/models.rb +18 -0
  59. data/lib/context_dev/resources/ai.rb +3 -1
  60. data/lib/context_dev/resources/batch.rb +155 -0
  61. data/lib/context_dev/resources/brand.rb +6 -2
  62. data/lib/context_dev/resources/industry.rb +6 -2
  63. data/lib/context_dev/resources/monitors.rb +75 -37
  64. data/lib/context_dev/resources/parse.rb +15 -11
  65. data/lib/context_dev/resources/utility.rb +3 -1
  66. data/lib/context_dev/resources/web.rb +104 -55
  67. data/lib/context_dev/version.rb +1 -1
  68. data/lib/context_dev.rb +17 -0
  69. data/rbi/context_dev/client.rbi +3 -0
  70. data/rbi/context_dev/models/ai_extract_product_params.rbi +11 -0
  71. data/rbi/context_dev/models/ai_extract_products_params.rbi +22 -0
  72. data/rbi/context_dev/models/batch_cancel_params.rbi +40 -0
  73. data/rbi/context_dev/models/batch_cancel_response.rbi +642 -0
  74. data/rbi/context_dev/models/batch_get_results_params.rbi +70 -0
  75. data/rbi/context_dev/models/batch_get_results_response.rbi +848 -0
  76. data/rbi/context_dev/models/batch_list_params.rbi +166 -0
  77. data/rbi/context_dev/models/batch_list_response.rbi +738 -0
  78. data/rbi/context_dev/models/batch_retrieve_params.rbi +40 -0
  79. data/rbi/context_dev/models/batch_retrieve_response.rbi +707 -0
  80. data/rbi/context_dev/models/batch_submit_params.rbi +105 -0
  81. data/rbi/context_dev/models/batch_submit_response.rbi +1330 -0
  82. data/rbi/context_dev/models/brand_retrieve_params.rbi +175 -64
  83. data/rbi/context_dev/models/brand_retrieve_response.rbi +8 -11
  84. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +68 -5
  85. data/rbi/context_dev/models/error.rbi +32 -0
  86. data/rbi/context_dev/models/error_count.rbi +34 -0
  87. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +15 -0
  88. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +15 -0
  89. data/rbi/context_dev/models/monitor_create_params.rbi +280 -246
  90. data/rbi/context_dev/models/monitor_create_response.rbi +44 -11
  91. data/rbi/context_dev/models/monitor_get_credit_usage_params.rbi +60 -0
  92. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +111 -0
  93. data/rbi/context_dev/models/monitor_get_limits_params.rbi +30 -0
  94. data/rbi/context_dev/models/monitor_get_limits_response.rbi +105 -0
  95. data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +16 -0
  96. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +2 -0
  97. data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +7 -6
  98. data/rbi/context_dev/models/monitor_list_changes_params.rbi +8 -0
  99. data/rbi/context_dev/models/monitor_list_changes_response.rbi +2 -0
  100. data/rbi/context_dev/models/monitor_list_params.rbi +23 -31
  101. data/rbi/context_dev/models/monitor_list_response.rbi +30 -9
  102. data/rbi/context_dev/models/monitor_list_runs_params.rbi +7 -6
  103. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +2 -0
  104. data/rbi/context_dev/models/monitor_retrieve_response.rbi +30 -9
  105. data/rbi/context_dev/models/monitor_update_params.rbi +30 -9
  106. data/rbi/context_dev/models/monitor_update_response.rbi +30 -9
  107. data/rbi/context_dev/models/parse_handle_params.rbi +400 -46
  108. data/rbi/context_dev/models/utility_prefetch_params.rbi +11 -0
  109. data/rbi/context_dev/models/web_extract_competitors_params.rbi +15 -0
  110. data/rbi/context_dev/models/web_extract_fonts_params.rbi +19 -7
  111. data/rbi/context_dev/models/web_extract_params.rbi +26 -0
  112. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +19 -7
  113. data/rbi/context_dev/models/web_screenshot_params.rbi +108 -37
  114. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -2
  115. data/rbi/context_dev/models/web_search_params.rbi +11 -0
  116. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +53 -0
  117. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +554 -49
  118. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +182 -0
  119. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +426 -30
  120. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +742 -61
  121. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +180 -0
  122. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +82 -0
  123. data/rbi/context_dev/models.rbi +18 -0
  124. data/rbi/context_dev/resources/ai.rbi +3 -0
  125. data/rbi/context_dev/resources/batch.rbi +120 -0
  126. data/rbi/context_dev/resources/brand.rbi +9 -1
  127. data/rbi/context_dev/resources/industry.rbi +10 -0
  128. data/rbi/context_dev/resources/monitors.rbi +67 -23
  129. data/rbi/context_dev/resources/parse.rbi +46 -19
  130. data/rbi/context_dev/resources/utility.rbi +3 -0
  131. data/rbi/context_dev/resources/web.rbi +224 -48
  132. data/sig/context_dev/client.rbs +2 -0
  133. data/sig/context_dev/models/ai_extract_product_params.rbs +12 -1
  134. data/sig/context_dev/models/ai_extract_products_params.rbs +14 -0
  135. data/sig/context_dev/models/batch_cancel_params.rbs +23 -0
  136. data/sig/context_dev/models/batch_cancel_response.rbs +266 -0
  137. data/sig/context_dev/models/batch_get_results_params.rbs +36 -0
  138. data/sig/context_dev/models/batch_get_results_response.rbs +399 -0
  139. data/sig/context_dev/models/batch_list_params.rbs +94 -0
  140. data/sig/context_dev/models/batch_list_response.rbs +304 -0
  141. data/sig/context_dev/models/batch_retrieve_params.rbs +23 -0
  142. data/sig/context_dev/models/batch_retrieve_response.rbs +290 -0
  143. data/sig/context_dev/models/batch_submit_params.rbs +52 -0
  144. data/sig/context_dev/models/batch_submit_response.rbs +542 -0
  145. data/sig/context_dev/models/brand_retrieve_params.rbs +97 -51
  146. data/sig/context_dev/models/brand_retrieve_response.rbs +2 -2
  147. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +34 -5
  148. data/sig/context_dev/models/error.rbs +15 -0
  149. data/sig/context_dev/models/error_count.rbs +15 -0
  150. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +7 -0
  151. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +7 -0
  152. data/sig/context_dev/models/monitor_create_params.rbs +117 -97
  153. data/sig/context_dev/models/monitor_create_response.rbs +18 -1
  154. data/sig/context_dev/models/monitor_get_credit_usage_params.rbs +32 -0
  155. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +52 -0
  156. data/sig/context_dev/models/monitor_get_limits_params.rbs +15 -0
  157. data/sig/context_dev/models/monitor_get_limits_response.rbs +43 -0
  158. data/sig/context_dev/models/monitor_list_params.rbs +8 -14
  159. data/sig/context_dev/models/monitor_list_response.rbs +13 -1
  160. data/sig/context_dev/models/monitor_retrieve_response.rbs +13 -1
  161. data/sig/context_dev/models/monitor_update_params.rbs +13 -1
  162. data/sig/context_dev/models/monitor_update_response.rbs +13 -1
  163. data/sig/context_dev/models/parse_handle_params.rbs +124 -25
  164. data/sig/context_dev/models/utility_prefetch_params.rbs +7 -0
  165. data/sig/context_dev/models/web_extract_competitors_params.rbs +12 -1
  166. data/sig/context_dev/models/web_extract_fonts_params.rbs +10 -5
  167. data/sig/context_dev/models/web_extract_params.rbs +14 -0
  168. data/sig/context_dev/models/web_extract_styleguide_params.rbs +10 -5
  169. data/sig/context_dev/models/web_screenshot_params.rbs +41 -20
  170. data/sig/context_dev/models/web_search_params.rbs +7 -0
  171. data/sig/context_dev/models/web_web_crawl_md_params.rbs +28 -1
  172. data/sig/context_dev/models/web_web_scrape_html_params.rbs +175 -47
  173. data/sig/context_dev/models/web_web_scrape_html_response.rbs +85 -0
  174. data/sig/context_dev/models/web_web_scrape_images_params.rbs +128 -38
  175. data/sig/context_dev/models/web_web_scrape_md_params.rbs +229 -62
  176. data/sig/context_dev/models/web_web_scrape_md_response.rbs +85 -0
  177. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +35 -1
  178. data/sig/context_dev/models.rbs +18 -0
  179. data/sig/context_dev/resources/ai.rbs +1 -0
  180. data/sig/context_dev/resources/batch.rbs +41 -0
  181. data/sig/context_dev/resources/brand.rbs +3 -1
  182. data/sig/context_dev/resources/industry.rbs +2 -0
  183. data/sig/context_dev/resources/monitors.rbs +14 -4
  184. data/sig/context_dev/resources/parse.rbs +8 -5
  185. data/sig/context_dev/resources/utility.rbs +1 -0
  186. data/sig/context_dev/resources/web.rbs +47 -26
  187. metadata +53 -2
@@ -52,6 +52,36 @@ module ContextDev
52
52
  sig { returns(String) }
53
53
  attr_accessor :url
54
54
 
55
+ # One verified outcome per requested browser action, in request order.
56
+ sig do
57
+ returns(
58
+ T.nilable(
59
+ T::Array[
60
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied
61
+ ]
62
+ )
63
+ )
64
+ end
65
+ attr_reader :actions_applied
66
+
67
+ sig do
68
+ params(
69
+ actions_applied:
70
+ T::Array[
71
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::OrHash
72
+ ]
73
+ ).void
74
+ end
75
+ attr_writer :actions_applied
76
+
77
+ # True when an action was applied but the returned content could not be refreshed
78
+ # afterward.
79
+ sig { returns(T.nilable(T::Boolean)) }
80
+ attr_reader :actions_html_stale
81
+
82
+ sig { params(actions_html_stale: T::Boolean).void }
83
+ attr_writer :actions_html_stale
84
+
55
85
  # Metadata about the API key used for the request. Included in every response
56
86
  # whenever a valid API key is provided, even when the response status is not 200.
57
87
  sig do
@@ -78,6 +108,11 @@ module ContextDev
78
108
  ContextDev::Models::WebWebScrapeHTMLResponse::Success::OrBoolean,
79
109
  type: ContextDev::Models::WebWebScrapeHTMLResponse::Type::OrSymbol,
80
110
  url: String,
111
+ actions_applied:
112
+ T::Array[
113
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::OrHash
114
+ ],
115
+ actions_html_stale: T::Boolean,
81
116
  key_metadata:
82
117
  ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata::OrHash
83
118
  ).returns(T.attached_class)
@@ -98,6 +133,11 @@ module ContextDev
98
133
  type:,
99
134
  # The URL that was scraped
100
135
  url:,
136
+ # One verified outcome per requested browser action, in request order.
137
+ actions_applied: nil,
138
+ # True when an action was applied but the returned content could not be refreshed
139
+ # afterward.
140
+ actions_html_stale: nil,
101
141
  # Metadata about the API key used for the request. Included in every response
102
142
  # whenever a valid API key is provided, even when the response status is not 200.
103
143
  key_metadata: nil
@@ -114,6 +154,11 @@ module ContextDev
114
154
  type:
115
155
  ContextDev::Models::WebWebScrapeHTMLResponse::Type::TaggedSymbol,
116
156
  url: String,
157
+ actions_applied:
158
+ T::Array[
159
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied
160
+ ],
161
+ actions_html_stale: T::Boolean,
117
162
  key_metadata:
118
163
  ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata
119
164
  }
@@ -705,6 +750,143 @@ module ContextDev
705
750
  end
706
751
  end
707
752
 
753
+ class ActionsApplied < ContextDev::Internal::Type::BaseModel
754
+ OrHash =
755
+ T.type_alias do
756
+ T.any(
757
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied,
758
+ ContextDev::Internal::AnyHash
759
+ )
760
+ end
761
+
762
+ sig { returns(String) }
763
+ attr_accessor :instruction
764
+
765
+ # Applied means the requested page state was visibly verified. Failed means it was
766
+ # not verified. Skipped means it was not attempted.
767
+ sig do
768
+ returns(
769
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status::TaggedSymbol
770
+ )
771
+ end
772
+ attr_accessor :status
773
+
774
+ # Visible page evidence used to verify an applied action.
775
+ sig { returns(T.nilable(String)) }
776
+ attr_reader :completion_evidence
777
+
778
+ sig { params(completion_evidence: String).void }
779
+ attr_writer :completion_evidence
780
+
781
+ sig { returns(T.nilable(Float)) }
782
+ attr_reader :duration_ms
783
+
784
+ sig { params(duration_ms: Float).void }
785
+ attr_writer :duration_ms
786
+
787
+ sig { returns(T.nilable(String)) }
788
+ attr_reader :error
789
+
790
+ sig { params(error: String).void }
791
+ attr_writer :error
792
+
793
+ sig { returns(T.nilable(String)) }
794
+ attr_reader :method_
795
+
796
+ sig { params(method_: String).void }
797
+ attr_writer :method_
798
+
799
+ sig { returns(T.nilable(String)) }
800
+ attr_reader :target_description
801
+
802
+ sig { params(target_description: String).void }
803
+ attr_writer :target_description
804
+
805
+ sig do
806
+ params(
807
+ instruction: String,
808
+ status:
809
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status::OrSymbol,
810
+ completion_evidence: String,
811
+ duration_ms: Float,
812
+ error: String,
813
+ method_: String,
814
+ target_description: String
815
+ ).returns(T.attached_class)
816
+ end
817
+ def self.new(
818
+ instruction:,
819
+ # Applied means the requested page state was visibly verified. Failed means it was
820
+ # not verified. Skipped means it was not attempted.
821
+ status:,
822
+ # Visible page evidence used to verify an applied action.
823
+ completion_evidence: nil,
824
+ duration_ms: nil,
825
+ error: nil,
826
+ method_: nil,
827
+ target_description: nil
828
+ )
829
+ end
830
+
831
+ sig do
832
+ override.returns(
833
+ {
834
+ instruction: String,
835
+ status:
836
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status::TaggedSymbol,
837
+ completion_evidence: String,
838
+ duration_ms: Float,
839
+ error: String,
840
+ method_: String,
841
+ target_description: String
842
+ }
843
+ )
844
+ end
845
+ def to_hash
846
+ end
847
+
848
+ # Applied means the requested page state was visibly verified. Failed means it was
849
+ # not verified. Skipped means it was not attempted.
850
+ module Status
851
+ extend ContextDev::Internal::Type::Enum
852
+
853
+ TaggedSymbol =
854
+ T.type_alias do
855
+ T.all(
856
+ Symbol,
857
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status
858
+ )
859
+ end
860
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
861
+
862
+ APPLIED =
863
+ T.let(
864
+ :applied,
865
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status::TaggedSymbol
866
+ )
867
+ FAILED =
868
+ T.let(
869
+ :failed,
870
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status::TaggedSymbol
871
+ )
872
+ SKIPPED =
873
+ T.let(
874
+ :skipped,
875
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status::TaggedSymbol
876
+ )
877
+
878
+ sig do
879
+ override.returns(
880
+ T::Array[
881
+ ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status::TaggedSymbol
882
+ ]
883
+ )
884
+ end
885
+ def self.values
886
+ end
887
+ end
888
+ end
889
+
708
890
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
709
891
  OrHash =
710
892
  T.type_alias do