context.dev 2.17.0 → 2.18.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 (90) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/models/ai_extract_product_params.rb +28 -1
  5. data/lib/context_dev/models/ai_extract_product_response.rb +51 -1
  6. data/lib/context_dev/models/ai_extract_products_response.rb +51 -1
  7. data/lib/context_dev/models/brand_retrieve_response.rb +65 -65
  8. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +66 -66
  9. data/lib/context_dev/models/industry_retrieve_naics_params.rb +28 -1
  10. data/lib/context_dev/models/industry_retrieve_sic_params.rb +28 -1
  11. data/lib/context_dev/models/parse_handle_params.rb +8 -6
  12. data/lib/context_dev/models/person_enrich_params.rb +28 -1
  13. data/lib/context_dev/models/web_answers_params.rb +28 -1
  14. data/lib/context_dev/models/web_extract_competitors_params.rb +28 -1
  15. data/lib/context_dev/models/web_extract_fonts_params.rb +2 -2
  16. data/lib/context_dev/models/web_extract_params.rb +28 -1
  17. data/lib/context_dev/models/web_extract_styleguide_params.rb +30 -3
  18. data/lib/context_dev/models/web_screenshot_params.rb +10 -8
  19. data/lib/context_dev/models/web_search_params.rb +30 -3
  20. data/lib/context_dev/models/web_search_response.rb +6 -2
  21. data/lib/context_dev/models/web_web_scrape_bytes_params.rb +8 -6
  22. data/lib/context_dev/models/web_web_scrape_html_params.rb +188 -9
  23. data/lib/context_dev/models/web_web_scrape_html_response.rb +41 -1
  24. data/lib/context_dev/models/web_web_scrape_images_params.rb +31 -4
  25. data/lib/context_dev/models/web_web_scrape_md_params.rb +10 -8
  26. data/lib/context_dev/models/web_web_scrape_screenshot_params.rb +471 -0
  27. data/lib/context_dev/models/web_web_scrape_screenshot_response.rb +169 -0
  28. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +8 -6
  29. data/lib/context_dev/models.rb +2 -0
  30. data/lib/context_dev/resources/ai.rb +3 -1
  31. data/lib/context_dev/resources/industry.rb +6 -2
  32. data/lib/context_dev/resources/people.rb +3 -1
  33. data/lib/context_dev/resources/web.rb +96 -13
  34. data/lib/context_dev/version.rb +1 -1
  35. data/lib/context_dev.rb +2 -0
  36. data/rbi/context_dev/models/ai_extract_product_params.rbi +54 -0
  37. data/rbi/context_dev/models/ai_extract_product_response.rbi +98 -3
  38. data/rbi/context_dev/models/ai_extract_products_response.rbi +98 -3
  39. data/rbi/context_dev/models/brand_retrieve_response.rbi +128 -136
  40. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +132 -140
  41. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +59 -0
  42. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +57 -0
  43. data/rbi/context_dev/models/parse_handle_params.rbi +12 -9
  44. data/rbi/context_dev/models/person_enrich_params.rbi +45 -0
  45. data/rbi/context_dev/models/web_answers_params.rbi +45 -0
  46. data/rbi/context_dev/models/web_extract_competitors_params.rbi +59 -0
  47. data/rbi/context_dev/models/web_extract_fonts_params.rbi +3 -3
  48. data/rbi/context_dev/models/web_extract_params.rbi +45 -0
  49. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +62 -3
  50. data/rbi/context_dev/models/web_screenshot_params.rbi +15 -12
  51. data/rbi/context_dev/models/web_search_params.rbi +48 -3
  52. data/rbi/context_dev/models/web_search_response.rbi +4 -2
  53. data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +12 -9
  54. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +485 -12
  55. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +103 -0
  56. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +62 -5
  57. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +15 -12
  58. data/rbi/context_dev/models/web_web_scrape_screenshot_params.rbi +1580 -0
  59. data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi +332 -0
  60. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +12 -9
  61. data/rbi/context_dev/models.rbi +3 -0
  62. data/rbi/context_dev/resources/ai.rbi +7 -0
  63. data/rbi/context_dev/resources/industry.rbi +14 -0
  64. data/rbi/context_dev/resources/parse.rbi +4 -4
  65. data/rbi/context_dev/resources/people.rbi +7 -0
  66. data/rbi/context_dev/resources/web.rbi +173 -21
  67. data/sig/context_dev/models/ai_extract_product_params.rbs +21 -1
  68. data/sig/context_dev/models/ai_extract_product_response.rbs +44 -3
  69. data/sig/context_dev/models/ai_extract_products_response.rbs +44 -3
  70. data/sig/context_dev/models/brand_retrieve_response.rbs +51 -59
  71. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +51 -59
  72. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +21 -1
  73. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +21 -1
  74. data/sig/context_dev/models/person_enrich_params.rbs +21 -1
  75. data/sig/context_dev/models/web_answers_params.rbs +21 -1
  76. data/sig/context_dev/models/web_extract_competitors_params.rbs +21 -1
  77. data/sig/context_dev/models/web_extract_params.rbs +21 -1
  78. data/sig/context_dev/models/web_extract_styleguide_params.rbs +21 -1
  79. data/sig/context_dev/models/web_search_params.rbs +21 -1
  80. data/sig/context_dev/models/web_web_scrape_html_params.rbs +148 -0
  81. data/sig/context_dev/models/web_web_scrape_html_response.rbs +30 -0
  82. data/sig/context_dev/models/web_web_scrape_images_params.rbs +21 -1
  83. data/sig/context_dev/models/web_web_scrape_screenshot_params.rbs +619 -0
  84. data/sig/context_dev/models/web_web_scrape_screenshot_response.rbs +127 -0
  85. data/sig/context_dev/models.rbs +2 -0
  86. data/sig/context_dev/resources/ai.rbs +1 -0
  87. data/sig/context_dev/resources/industry.rbs +2 -0
  88. data/sig/context_dev/resources/people.rbs +1 -0
  89. data/sig/context_dev/resources/web.rbs +24 -0
  90. metadata +8 -2
