context.dev 2.15.0 → 2.16.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 (133) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +2 -2
  4. data/lib/context_dev/client.rb +6 -0
  5. data/lib/context_dev/internal/type/base_model.rb +2 -2
  6. data/lib/context_dev/models/ai_extract_product_response.rb +10 -1
  7. data/lib/context_dev/models/ai_extract_products_response.rb +10 -1
  8. data/lib/context_dev/models/batch_cancel_response.rb +10 -1
  9. data/lib/context_dev/models/batch_delete_response.rb +13 -1
  10. data/lib/context_dev/models/batch_get_results_response.rb +13 -1
  11. data/lib/context_dev/models/batch_list_response.rb +13 -1
  12. data/lib/context_dev/models/batch_retrieve_response.rb +10 -1
  13. data/lib/context_dev/models/batch_submit_response.rb +10 -1
  14. data/lib/context_dev/models/brand_retrieve_response.rb +10 -1
  15. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +10 -1
  16. data/lib/context_dev/models/brand_search_response.rb +10 -1
  17. data/lib/context_dev/models/industry_retrieve_naics_response.rb +13 -1
  18. data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -1
  19. data/lib/context_dev/models/log_list_params.rb +108 -0
  20. data/lib/context_dev/models/log_list_response.rb +174 -0
  21. data/lib/context_dev/models/log_retrieve_params.rb +22 -0
  22. data/lib/context_dev/models/log_retrieve_response.rb +226 -0
  23. data/lib/context_dev/models/news_search_response.rb +10 -1
  24. data/lib/context_dev/models/parse_handle_response.rb +13 -1
  25. data/lib/context_dev/models/person_enrich_response.rb +13 -1
  26. data/lib/context_dev/models/utility_prefetch_response.rb +13 -1
  27. data/lib/context_dev/models/web_extract_competitors_response.rb +13 -1
  28. data/lib/context_dev/models/web_extract_fonts_response.rb +10 -1
  29. data/lib/context_dev/models/web_extract_response.rb +10 -1
  30. data/lib/context_dev/models/web_extract_styleguide_response.rb +10 -1
  31. data/lib/context_dev/models/web_screenshot_params.rb +2 -1
  32. data/lib/context_dev/models/web_screenshot_response.rb +10 -1
  33. data/lib/context_dev/models/web_search_response.rb +10 -1
  34. data/lib/context_dev/models/web_web_crawl_md_response.rb +10 -1
  35. data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -1
  36. data/lib/context_dev/models/web_web_scrape_html_response.rb +10 -1
  37. data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -1
  38. data/lib/context_dev/models/web_web_scrape_images_response.rb +10 -1
  39. data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -1
  40. data/lib/context_dev/models/web_web_scrape_md_response.rb +10 -1
  41. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +10 -1
  42. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +13 -1
  43. data/lib/context_dev/models/webhooks/delivery_list_response.rb +13 -1
  44. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +13 -1
  45. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +13 -1
  46. data/lib/context_dev/models.rb +4 -0
  47. data/lib/context_dev/resources/logs.rb +83 -0
  48. data/lib/context_dev/version.rb +1 -1
  49. data/lib/context_dev.rb +5 -0
  50. data/rbi/context_dev/client.rbi +5 -0
  51. data/rbi/context_dev/models/ai_extract_product_response.rbi +10 -0
  52. data/rbi/context_dev/models/ai_extract_products_response.rbi +10 -0
  53. data/rbi/context_dev/models/batch_cancel_response.rbi +10 -0
  54. data/rbi/context_dev/models/batch_delete_response.rbi +10 -0
  55. data/rbi/context_dev/models/batch_get_results_response.rbi +10 -0
  56. data/rbi/context_dev/models/batch_list_response.rbi +10 -0
  57. data/rbi/context_dev/models/batch_retrieve_response.rbi +10 -0
  58. data/rbi/context_dev/models/batch_submit_response.rbi +10 -0
  59. data/rbi/context_dev/models/brand_retrieve_response.rbi +10 -0
  60. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +10 -0
  61. data/rbi/context_dev/models/brand_search_response.rbi +10 -0
  62. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +10 -0
  63. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +10 -0
  64. data/rbi/context_dev/models/log_list_params.rbi +162 -0
  65. data/rbi/context_dev/models/log_list_response.rbi +246 -0
  66. data/rbi/context_dev/models/log_retrieve_params.rbi +40 -0
  67. data/rbi/context_dev/models/log_retrieve_response.rbi +370 -0
  68. data/rbi/context_dev/models/news_search_response.rbi +10 -0
  69. data/rbi/context_dev/models/parse_handle_response.rbi +10 -0
  70. data/rbi/context_dev/models/person_enrich_response.rbi +10 -0
  71. data/rbi/context_dev/models/utility_prefetch_response.rbi +10 -0
  72. data/rbi/context_dev/models/web_extract_competitors_response.rbi +10 -0
  73. data/rbi/context_dev/models/web_extract_fonts_response.rbi +10 -0
  74. data/rbi/context_dev/models/web_extract_response.rbi +10 -0
  75. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +10 -0
  76. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -2
  77. data/rbi/context_dev/models/web_screenshot_response.rbi +10 -0
  78. data/rbi/context_dev/models/web_search_response.rbi +10 -0
  79. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +10 -0
  80. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +6 -2
  81. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +10 -0
  82. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +6 -2
  83. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +10 -0
  84. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +6 -2
  85. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +10 -0
  86. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +10 -0
  87. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +10 -0
  88. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +10 -0
  89. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +10 -0
  90. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +10 -0
  91. data/rbi/context_dev/models.rbi +4 -0
  92. data/rbi/context_dev/resources/logs.rbi +76 -0
  93. data/rbi/context_dev/resources/web.rbi +11 -4
  94. data/sig/context_dev/client.rbs +2 -0
  95. data/sig/context_dev/models/ai_extract_product_response.rbs +5 -0
  96. data/sig/context_dev/models/ai_extract_products_response.rbs +5 -0
  97. data/sig/context_dev/models/batch_cancel_response.rbs +5 -0
  98. data/sig/context_dev/models/batch_delete_response.rbs +5 -0
  99. data/sig/context_dev/models/batch_get_results_response.rbs +5 -0
  100. data/sig/context_dev/models/batch_list_response.rbs +5 -0
  101. data/sig/context_dev/models/batch_retrieve_response.rbs +5 -0
  102. data/sig/context_dev/models/batch_submit_response.rbs +5 -0
  103. data/sig/context_dev/models/brand_retrieve_response.rbs +5 -0
  104. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +5 -0
  105. data/sig/context_dev/models/brand_search_response.rbs +5 -0
  106. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +5 -0
  107. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +5 -0
  108. data/sig/context_dev/models/log_list_params.rbs +98 -0
  109. data/sig/context_dev/models/log_list_response.rbs +135 -0
  110. data/sig/context_dev/models/log_retrieve_params.rbs +23 -0
  111. data/sig/context_dev/models/log_retrieve_response.rbs +179 -0
  112. data/sig/context_dev/models/news_search_response.rbs +5 -0
  113. data/sig/context_dev/models/parse_handle_response.rbs +5 -0
  114. data/sig/context_dev/models/person_enrich_response.rbs +5 -0
  115. data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
  116. data/sig/context_dev/models/web_extract_competitors_response.rbs +5 -0
  117. data/sig/context_dev/models/web_extract_fonts_response.rbs +5 -0
  118. data/sig/context_dev/models/web_extract_response.rbs +5 -0
  119. data/sig/context_dev/models/web_extract_styleguide_response.rbs +5 -0
  120. data/sig/context_dev/models/web_screenshot_response.rbs +5 -0
  121. data/sig/context_dev/models/web_search_response.rbs +5 -0
  122. data/sig/context_dev/models/web_web_crawl_md_response.rbs +5 -0
  123. data/sig/context_dev/models/web_web_scrape_html_response.rbs +5 -0
  124. data/sig/context_dev/models/web_web_scrape_images_response.rbs +5 -0
  125. data/sig/context_dev/models/web_web_scrape_md_response.rbs +5 -0
  126. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +5 -0
  127. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +5 -0
  128. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +5 -0
  129. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +7 -0
  130. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +5 -0
  131. data/sig/context_dev/models.rbs +4 -0
  132. data/sig/context_dev/resources/logs.rbs +27 -0
  133. metadata +17 -2
