context.dev 1.35.0 → 1.36.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -0
- data/README.md +9 -9
- data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -1
- data/lib/context_dev/models/web_screenshot_params.rb +245 -1
- data/lib/context_dev/models/web_search_params.rb +270 -3
- data/lib/context_dev/models/web_web_crawl_md_params.rb +226 -1
- data/lib/context_dev/models/web_web_scrape_html_params.rb +224 -1
- data/lib/context_dev/models/web_web_scrape_md_params.rb +224 -1
- data/lib/context_dev/resources/web.rb +25 -7
- data/lib/context_dev/version.rb +1 -1
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +59 -0
- data/rbi/context_dev/models/web_screenshot_params.rbi +295 -0
- data/rbi/context_dev/models/web_search_params.rbi +288 -2
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +245 -0
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +450 -0
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +244 -0
- data/rbi/context_dev/resources/web.rbi +35 -1
- data/sig/context_dev/models/web_extract_styleguide_params.rbs +20 -0
- data/sig/context_dev/models/web_screenshot_params.rbs +446 -0
- data/sig/context_dev/models/web_search_params.rbs +503 -0
- data/sig/context_dev/models/web_web_crawl_md_params.rbs +426 -0
- data/sig/context_dev/models/web_web_scrape_html_params.rbs +426 -0
- data/sig/context_dev/models/web_web_scrape_md_params.rbs +426 -0
- data/sig/context_dev/resources/web.rbs +8 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b992b047fe68af144930573fcf7afe0e46201c7079c77c3b38b0c6700cd44caf
|
|
4
|
+
data.tar.gz: 98b70840e40a074cbef802cec9842d03883300d201b4a7d0fde34dcb13d8f9b7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 50fe5fca39ab53e19c40eea5c6fce6e762272e42aebc77363fd08bc80a94977fddf3c00edf87eed28fce801af282276f78a4ae8fe542da01d34d174c8c320fda
|
|
7
|
+
data.tar.gz: 6378d2fce07dd46987a7d708a7d62a975f7fb3663e8c2716eb04f488ee1edab072575c930591719ce4549f810ab22794b41a5d42d19b38650e3c62e0634dc333
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.36.0 (2026-06-27)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.35.0...v1.36.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.35.0...v1.36.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([edf39d7](https://github.com/context-dot-dev/context-ruby-sdk/commit/edf39d75e9ca0a7b96ddac6467f9b50ceca0acf1))
|
|
10
|
+
* **api:** api update ([893f11d](https://github.com/context-dot-dev/context-ruby-sdk/commit/893f11d2746ccb636e971e12c24553043046cb11))
|
|
11
|
+
* **api:** api update ([59319b0](https://github.com/context-dot-dev/context-ruby-sdk/commit/59319b0421154c96a444f5e2d45b83e8f4bc9074))
|
|
12
|
+
* **api:** api update ([125ebe5](https://github.com/context-dot-dev/context-ruby-sdk/commit/125ebe5cb023b276c01bdc8c3cafbe8841dffddb))
|
|
13
|
+
|
|
3
14
|
## 1.35.0 (2026-06-25)
|
|
4
15
|
|
|
5
16
|
Full Changelog: [v1.34.0...v1.35.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.34.0...v1.35.0)
|
data/README.md
CHANGED
|
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
26
26
|
<!-- x-release-please-start-version -->
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
gem "context.dev", "~> 1.
|
|
29
|
+
gem "context.dev", "~> 1.36.0"
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<!-- x-release-please-end -->
|
|
@@ -206,25 +206,25 @@ context_dev.brand.retrieve(**params)
|
|
|
206
206
|
Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
|
|
207
207
|
|
|
208
208
|
```ruby
|
|
209
|
-
# :
|
|
210
|
-
puts(ContextDev::
|
|
209
|
+
# :light
|
|
210
|
+
puts(ContextDev::WebExtractStyleguideParams::ColorScheme::LIGHT)
|
|
211
211
|
|
|
212
|
-
# Revealed type: `T.all(ContextDev::
|
|
213
|
-
T.reveal_type(ContextDev::
|
|
212
|
+
# Revealed type: `T.all(ContextDev::WebExtractStyleguideParams::ColorScheme, Symbol)`
|
|
213
|
+
T.reveal_type(ContextDev::WebExtractStyleguideParams::ColorScheme::LIGHT)
|
|
214
214
|
```
|
|
215
215
|
|
|
216
216
|
Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
|
|
217
217
|
|
|
218
218
|
```ruby
|
|
219
219
|
# Using the enum constants preserves the tagged type information:
|
|
220
|
-
context_dev.web.
|
|
221
|
-
|
|
220
|
+
context_dev.web.extract_styleguide(
|
|
221
|
+
color_scheme: ContextDev::WebExtractStyleguideParams::ColorScheme::LIGHT,
|
|
222
222
|
# …
|
|
223
223
|
)
|
|
224
224
|
|
|
225
225
|
# Literal values are also permissible:
|
|
226
|
-
context_dev.web.
|
|
227
|
-
|
|
226
|
+
context_dev.web.extract_styleguide(
|
|
227
|
+
color_scheme: :light,
|
|
228
228
|
# …
|
|
229
229
|
)
|
|
230
230
|
```
|
|
@@ -7,6 +7,13 @@ module ContextDev
|
|
|
7
7
|
extend ContextDev::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include ContextDev::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute color_scheme
|
|
11
|
+
# Optional browser color scheme to emulate for websites that respond to
|
|
12
|
+
# prefers-color-scheme. This value is part of the styleguide cache key.
|
|
13
|
+
#
|
|
14
|
+
# @return [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme, nil]
|
|
15
|
+
optional :color_scheme, enum: -> { ContextDev::WebExtractStyleguideParams::ColorScheme }
|
|
16
|
+
|
|
10
17
|
# @!attribute direct_url
|
|
11
18
|
# A specific URL to fetch the styleguide from directly, bypassing domain
|
|
12
19
|
# resolution (e.g., 'https://example.com/design-system'). When provided, the
|
|
@@ -41,10 +48,12 @@ module ContextDev
|
|
|
41
48
|
# @return [Integer, nil]
|
|
42
49
|
optional :timeout_ms, Integer
|
|
43
50
|
|
|
44
|
-
# @!method initialize(direct_url: nil, domain: nil, max_age_ms: nil, timeout_ms: nil, request_options: {})
|
|
51
|
+
# @!method initialize(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, timeout_ms: nil, request_options: {})
|
|
45
52
|
# Some parameter documentations has been truncated, see
|
|
46
53
|
# {ContextDev::Models::WebExtractStyleguideParams} for more details.
|
|
47
54
|
#
|
|
55
|
+
# @param color_scheme [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme] Optional browser color scheme to emulate for websites that respond to prefers-co
|
|
56
|
+
#
|
|
48
57
|
# @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
|
|
49
58
|
#
|
|
50
59
|
# @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
|
|
@@ -54,6 +63,18 @@ module ContextDev
|
|
|
54
63
|
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
55
64
|
#
|
|
56
65
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
66
|
+
|
|
67
|
+
# Optional browser color scheme to emulate for websites that respond to
|
|
68
|
+
# prefers-color-scheme. This value is part of the styleguide cache key.
|
|
69
|
+
module ColorScheme
|
|
70
|
+
extend ContextDev::Internal::Type::Enum
|
|
71
|
+
|
|
72
|
+
LIGHT = :light
|
|
73
|
+
DARK = :dark
|
|
74
|
+
|
|
75
|
+
# @!method self.values
|
|
76
|
+
# @return [Array<Symbol>]
|
|
77
|
+
end
|
|
57
78
|
end
|
|
58
79
|
end
|
|
59
80
|
end
|
|
@@ -7,6 +7,20 @@ module ContextDev
|
|
|
7
7
|
extend ContextDev::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include ContextDev::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute color_scheme
|
|
11
|
+
# Optional parameter to choose the site's visual theme in the screenshot. Use
|
|
12
|
+
# 'light' or 'dark' when the site offers both appearances.
|
|
13
|
+
#
|
|
14
|
+
# @return [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme, nil]
|
|
15
|
+
optional :color_scheme, enum: -> { ContextDev::WebScreenshotParams::ColorScheme }
|
|
16
|
+
|
|
17
|
+
# @!attribute country
|
|
18
|
+
# Two-letter ISO 3166-1 alpha-2 country code for the website request location.
|
|
19
|
+
# When provided, Context.dev fetches the target page from that country.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, ContextDev::Models::WebScreenshotParams::Country, nil]
|
|
22
|
+
optional :country, enum: -> { ContextDev::WebScreenshotParams::Country }
|
|
23
|
+
|
|
10
24
|
# @!attribute direct_url
|
|
11
25
|
# A specific URL to screenshot directly, bypassing domain resolution (e.g.,
|
|
12
26
|
# 'https://example.com/pricing'). When provided, the screenshot is taken of this
|
|
@@ -90,10 +104,14 @@ module ContextDev
|
|
|
90
104
|
# @return [Integer, nil]
|
|
91
105
|
optional :wait_for_ms, Integer
|
|
92
106
|
|
|
93
|
-
# @!method initialize(direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {})
|
|
107
|
+
# @!method initialize(color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {})
|
|
94
108
|
# Some parameter documentations has been truncated, see
|
|
95
109
|
# {ContextDev::Models::WebScreenshotParams} for more details.
|
|
96
110
|
#
|
|
111
|
+
# @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig
|
|
112
|
+
#
|
|
113
|
+
# @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe
|
|
114
|
+
#
|
|
97
115
|
# @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
|
|
98
116
|
#
|
|
99
117
|
# @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai
|
|
@@ -116,6 +134,232 @@ module ContextDev
|
|
|
116
134
|
#
|
|
117
135
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
118
136
|
|
|
137
|
+
# Optional parameter to choose the site's visual theme in the screenshot. Use
|
|
138
|
+
# 'light' or 'dark' when the site offers both appearances.
|
|
139
|
+
module ColorScheme
|
|
140
|
+
extend ContextDev::Internal::Type::Enum
|
|
141
|
+
|
|
142
|
+
LIGHT = :light
|
|
143
|
+
DARK = :dark
|
|
144
|
+
|
|
145
|
+
# @!method self.values
|
|
146
|
+
# @return [Array<Symbol>]
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Two-letter ISO 3166-1 alpha-2 country code for the website request location.
|
|
150
|
+
# When provided, Context.dev fetches the target page from that country.
|
|
151
|
+
module Country
|
|
152
|
+
extend ContextDev::Internal::Type::Enum
|
|
153
|
+
|
|
154
|
+
AD = :ad
|
|
155
|
+
AE = :ae
|
|
156
|
+
AF = :af
|
|
157
|
+
AG = :ag
|
|
158
|
+
AI = :ai
|
|
159
|
+
AL = :al
|
|
160
|
+
AM = :am
|
|
161
|
+
AO = :ao
|
|
162
|
+
AR = :ar
|
|
163
|
+
AT = :at
|
|
164
|
+
AU = :au
|
|
165
|
+
AW = :aw
|
|
166
|
+
AZ = :az
|
|
167
|
+
BA = :ba
|
|
168
|
+
BB = :bb
|
|
169
|
+
BD = :bd
|
|
170
|
+
BE = :be
|
|
171
|
+
BF = :bf
|
|
172
|
+
BG = :bg
|
|
173
|
+
BH = :bh
|
|
174
|
+
BI = :bi
|
|
175
|
+
BJ = :bj
|
|
176
|
+
BM = :bm
|
|
177
|
+
BN = :bn
|
|
178
|
+
BO = :bo
|
|
179
|
+
BQ = :bq
|
|
180
|
+
BR = :br
|
|
181
|
+
BS = :bs
|
|
182
|
+
BW = :bw
|
|
183
|
+
BY = :by
|
|
184
|
+
BZ = :bz
|
|
185
|
+
CA = :ca
|
|
186
|
+
CD = :cd
|
|
187
|
+
CF = :cf
|
|
188
|
+
CG = :cg
|
|
189
|
+
CH = :ch
|
|
190
|
+
CI = :ci
|
|
191
|
+
CL = :cl
|
|
192
|
+
CM = :cm
|
|
193
|
+
CN = :cn
|
|
194
|
+
CO = :co
|
|
195
|
+
CR = :cr
|
|
196
|
+
CV = :cv
|
|
197
|
+
CW = :cw
|
|
198
|
+
CY = :cy
|
|
199
|
+
CZ = :cz
|
|
200
|
+
DE = :de
|
|
201
|
+
DJ = :dj
|
|
202
|
+
DK = :dk
|
|
203
|
+
DM = :dm
|
|
204
|
+
DO = :do
|
|
205
|
+
DZ = :dz
|
|
206
|
+
EC = :ec
|
|
207
|
+
EE = :ee
|
|
208
|
+
EG = :eg
|
|
209
|
+
ES = :es
|
|
210
|
+
ET = :et
|
|
211
|
+
FI = :fi
|
|
212
|
+
FJ = :fj
|
|
213
|
+
FR = :fr
|
|
214
|
+
GA = :ga
|
|
215
|
+
GB = :gb
|
|
216
|
+
GD = :gd
|
|
217
|
+
GE = :ge
|
|
218
|
+
GF = :gf
|
|
219
|
+
GG = :gg
|
|
220
|
+
GH = :gh
|
|
221
|
+
GM = :gm
|
|
222
|
+
GN = :gn
|
|
223
|
+
GP = :gp
|
|
224
|
+
GQ = :gq
|
|
225
|
+
GR = :gr
|
|
226
|
+
GT = :gt
|
|
227
|
+
GU = :gu
|
|
228
|
+
GW = :gw
|
|
229
|
+
GY = :gy
|
|
230
|
+
HK = :hk
|
|
231
|
+
HN = :hn
|
|
232
|
+
HR = :hr
|
|
233
|
+
HT = :ht
|
|
234
|
+
HU = :hu
|
|
235
|
+
ID = :id
|
|
236
|
+
IE = :ie
|
|
237
|
+
IL = :il
|
|
238
|
+
IM = :im
|
|
239
|
+
IN = :in
|
|
240
|
+
IQ = :iq
|
|
241
|
+
IR = :ir
|
|
242
|
+
IS = :is
|
|
243
|
+
IT = :it
|
|
244
|
+
JE = :je
|
|
245
|
+
JM = :jm
|
|
246
|
+
JO = :jo
|
|
247
|
+
JP = :jp
|
|
248
|
+
KE = :ke
|
|
249
|
+
KG = :kg
|
|
250
|
+
KH = :kh
|
|
251
|
+
KN = :kn
|
|
252
|
+
KR = :kr
|
|
253
|
+
KW = :kw
|
|
254
|
+
KY = :ky
|
|
255
|
+
KZ = :kz
|
|
256
|
+
LA = :la
|
|
257
|
+
LB = :lb
|
|
258
|
+
LC = :lc
|
|
259
|
+
LK = :lk
|
|
260
|
+
LR = :lr
|
|
261
|
+
LS = :ls
|
|
262
|
+
LT = :lt
|
|
263
|
+
LU = :lu
|
|
264
|
+
LV = :lv
|
|
265
|
+
LY = :ly
|
|
266
|
+
MA = :ma
|
|
267
|
+
MC = :mc
|
|
268
|
+
MD = :md
|
|
269
|
+
ME = :me
|
|
270
|
+
MF = :mf
|
|
271
|
+
MG = :mg
|
|
272
|
+
MK = :mk
|
|
273
|
+
ML = :ml
|
|
274
|
+
MM = :mm
|
|
275
|
+
MN = :mn
|
|
276
|
+
MO = :mo
|
|
277
|
+
MQ = :mq
|
|
278
|
+
MR = :mr
|
|
279
|
+
MT = :mt
|
|
280
|
+
MU = :mu
|
|
281
|
+
MV = :mv
|
|
282
|
+
MW = :mw
|
|
283
|
+
MX = :mx
|
|
284
|
+
MY = :my
|
|
285
|
+
MZ = :mz
|
|
286
|
+
NA = :na
|
|
287
|
+
NC = :nc
|
|
288
|
+
NE = :ne
|
|
289
|
+
NG = :ng
|
|
290
|
+
NI = :ni
|
|
291
|
+
NL = :nl
|
|
292
|
+
NO = :no
|
|
293
|
+
NP = :np
|
|
294
|
+
NZ = :nz
|
|
295
|
+
OM = :om
|
|
296
|
+
PA = :pa
|
|
297
|
+
PE = :pe
|
|
298
|
+
PF = :pf
|
|
299
|
+
PG = :pg
|
|
300
|
+
PH = :ph
|
|
301
|
+
PK = :pk
|
|
302
|
+
PL = :pl
|
|
303
|
+
PR = :pr
|
|
304
|
+
PS = :ps
|
|
305
|
+
PT = :pt
|
|
306
|
+
PY = :py
|
|
307
|
+
QA = :qa
|
|
308
|
+
RE = :re
|
|
309
|
+
RO = :ro
|
|
310
|
+
RS = :rs
|
|
311
|
+
RU = :ru
|
|
312
|
+
RW = :rw
|
|
313
|
+
SA = :sa
|
|
314
|
+
SC = :sc
|
|
315
|
+
SD = :sd
|
|
316
|
+
SE = :se
|
|
317
|
+
SG = :sg
|
|
318
|
+
SI = :si
|
|
319
|
+
SK = :sk
|
|
320
|
+
SL = :sl
|
|
321
|
+
SM = :sm
|
|
322
|
+
SN = :sn
|
|
323
|
+
SO = :so
|
|
324
|
+
SR = :sr
|
|
325
|
+
SS = :ss
|
|
326
|
+
ST = :st
|
|
327
|
+
SV = :sv
|
|
328
|
+
SX = :sx
|
|
329
|
+
SY = :sy
|
|
330
|
+
SZ = :sz
|
|
331
|
+
TC = :tc
|
|
332
|
+
TD = :td
|
|
333
|
+
TG = :tg
|
|
334
|
+
TH = :th
|
|
335
|
+
TJ = :tj
|
|
336
|
+
TL = :tl
|
|
337
|
+
TM = :tm
|
|
338
|
+
TN = :tn
|
|
339
|
+
TR = :tr
|
|
340
|
+
TT = :tt
|
|
341
|
+
TW = :tw
|
|
342
|
+
TZ = :tz
|
|
343
|
+
UA = :ua
|
|
344
|
+
UG = :ug
|
|
345
|
+
US = :us
|
|
346
|
+
UY = :uy
|
|
347
|
+
UZ = :uz
|
|
348
|
+
VC = :vc
|
|
349
|
+
VE = :ve
|
|
350
|
+
VG = :vg
|
|
351
|
+
VI = :vi
|
|
352
|
+
VN = :vn
|
|
353
|
+
YE = :ye
|
|
354
|
+
YT = :yt
|
|
355
|
+
ZA = :za
|
|
356
|
+
ZM = :zm
|
|
357
|
+
ZW = :zw
|
|
358
|
+
|
|
359
|
+
# @!method self.values
|
|
360
|
+
# @return [Array<Symbol>]
|
|
361
|
+
end
|
|
362
|
+
|
|
119
363
|
# Optional parameter to determine screenshot type. If 'true', takes a full page
|
|
120
364
|
# screenshot capturing all content. If 'false' or not provided, takes a viewport
|
|
121
365
|
# screenshot (standard browser view).
|
|
@@ -8,11 +8,19 @@ module ContextDev
|
|
|
8
8
|
include ContextDev::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
10
|
# @!attribute query
|
|
11
|
-
#
|
|
11
|
+
# Search query. Accepts natural language as well as Google-style search operators
|
|
12
|
+
# such as `site:`, `-site:`, `inurl:`, `intitle:`, quoted phrases, and `OR`.
|
|
12
13
|
#
|
|
13
14
|
# @return [String]
|
|
14
15
|
required :query, String
|
|
15
16
|
|
|
17
|
+
# @!attribute country
|
|
18
|
+
# Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific
|
|
19
|
+
# country (maps to Google's `gl` parameter). Example: "us", "gb", "de".
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, ContextDev::Models::WebSearchParams::Country, nil]
|
|
22
|
+
optional :country, enum: -> { ContextDev::WebSearchParams::Country }
|
|
23
|
+
|
|
16
24
|
# @!attribute exclude_domains
|
|
17
25
|
# Blocklist — drop results from these domains. Example: ["pinterest.com",
|
|
18
26
|
# "reddit.com"].
|
|
@@ -41,6 +49,12 @@ module ContextDev
|
|
|
41
49
|
-> { ContextDev::WebSearchParams::MarkdownOptions },
|
|
42
50
|
api_name: :markdownOptions
|
|
43
51
|
|
|
52
|
+
# @!attribute num_results
|
|
53
|
+
# Number of results to request and return (10–100). Defaults to 10.
|
|
54
|
+
#
|
|
55
|
+
# @return [Integer, nil]
|
|
56
|
+
optional :num_results, Integer, api_name: :numResults
|
|
57
|
+
|
|
44
58
|
# @!attribute query_fanout
|
|
45
59
|
# Expand the query into multiple parallel variants for broader recall.
|
|
46
60
|
#
|
|
@@ -55,11 +69,13 @@ module ContextDev
|
|
|
55
69
|
# @return [Integer, nil]
|
|
56
70
|
optional :timeout_ms, Integer, api_name: :timeoutMS
|
|
57
71
|
|
|
58
|
-
# @!method initialize(query:, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, query_fanout: nil, timeout_ms: nil, request_options: {})
|
|
72
|
+
# @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, timeout_ms: nil, request_options: {})
|
|
59
73
|
# Some parameter documentations has been truncated, see
|
|
60
74
|
# {ContextDev::Models::WebSearchParams} for more details.
|
|
61
75
|
#
|
|
62
|
-
# @param query [String]
|
|
76
|
+
# @param query [String] Search query. Accepts natural language as well as Google-style search operators
|
|
77
|
+
#
|
|
78
|
+
# @param country [Symbol, ContextDev::Models::WebSearchParams::Country] Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific cou
|
|
63
79
|
#
|
|
64
80
|
# @param exclude_domains [Array<String>] Blocklist — drop results from these domains. Example: ["pinterest.com", "reddit.
|
|
65
81
|
#
|
|
@@ -69,12 +85,263 @@ module ContextDev
|
|
|
69
85
|
#
|
|
70
86
|
# @param markdown_options [ContextDev::Models::WebSearchParams::MarkdownOptions] Inline Markdown scraping for each result. Set `enabled: true` to activate.
|
|
71
87
|
#
|
|
88
|
+
# @param num_results [Integer] Number of results to request and return (10–100). Defaults to 10.
|
|
89
|
+
#
|
|
72
90
|
# @param query_fanout [Boolean] Expand the query into multiple parallel variants for broader recall.
|
|
73
91
|
#
|
|
74
92
|
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
75
93
|
#
|
|
76
94
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
77
95
|
|
|
96
|
+
# Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific
|
|
97
|
+
# country (maps to Google's `gl` parameter). Example: "us", "gb", "de".
|
|
98
|
+
module Country
|
|
99
|
+
extend ContextDev::Internal::Type::Enum
|
|
100
|
+
|
|
101
|
+
AF = :af
|
|
102
|
+
AL = :al
|
|
103
|
+
DZ = :dz
|
|
104
|
+
AS = :as
|
|
105
|
+
AD = :ad
|
|
106
|
+
AO = :ao
|
|
107
|
+
AI = :ai
|
|
108
|
+
AQ = :aq
|
|
109
|
+
AG = :ag
|
|
110
|
+
AR = :ar
|
|
111
|
+
AM = :am
|
|
112
|
+
AW = :aw
|
|
113
|
+
AU = :au
|
|
114
|
+
AT = :at
|
|
115
|
+
AZ = :az
|
|
116
|
+
BS = :bs
|
|
117
|
+
BH = :bh
|
|
118
|
+
BD = :bd
|
|
119
|
+
BB = :bb
|
|
120
|
+
BY = :by
|
|
121
|
+
BE = :be
|
|
122
|
+
BZ = :bz
|
|
123
|
+
BJ = :bj
|
|
124
|
+
BM = :bm
|
|
125
|
+
BT = :bt
|
|
126
|
+
BO = :bo
|
|
127
|
+
BA = :ba
|
|
128
|
+
BW = :bw
|
|
129
|
+
BV = :bv
|
|
130
|
+
BR = :br
|
|
131
|
+
IO = :io
|
|
132
|
+
BN = :bn
|
|
133
|
+
BG = :bg
|
|
134
|
+
BF = :bf
|
|
135
|
+
BI = :bi
|
|
136
|
+
KH = :kh
|
|
137
|
+
CM = :cm
|
|
138
|
+
CA = :ca
|
|
139
|
+
CV = :cv
|
|
140
|
+
KY = :ky
|
|
141
|
+
CF = :cf
|
|
142
|
+
TD = :td
|
|
143
|
+
CL = :cl
|
|
144
|
+
CN = :cn
|
|
145
|
+
CX = :cx
|
|
146
|
+
CC = :cc
|
|
147
|
+
CO = :co
|
|
148
|
+
KM = :km
|
|
149
|
+
CG = :cg
|
|
150
|
+
CD = :cd
|
|
151
|
+
CK = :ck
|
|
152
|
+
CR = :cr
|
|
153
|
+
CI = :ci
|
|
154
|
+
HR = :hr
|
|
155
|
+
CU = :cu
|
|
156
|
+
CY = :cy
|
|
157
|
+
CZ = :cz
|
|
158
|
+
DK = :dk
|
|
159
|
+
DJ = :dj
|
|
160
|
+
DM = :dm
|
|
161
|
+
DO = :do
|
|
162
|
+
EC = :ec
|
|
163
|
+
EG = :eg
|
|
164
|
+
SV = :sv
|
|
165
|
+
GQ = :gq
|
|
166
|
+
ER = :er
|
|
167
|
+
EE = :ee
|
|
168
|
+
ET = :et
|
|
169
|
+
FK = :fk
|
|
170
|
+
FO = :fo
|
|
171
|
+
FJ = :fj
|
|
172
|
+
FI = :fi
|
|
173
|
+
FR = :fr
|
|
174
|
+
GF = :gf
|
|
175
|
+
PF = :pf
|
|
176
|
+
TF = :tf
|
|
177
|
+
GA = :ga
|
|
178
|
+
GM = :gm
|
|
179
|
+
GE = :ge
|
|
180
|
+
DE = :de
|
|
181
|
+
GH = :gh
|
|
182
|
+
GI = :gi
|
|
183
|
+
GR = :gr
|
|
184
|
+
GL = :gl
|
|
185
|
+
GD = :gd
|
|
186
|
+
GP = :gp
|
|
187
|
+
GU = :gu
|
|
188
|
+
GT = :gt
|
|
189
|
+
GN = :gn
|
|
190
|
+
GW = :gw
|
|
191
|
+
GY = :gy
|
|
192
|
+
HT = :ht
|
|
193
|
+
HM = :hm
|
|
194
|
+
VA = :va
|
|
195
|
+
HN = :hn
|
|
196
|
+
HK = :hk
|
|
197
|
+
HU = :hu
|
|
198
|
+
IS = :is
|
|
199
|
+
IN = :in
|
|
200
|
+
ID = :id
|
|
201
|
+
IR = :ir
|
|
202
|
+
IQ = :iq
|
|
203
|
+
IE = :ie
|
|
204
|
+
IL = :il
|
|
205
|
+
IT = :it
|
|
206
|
+
JM = :jm
|
|
207
|
+
JP = :jp
|
|
208
|
+
JO = :jo
|
|
209
|
+
KZ = :kz
|
|
210
|
+
KE = :ke
|
|
211
|
+
KI = :ki
|
|
212
|
+
KP = :kp
|
|
213
|
+
KR = :kr
|
|
214
|
+
KW = :kw
|
|
215
|
+
KG = :kg
|
|
216
|
+
LA = :la
|
|
217
|
+
LV = :lv
|
|
218
|
+
LB = :lb
|
|
219
|
+
LS = :ls
|
|
220
|
+
LR = :lr
|
|
221
|
+
LY = :ly
|
|
222
|
+
LI = :li
|
|
223
|
+
LT = :lt
|
|
224
|
+
LU = :lu
|
|
225
|
+
MO = :mo
|
|
226
|
+
MK = :mk
|
|
227
|
+
MG = :mg
|
|
228
|
+
MW = :mw
|
|
229
|
+
MY = :my
|
|
230
|
+
MV = :mv
|
|
231
|
+
ML = :ml
|
|
232
|
+
MT = :mt
|
|
233
|
+
MH = :mh
|
|
234
|
+
MQ = :mq
|
|
235
|
+
MR = :mr
|
|
236
|
+
MU = :mu
|
|
237
|
+
YT = :yt
|
|
238
|
+
MX = :mx
|
|
239
|
+
FM = :fm
|
|
240
|
+
MD = :md
|
|
241
|
+
MC = :mc
|
|
242
|
+
MN = :mn
|
|
243
|
+
MS = :ms
|
|
244
|
+
MA = :ma
|
|
245
|
+
MZ = :mz
|
|
246
|
+
MM = :mm
|
|
247
|
+
NA = :na
|
|
248
|
+
NR = :nr
|
|
249
|
+
NP = :np
|
|
250
|
+
NL = :nl
|
|
251
|
+
AN = :an
|
|
252
|
+
NC = :nc
|
|
253
|
+
NZ = :nz
|
|
254
|
+
NI = :ni
|
|
255
|
+
NE = :ne
|
|
256
|
+
NG = :ng
|
|
257
|
+
NU = :nu
|
|
258
|
+
NF = :nf
|
|
259
|
+
MP = :mp
|
|
260
|
+
NO = :no
|
|
261
|
+
OM = :om
|
|
262
|
+
PK = :pk
|
|
263
|
+
PW = :pw
|
|
264
|
+
PS = :ps
|
|
265
|
+
PA = :pa
|
|
266
|
+
PG = :pg
|
|
267
|
+
PY = :py
|
|
268
|
+
PE = :pe
|
|
269
|
+
PH = :ph
|
|
270
|
+
PN = :pn
|
|
271
|
+
PL = :pl
|
|
272
|
+
PT = :pt
|
|
273
|
+
PR = :pr
|
|
274
|
+
QA = :qa
|
|
275
|
+
RE = :re
|
|
276
|
+
RO = :ro
|
|
277
|
+
RU = :ru
|
|
278
|
+
RW = :rw
|
|
279
|
+
SH = :sh
|
|
280
|
+
KN = :kn
|
|
281
|
+
LC = :lc
|
|
282
|
+
PM = :pm
|
|
283
|
+
VC = :vc
|
|
284
|
+
WS = :ws
|
|
285
|
+
SM = :sm
|
|
286
|
+
ST = :st
|
|
287
|
+
SA = :sa
|
|
288
|
+
SN = :sn
|
|
289
|
+
RS = :rs
|
|
290
|
+
SC = :sc
|
|
291
|
+
SL = :sl
|
|
292
|
+
SG = :sg
|
|
293
|
+
SK = :sk
|
|
294
|
+
SI = :si
|
|
295
|
+
SB = :sb
|
|
296
|
+
SO = :so
|
|
297
|
+
ZA = :za
|
|
298
|
+
GS = :gs
|
|
299
|
+
ES = :es
|
|
300
|
+
LK = :lk
|
|
301
|
+
SD = :sd
|
|
302
|
+
SR = :sr
|
|
303
|
+
SJ = :sj
|
|
304
|
+
SZ = :sz
|
|
305
|
+
SE = :se
|
|
306
|
+
CH = :ch
|
|
307
|
+
SY = :sy
|
|
308
|
+
TW = :tw
|
|
309
|
+
TJ = :tj
|
|
310
|
+
TZ = :tz
|
|
311
|
+
TH = :th
|
|
312
|
+
TL = :tl
|
|
313
|
+
TG = :tg
|
|
314
|
+
TK = :tk
|
|
315
|
+
TO = :to
|
|
316
|
+
TT = :tt
|
|
317
|
+
TN = :tn
|
|
318
|
+
TR = :tr
|
|
319
|
+
TM = :tm
|
|
320
|
+
TC = :tc
|
|
321
|
+
TV = :tv
|
|
322
|
+
UG = :ug
|
|
323
|
+
UA = :ua
|
|
324
|
+
AE = :ae
|
|
325
|
+
GB = :gb
|
|
326
|
+
US = :us
|
|
327
|
+
UM = :um
|
|
328
|
+
UY = :uy
|
|
329
|
+
UZ = :uz
|
|
330
|
+
VU = :vu
|
|
331
|
+
VE = :ve
|
|
332
|
+
VN = :vn
|
|
333
|
+
VG = :vg
|
|
334
|
+
VI = :vi
|
|
335
|
+
WF = :wf
|
|
336
|
+
EH = :eh
|
|
337
|
+
YE = :ye
|
|
338
|
+
ZM = :zm
|
|
339
|
+
ZW = :zw
|
|
340
|
+
|
|
341
|
+
# @!method self.values
|
|
342
|
+
# @return [Array<Symbol>]
|
|
343
|
+
end
|
|
344
|
+
|
|
78
345
|
# Restrict results to content published within this window.
|
|
79
346
|
module Freshness
|
|
80
347
|
extend ContextDev::Internal::Type::Enum
|