@@ -106,6 +106,21 @@ module ContextDev
106
106
  sig { returns(T.nilable(Integer)) }
107
107
  attr_accessor :wait_for_ms
108
108
 
109
+ # Set to enabled to bypass shared caches and omit request and response content
110
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
111
+ # omitted. Requires zero data retention to be enabled for your organization
112
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
113
+ # Successful ZDR responses include X-Context-ZDR: true.
114
+ sig do
115
+ returns(T.nilable(ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol))
116
+ end
117
+ attr_reader :zdr
118
+
119
+ sig do
120
+ params(zdr: ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol).void
121
+ end
122
+ attr_writer :zdr
123
+
109
124
  sig do
110
125
  params(
111
126
  url: String,
@@ -128,6 +143,7 @@ module ContextDev
128
143
  timeout_opts:
129
144
  ContextDev::WebWebScrapeImagesParams::TimeoutOpts::OrHash,
130
145
  wait_for_ms: T.nilable(Integer),
146
+ zdr: ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol,
131
147
  request_options: ContextDev::RequestOptions::OrHash
132
148
  ).returns(T.attached_class)
133
149
  end
@@ -165,6 +181,12 @@ module ContextDev
165
181
  # timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000 ms; a
166
182
  # shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
167
183
  wait_for_ms: nil,
184
+ # Set to enabled to bypass shared caches and omit request and response content
185
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
186
+ # omitted. Requires zero data retention to be enabled for your organization
187
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
188
+ # Successful ZDR responses include X-Context-ZDR: true.
189
+ zdr: nil,
168
190
  request_options: {}
169
191
  )
170
192
  end
@@ -191,6 +213,7 @@ module ContextDev
191
213
  tags: T::Array[String],
192
214
  timeout_opts: ContextDev::WebWebScrapeImagesParams::TimeoutOpts,
193
215
  wait_for_ms: T.nilable(Integer),
216
+ zdr: ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol,
194
217
  request_options: ContextDev::RequestOptions
195
218
  }
196
219
  )
@@ -500,7 +523,7 @@ module ContextDev
500
523
  attr_writer :classification
501
524
 
502
525
  # Host materializable images on the Brand.dev CDN and return their URL and MIME
503
- # type.
526
+ # type. Ignored when zero data retention is enabled.
504
527
  sig { returns(T.nilable(T::Boolean)) }
505
528
  attr_reader :hosted_url
506
529
 
@@ -535,7 +558,7 @@ module ContextDev
535
558
  # Classify each image by visual asset type.
536
559
  classification: nil,
537
560
  # Host materializable images on the Brand.dev CDN and return their URL and MIME
538
- # type.
561
+ # type. Ignored when zero data retention is enabled.
539
562
  hosted_url: nil,
540
563
  # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
541
564
  max_time_per_ms: nil,
@@ -575,7 +598,7 @@ module ContextDev
575
598
  # credits. "return-partial" returns usable results collected so far; if none are
576
599
  # available, the request still fails without charging credits. Partial results are
577
600
  # not cached as complete results. "return-partial" requires milliseconds of at
578
- # least 15000.
601
+ # least 5000.
579
602
  sig do