@@ -15,6 +15,11 @@ module ContextDev
15
15
  sig { returns(String) }
16
16
  attr_accessor :markdown
17
17
 
18
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
19
+ # it when contacting support about a failed request.
20
+ sig { returns(String) }
21
+ attr_accessor :request_id
22
+
18
23
  # Indicates success
19
24
  sig do
20
25
  returns(ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean)
@@ -44,6 +49,7 @@ module ContextDev
44
49
  sig do
45
50
  params(
46
51
  markdown: String,
52
+ request_id: String,
47
53
  success: ContextDev::Models::ParseHandleResponse::Success::OrBoolean,
48
54
  type: ContextDev::Models::ParseHandleResponse::Type::OrSymbol,
49
55
  key_metadata:
@@ -53,6 +59,9 @@ module ContextDev
53
59
  def self.new(
54
60
  # Input bytes converted to GitHub Flavored Markdown
55
61
  markdown:,
62
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
63
+ # it when contacting support about a failed request.
64
+ request_id:,
56
65
  # Indicates success
57
66
  success:,
58
67
  # Detected content type used for parsing
@@ -66,6 +75,7 @@ module ContextDev
66
75
  override.returns(
67
76
  {
68
77
  markdown: String,
78
+ request_id: String,
69
79
  success:
70
80
  ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean,
71
81
  type: ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol,
@@ -15,6 +15,11 @@ module ContextDev
15
15
  sig { returns(ContextDev::Models::PersonEnrichResponse::Match::Variants) }
16
16
  attr_accessor :match
17
17
 
18
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
19
+ # it when contacting support about a failed request.
20
+ sig { returns(String) }
21
+ attr_accessor :request_id
22
+
18
23
  # Credit usage, included whenever a valid API key is provided.
19
24
  sig do
20
25
  returns(
@@ -38,6 +43,7 @@ module ContextDev
38
43
  ContextDev::Models::PersonEnrichResponse::Match::Candidate::OrHash,
39
44
  ContextDev::Models::PersonEnrichResponse::Match::NotFound::OrHash
40
45
  ),
46
+ request_id: String,
41
47
  key_metadata:
42
48
  ContextDev::Models::PersonEnrichResponse::KeyMetadata::OrHash
43
49
  ).returns(T.attached_class)
@@ -45,6 +51,9 @@ module ContextDev
45
51
  def self.new(
46
52
  # The highest-scoring person candidate.
47
53
  match:,
54
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
55
+ # it when contacting support about a failed request.
56
+ request_id:,
48
57
  # Credit usage, included whenever a valid API key is provided.
49
58
  key_metadata: nil
50
59
  )
@@ -54,6 +63,7 @@ module ContextDev
54
63
  override.returns(
55
64
  {
56
65
  match: ContextDev::Models::PersonEnrichResponse::Match::Variants,
66
+ request_id: String,
57
67
  key_metadata: ContextDev::Models::PersonEnrichResponse::KeyMetadata
58
68
  }
59
69
  )
@@ -11,6 +11,11 @@ module ContextDev
11
11
  )
12
12
  end
13
13
 
14
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
15
+ # it when contacting support about a failed request.
16
+ sig { returns(String) }
17
+ attr_accessor :request_id
18
+
14
19
  # The domain that was queued for prefetching
15
20
  sig { returns(T.nilable(String)) }
16
21
  attr_reader :domain
@@ -67,6 +72,7 @@ module ContextDev
67
72
 
68
73
  sig do
69
74
  params(
75
+ request_id: String,
70
76
  domain: String,
71
77
  key_metadata:
72
78
  ContextDev::Models::UtilityPrefetchResponse::KeyMetadata::OrHash,
@@ -76,6 +82,9 @@ module ContextDev
76
82
  ).returns(T.attached_class)
77
83
  end
78
84
  def self.new(
85
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
86
+ # it when contacting support about a failed request.
87
+ request_id:,
79
88
  # The domain that was queued for prefetching
80
89
  domain: nil,
81
90
  # Credit usage, included whenever a valid API key is provided.
@@ -92,6 +101,7 @@ module ContextDev
92
101
  sig do
93
102
  override.returns(
94
103
  {
104
+ request_id: String,
95
105
  domain: String,
96
106
  key_metadata:
97
107
  ContextDev::Models::UtilityPrefetchResponse::KeyMetadata,
@@ -25,6 +25,11 @@ module ContextDev
25
25
  sig { returns(String) }
26
26
  attr_accessor :domain
27
27
 
28
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
29
+ # it when contacting support about a failed request.
30
+ sig { returns(String) }
31
+ attr_accessor :request_id
32
+
28
33
  # Status of the response.
29
34
  sig do
30
35
  returns(
@@ -70,6 +75,7 @@ module ContextDev
70
75
  ContextDev::Models::WebExtractCompetitorsResponse::Competitor::OrHash
71
76
  ],
72
77
  domain: String,
78
+ request_id: String,
73
79
  status:
74
80
  ContextDev::Models::WebExtractCompetitorsResponse::Status::OrSymbol,
75
81
  target:
@@ -83,6 +89,9 @@ module ContextDev
83
89
  competitors:,
84
90
  # Normalized input domain.
85
91
  domain:,
92
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
93
+ # it when contacting support about a failed request.
94
+ request_id:,
86
95
  # Status of the response.
87
96
  status:,
88
97
  # Target company profile inferred from the landing page.
@@ -100,6 +109,7 @@ module ContextDev
100
109
  ContextDev::Models::WebExtractCompetitorsResponse::Competitor
101
110
  ],
102
111
  domain: String,
112
+ request_id: String,
103
113
  status:
104
114
  ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol,
105
115
  target: ContextDev::Models::WebExtractCompetitorsResponse::Target,
@@ -41,6 +41,11 @@ module ContextDev
41
41
  end
42
42
  attr_accessor :fonts
43
43
 
44
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
45
+ # it when contacting support about a failed request.
46
+ sig { returns(String) }
47
+ attr_accessor :request_id
48
+
44
49
  # Status of the response, e.g., 'ok'
45
50
  sig { returns(String) }
46
51
  attr_accessor :status
@@ -95,6 +100,7 @@ module ContextDev
95
100
  domain: String,
96
101
  fonts:
97
102
  T::Array[ContextDev::Models::WebExtractFontsResponse::Font::OrHash],
103
+ request_id: String,
98
104
  status: String,
99
105
  font_links:
100
106
  T::Hash[
@@ -116,6 +122,9 @@ module ContextDev
116
122
  domain:,
117
123
  # Array of font usage information
118
124
  fonts:,
125
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
126
+ # it when contacting support about a failed request.
127
+ request_id:,
119
128
  # Status of the response, e.g., 'ok'
120
129
  status:,
121
130
  # Font assets keyed by family name as it appears in the fonts array (non-generic
@@ -135,6 +144,7 @@ module ContextDev
135
144
  code: Integer,
136
145
  domain: String,
137
146
  fonts: T::Array[ContextDev::Models::WebExtractFontsResponse::Font],
147
+ request_id: String,
138
148
  status: String,
139
149
  font_links:
140
150
  T::Hash[
@@ -39,6 +39,11 @@ module ContextDev
39
39
  end
40
40
  attr_writer :metadata
41
41
 
42
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
43
+ # it when contacting support about a failed request.
44
+ sig { returns(String) }
45
+ attr_accessor :request_id
46
+
42
47
  # Status of the response, e.g., 'ok'
43
48
  sig { returns(String) }
44
49
  attr_accessor :status
@@ -71,6 +76,7 @@ module ContextDev
71
76
  ContextDev::Models::WebExtractResponse::CacheMetadata::OrHash,
72
77
  data: T::Hash[Symbol, T.anything],
73
78
  metadata: ContextDev::Models::WebExtractResponse::Metadata::OrHash,
79
+ request_id: String,
74
80
  status: String,
75
81
  url: String,
76
82
  urls_analyzed: T::Array[String],
@@ -86,6 +92,9 @@ module ContextDev
86
92
  # Extracted data matching the request schema
87
93
  data:,
88
94
  metadata:,
95
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
96
+ # it when contacting support about a failed request.
97
+ request_id:,
89
98
  # Status of the response, e.g., 'ok'
90
99
  status:,
91
100
  # The starting URL that was analyzed
@@ -104,6 +113,7 @@ module ContextDev
104
113
  ContextDev::Models::WebExtractResponse::CacheMetadata,
105
114
  data: T::Hash[Symbol, T.anything],
106
115
  metadata: ContextDev::Models::WebExtractResponse::Metadata,
116
+ request_id: String,
107
117
  status: String,
108
118
  url: String,
109
119
  urls_analyzed: T::Array[String],
@@ -27,6 +27,11 @@ module ContextDev
27
27
  end
28
28
  attr_writer :cache_metadata
29
29
 
30
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
31
+ # it when contacting support about a failed request.
32
+ sig { returns(String) }
33
+ attr_accessor :request_id
34
+
30
35
  # HTTP status code
31
36
  sig { returns(T.nilable(Integer)) }
32
37
  attr_reader :code
@@ -88,6 +93,7 @@ module ContextDev
88
93
  params(
89
94
  cache_metadata:
90
95
  ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::OrHash,
96
+ request_id: String,
91
97
  code: Integer,
92
98
  domain: String,
93
99
  key_metadata:
@@ -102,6 +108,9 @@ module ContextDev
102
108
  # cache-controlled fetch contributing to the output was a hit; age_ms is the
103
109
  # oldest contributing hit.
104
110
  cache_metadata:,
111
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
112
+ # it when contacting support about a failed request.
113
+ request_id:,
105
114
  # HTTP status code
106
115
  code: nil,
107
116
  # The normalized domain that was processed
@@ -120,6 +129,7 @@ module ContextDev
120
129
  {
121
130
  cache_metadata:
122
131
  ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata,
132
+ request_id: String,
123
133
  code: Integer,
124
134
  domain: String,
125
135
  key_metadata:
@@ -151,7 +151,8 @@ module ContextDev
151
151
 
152
152
  # Optional browser wait time in milliseconds after initial page load before taking
153
153
  # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
154
- # omitted.
154
+ # omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
155
+ # 10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
155
156
  sig { returns(T.nilable(Integer)) }
156
157
  attr_accessor :wait_for_ms
157
158
 
@@ -243,7 +244,8 @@ module ContextDev
243
244
  viewport: nil,
244
245
  # Optional browser wait time in milliseconds after initial page load before taking
245
246
  # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
246
- # omitted.
247
+ # omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
248
+ # 10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
247
249
  wait_for_ms: nil,
248
250
  # Set to enabled to bypass shared caches and omit request and response content
249
251
  # from retained usage logs. Requires zero data retention to be enabled for your
@@ -25,6 +25,11 @@ module ContextDev
25
25
  end
26
26
  attr_writer :cache_metadata
27
27
 
28
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
29
+ # it when contacting support about a failed request.
30
+ sig { returns(String) }
31
+ attr_accessor :request_id
32
+
28
33
  # HTTP status code
29
34
  sig { returns(T.nilable(Integer)) }
30
35
  attr_reader :code
@@ -106,6 +111,7 @@ module ContextDev
106
111
  params(
107
112
  cache_metadata:
108
113
  ContextDev::Models::WebScreenshotResponse::CacheMetadata::OrHash,
114
+ request_id: String,
109
115
  code: Integer,
110
116
  domain: String,
111
117
  height: Integer,
@@ -123,6 +129,9 @@ module ContextDev
123
129
  # cache-controlled fetch contributing to the output was a hit; age_ms is the
124
130
  # oldest contributing hit.
125
131
  cache_metadata:,
132
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
133
+ # it when contacting support about a failed request.
134
+ request_id:,
126
135
  # HTTP status code
127
136
  code: nil,
128
137
  # The normalized domain that was processed
@@ -148,6 +157,7 @@ module ContextDev
148
157
  {
149
158
  cache_metadata:
150
159
  ContextDev::Models::WebScreenshotResponse::CacheMetadata,
160
+ request_id: String,
151
161
  code: Integer,
152
162
  domain: String,
153
163
  height: Integer,
@@ -29,6 +29,11 @@ module ContextDev
29
29
  sig { returns(String) }
30
30
  attr_accessor :query
31
31
 
32
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
33
+ # it when contacting support about a failed request.
34
+ sig { returns(String) }
35
+ attr_accessor :request_id
36
+
32
37
  sig { returns(T::Array[ContextDev::Models::WebSearchResponse::Result]) }
33
38
  attr_accessor :results
34
39
 
@@ -51,6 +56,7 @@ module ContextDev
51
56
  cache_metadata:
52
57
  ContextDev::Models::WebSearchResponse::CacheMetadata::OrHash,
53
58
  query: String,
59
+ request_id: String,
54
60
  results:
55
61
  T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash],
56
62
  key_metadata:
@@ -64,6 +70,9 @@ module ContextDev
64
70
  cache_metadata:,
65
71
  # Echo of the original query (useful when fanout was enabled).
66
72
  query:,
73
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
74
+ # it when contacting support about a failed request.
75
+ request_id:,
67
76
  results:,
68
77
  # Credit usage, included whenever a valid API key is provided.
69
78
  key_metadata: nil
@@ -76,6 +85,7 @@ module ContextDev
76
85
  cache_metadata:
77
86
  ContextDev::Models::WebSearchResponse::CacheMetadata,
78
87
  query: String,
88
+ request_id: String,
79
89
  results: T::Array[ContextDev::Models::WebSearchResponse::Result],
80
90
  key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata
81
91
  }
@@ -35,6 +35,11 @@ module ContextDev
35
35
  end
36
36
  attr_writer :metadata
37
37
 
38
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
39
+ # it when contacting support about a failed request.
40
+ sig { returns(String) }
41
+ attr_accessor :request_id
42
+
38
43
  sig do
39
44
  returns(T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result])
40
45
  end
@@ -61,6 +66,7 @@ module ContextDev
61
66
  cache_metadata:
62
67
  ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::OrHash,
63
68
  metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata::OrHash,
69
+ request_id: String,
64
70
  results:
65
71
  T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash],
66
72
  key_metadata:
@@ -73,6 +79,9 @@ module ContextDev
73
79
  # oldest contributing hit.
74
80
  cache_metadata:,
75
81
  metadata:,
82
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
83
+ # it when contacting support about a failed request.
84
+ request_id:,
76
85
  results:,
77
86
  # Credit usage, included whenever a valid API key is provided.
78
87
  key_metadata: nil
@@ -85,6 +94,7 @@ module ContextDev
85
94
  cache_metadata:
86
95
  ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata,
87
96
  metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata,
97
+ request_id: String,
88
98
  results:
89
99
  T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result],
90
100
  key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata
@@ -129,7 +129,9 @@ module ContextDev
129
129
  attr_writer :use_main_content_only
130
130
 
131
131
  # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
132
- # 30000 (30 seconds).
132
+ # 30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
133
+ # waitForMs + 10000 ms; a shorter deadline is rejected with 400
134
+ # TIMEOUT_TOO_SHORT_FOR_WAIT.
133
135
  sig { returns(T.nilable(Integer)) }
134
136
  attr_accessor :wait_for_ms
135
137
 
@@ -222,7 +224,9 @@ module ContextDev
222
224
  # headers, footers, sidebars, and navigation when detectable.
223
225
  use_main_content_only: nil,
224
226
  # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
225
- # 30000 (30 seconds).
227
+ # 30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
228
+ # waitForMs + 10000 ms; a shorter deadline is rejected with 400
229
+ # TIMEOUT_TOO_SHORT_FOR_WAIT.
226
230
  wait_for_ms: nil,
227
231
  # Set to enabled to bypass shared caches and omit request and response content
228
232
  # from retained usage logs. Requires zero data retention to be enabled for your
@@ -45,6 +45,11 @@ module ContextDev
45
45
  end
46
46
  attr_writer :metadata
47
47
 
48
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
49
+ # it when contacting support about a failed request.
50
+ sig { returns(String) }
51
+ attr_accessor :request_id
52
+
48
53
  # Indicates success
49
54
  sig do
50
55
  returns(
@@ -121,6 +126,7 @@ module ContextDev
121
126
  html: String,
122
127
  metadata:
123
128
  ContextDev::Models::WebWebScrapeHTMLResponse::Metadata::OrHash,
129
+ request_id: String,
124
130
  success:
125
131
  ContextDev::Models::WebWebScrapeHTMLResponse::Success::OrBoolean,
126
132
  type: ContextDev::Models::WebWebScrapeHTMLResponse::Type::OrSymbol,
@@ -145,6 +151,9 @@ module ContextDev
145
151
  html:,
146
152
  # Metadata extracted from the scraped page HTML.
147
153
  metadata:,
154
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
155
+ # it when contacting support about a failed request.
156
+ request_id:,
148
157
  # Indicates success
149
158
  success:,
150
159
  # Detected content type of the returned `html` field. Sitemaps and feeds are
@@ -171,6 +180,7 @@ module ContextDev
171
180
  ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata,
172
181
  html: String,
173
182
  metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata,
183
+ request_id: String,
174
184
  success:
175
185
  ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean,
176
186
  type:
@@ -93,7 +93,9 @@ module ContextDev
93
93
  attr_writer :timeout_ms
94
94
 
95
95
  # Optional browser wait time in milliseconds after initial page load before
96
- # collecting images. Min: 0. Max: 30000 (30 seconds).
96
+ # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
97
+ # timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
98
+ # is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
97
99
  sig { returns(T.nilable(Integer)) }
98
100
  attr_accessor :wait_for_ms
99
101
 
@@ -151,7 +153,9 @@ module ContextDev
151
153
  # value is 300000ms (5 minutes).
152
154
  timeout_ms: nil,
153
155
  # Optional browser wait time in milliseconds after initial page load before
154
- # collecting images. Min: 0. Max: 30000 (30 seconds).
156
+ # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
157
+ # timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
158
+ # is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
155
159
  wait_for_ms: nil,
156
160
  request_options: {}
157
161
  )
@@ -33,6 +33,11 @@ module ContextDev
33
33
  end
34
34
  attr_accessor :images
35
35
 
36
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
37
+ # it when contacting support about a failed request.
38
+ sig { returns(String) }
39
+ attr_accessor :request_id
40
+
36
41
  # Always true on success.
37
42
  sig do
38
43
  returns(
@@ -91,6 +96,7 @@ module ContextDev
91
96
  T::Array[
92
97
  ContextDev::Models::WebWebScrapeImagesResponse::Image::OrHash
93
98
  ],
99
+ request_id: String,
94
100
  success:
95
101
  ContextDev::Models::WebWebScrapeImagesResponse::Success::OrBoolean,
96
102
  url: String,
@@ -109,6 +115,9 @@ module ContextDev
109
115
  cache_metadata:,
110
116
  # Images found on the page.
111
117
  images:,
118
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
119
+ # it when contacting support about a failed request.
120
+ request_id:,
112
121
  # Always true on success.
113
122
  success:,
114
123
  # Page URL that was scraped.
@@ -127,6 +136,7 @@ module ContextDev
127
136
  ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata,
128
137
  images:
129
138
  T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image],
139
+ request_id: String,
130
140
  success:
131
141
  ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean,
132
142
  url: String,
@@ -155,7 +155,9 @@ module ContextDev
155
155
  attr_writer :use_main_content_only
156
156
 
157
157
  # Optional browser wait time in milliseconds after initial page load before
158
- # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds).
158
+ # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
159
+ # with timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter
160
+ # deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
159
161
  sig { returns(T.nilable(Integer)) }
160
162
  attr_accessor :wait_for_ms
161
163
 
@@ -261,7 +263,9 @@ module ContextDev
261
263
  # and navigation
262
264
  use_main_content_only: nil,
263
265
  # Optional browser wait time in milliseconds after initial page load before
264
- # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds).
266
+ # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
267
+ # with timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter
268
+ # deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
265
269
  wait_for_ms: nil,
266
270
  # Set to enabled to bypass shared caches and omit request and response content
267
271
  # from retained usage logs. Requires zero data retention to be enabled for your
@@ -46,6 +46,11 @@ module ContextDev
46
46
  end
47
47
  attr_writer :metadata
48
48
 
49
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
50
+ # it when contacting support about a failed request.
51
+ sig { returns(String) }
52
+ attr_accessor :request_id
53
+
49
54
  # Indicates success
50
55
  sig do
51
56
  returns(
@@ -119,6 +124,7 @@ module ContextDev
119
124
  markdown: String,
120
125
  metadata:
121
126
  ContextDev::Models::WebWebScrapeMdResponse::Metadata::OrHash,
127
+ request_id: String,
122
128
  success:
123
129
  ContextDev::Models::WebWebScrapeMdResponse::Success::OrBoolean,
124
130
  url: String,
@@ -145,6 +151,9 @@ module ContextDev
145
151
  markdown:,
146
152
  # Metadata extracted from the scraped page HTML.
147
153
  metadata:,
154
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
155
+ # it when contacting support about a failed request.
156
+ request_id:,
148
157
  # Indicates success
149
158
  success:,
150
159
  # The URL that was scraped
@@ -171,6 +180,7 @@ module ContextDev
171
180
  content_length: Integer,
172
181
  markdown: String,
173
182
  metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata,
183
+ request_id: String,
174
184
  success:
175
185
  ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean,
176
186
  url: String,
@@ -26,6 +26,11 @@ module ContextDev
26
26
  end
27
27
  attr_writer :meta
28
28
 
29
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
30
+ # it when contacting support about a failed request.
31
+ sig { returns(String) }
32
+ attr_accessor :request_id
33
+
29
34
  # Indicates success
30
35
  sig do
31
36
  returns(
@@ -61,6 +66,7 @@ module ContextDev
61
66
  params(
62
67
  domain: String,
63
68
  meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash,
69
+ request_id: String,
64
70
  success:
65
71
  ContextDev::Models::WebWebScrapeSitemapResponse::Success::OrBoolean,
66
72
  urls: T::Array[String],
@@ -73,6 +79,9 @@ module ContextDev
73
79
  domain:,
74
80
  # Metadata about the sitemap crawl operation
75
81
  meta:,
82
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
83
+ # it when contacting support about a failed request.
84
+ request_id:,
76
85
  # Indicates success
77
86
  success:,
78
87
  # Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
@@ -88,6 +97,7 @@ module ContextDev
88
97
  {
89
98
  domain: String,
90
99
  meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta,
100
+ request_id: String,
91
101
  success:
92
102
  ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean,
93
103
  urls: T::Array[String],
@@ -24,6 +24,11 @@ module ContextDev
24
24
  sig { returns(T.nilable(String)) }
25
25
  attr_accessor :next_cursor
26
26
 
27
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
28
+ # it when contacting support about a failed request.
29
+ sig { returns(String) }
30
+ attr_accessor :request_id
31
+
27
32
  # Credit usage, included whenever a valid API key is provided.
28
33
  sig do
29
34
  returns(
@@ -47,6 +52,7 @@ module ContextDev
47
52
  data: T::Array[ContextDev::Webhooks::Attempt::OrHash],
48
53
  has_more: T::Boolean,
49
54
  next_cursor: T.nilable(String),
55
+ request_id: String,
50
56
  key_metadata:
51
57
  ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata::OrHash
52
58
  ).returns(T.attached_class)
@@ -58,6 +64,9 @@ module ContextDev
58
64
  has_more:,
59
65
  # Next page cursor, or null on the last page.
60
66
  next_cursor:,
67
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
68
+ # it when contacting support about a failed request.
69
+ request_id:,
61
70
  # Credit usage, included whenever a valid API key is provided.
62
71
  key_metadata: nil
63
72
  )
@@ -69,6 +78,7 @@ module ContextDev
69
78
  data: T::Array[ContextDev::Webhooks::Attempt],
70
79
  has_more: T::Boolean,
71
80
  next_cursor: T.nilable(String),
81
+ request_id: String,
72
82
  key_metadata:
73
83
  ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata
74
84
  }