580
603
  returns(
581
604
  T.nilable(
@@ -610,7 +633,7 @@ module ContextDev
610
633
  # credits. "return-partial" returns usable results collected so far; if none are
611
634
  # available, the request still fails without charging credits. Partial results are
612
635
  # not cached as complete results. "return-partial" requires milliseconds of at
613
- # least 15000.
636
+ # least 5000.
614
637
  behavior: nil
615
638
  )
616
639
  end
@@ -631,7 +654,7 @@ module ContextDev
631
654
  # credits. "return-partial" returns usable results collected so far; if none are
632
655
  # available, the request still fails without charging credits. Partial results are
633
656
  # not cached as complete results. "return-partial" requires milliseconds of at
634
- # least 15000.
657
+ # least 5000.
635
658
  module Behavior
636
659
  extend ContextDev::Internal::Type::Enum
637
660
 
@@ -666,6 +689,40 @@ module ContextDev
666
689
  end
667
690
  end
668
691
  end
692
+
693
+ # Set to enabled to bypass shared caches and omit request and response content
694
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
695
+ # omitted. Requires zero data retention to be enabled for your organization
696
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
697
+ # Successful ZDR responses include X-Context-ZDR: true.
698
+ module Zdr
699
+ extend ContextDev::Internal::Type::Enum
700
+
701
+ TaggedSymbol =
702
+ T.type_alias do
703
+ T.all(Symbol, ContextDev::WebWebScrapeImagesParams::Zdr)
704
+ end
705
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
706
+
707
+ ENABLED =
708
+ T.let(
709
+ :enabled,
710
+ ContextDev::WebWebScrapeImagesParams::Zdr::TaggedSymbol
711
+ )
712
+ DISABLED =
713
+ T.let(
714
+ :disabled,
715
+ ContextDev::WebWebScrapeImagesParams::Zdr::TaggedSymbol
716
+ )
717
+
718
+ sig do
719
+ override.returns(
720
+ T::Array[ContextDev::WebWebScrapeImagesParams::Zdr::TaggedSymbol]
721
+ )
722
+ end
723
+ def self.values
724
+ end
725
+ end
669
726
  end
670
727
  end
671
728
  end
@@ -166,9 +166,10 @@ module ContextDev
166
166
  attr_accessor :wait_for_ms
167
167
 
168
168
  # Set to enabled to bypass shared caches and omit request and response content
169
- # from retained usage logs. Requires zero data retention to be enabled for your
170
- # organization (contact support@context.dev), otherwise the request fails with
171
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
169
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
170
+ # omitted. Requires zero data retention to be enabled for your organization
171
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
172
+ # Successful ZDR responses include X-Context-ZDR: true.
172
173
  sig do
173
174
  returns(T.nilable(ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol))
174
175
  end
@@ -272,9 +273,10 @@ module ContextDev
272
273
  # ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
273
274
  wait_for_ms: nil,
274
275
  # Set to enabled to bypass shared caches and omit request and response content
275
- # from retained usage logs. Requires zero data retention to be enabled for your
276
- # organization (contact support@context.dev), otherwise the request fails with
277
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
276
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
277
+ # omitted. Requires zero data retention to be enabled for your organization
278
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
279
+ # Successful ZDR responses include X-Context-ZDR: true.
278
280
  zdr: nil,
279
281
  request_options: {}
280
282
  )
@@ -928,7 +930,7 @@ module ContextDev
928
930
  # credits. "return-partial" returns usable results collected so far; if none are
929
931
  # available, the request still fails without charging credits. Partial results are
930
932
  # not cached as complete results. "return-partial" requires milliseconds of at
931
- # least 15000.
933
+ # least 5000.
932
934
  sig do
933
935
  returns(
934
936
  T.nilable(
@@ -963,7 +965,7 @@ module ContextDev
963
965
  # credits. "return-partial" returns usable results collected so far; if none are
964
966
  # available, the request still fails without charging credits. Partial results are
965
967
  # not cached as complete results. "return-partial" requires milliseconds of at
966
- # least 15000.
968
+ # least 5000.
967
969
  behavior: nil
968
970
  )
969
971
  end
@@ -984,7 +986,7 @@ module ContextDev
984
986
  # credits. "return-partial" returns usable results collected so far; if none are
985
987
  # available, the request still fails without charging credits. Partial results are
986
988
  # not cached as complete results. "return-partial" requires milliseconds of at
987
- # least 15000.
989
+ # least 5000.
988
990
  module Behavior
989
991
  extend ContextDev::Internal::Type::Enum
990
992
 
@@ -1021,9 +1023,10 @@ module ContextDev
1021
1023
  end
1022
1024
 
1023
1025
  # Set to enabled to bypass shared caches and omit request and response content
1024
- # from retained usage logs. Requires zero data retention to be enabled for your
1025
- # organization (contact support@context.dev), otherwise the request fails with
1026
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
1026
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
1027
+ # omitted. Requires zero data retention to be enabled for your organization
1028
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
1029
+ # Successful ZDR responses include X-Context-ZDR: true.
1027
1030
  module Zdr
1028
1031
  extend ContextDev::Internal::Type::Enum
1029
1032