context.dev 2.12.0 → 2.14.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 (56) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +2 -11
  4. data/lib/context_dev/models/ai_extract_product_response.rb +54 -1
  5. data/lib/context_dev/models/ai_extract_products_response.rb +54 -1
  6. data/lib/context_dev/models/batch_get_results_response.rb +56 -1
  7. data/lib/context_dev/models/batch_submit_response.rb +54 -1
  8. data/lib/context_dev/models/brand_retrieve_response.rb +58 -3
  9. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +55 -1
  10. data/lib/context_dev/models/web_extract_fonts_response.rb +54 -1
  11. data/lib/context_dev/models/web_extract_response.rb +54 -1
  12. data/lib/context_dev/models/web_extract_styleguide_response.rb +55 -1
  13. data/lib/context_dev/models/web_screenshot_response.rb +54 -1
  14. data/lib/context_dev/models/web_search_response.rb +54 -1
  15. data/lib/context_dev/models/web_web_crawl_md_response.rb +54 -1
  16. data/lib/context_dev/models/web_web_scrape_html_response.rb +54 -1
  17. data/lib/context_dev/models/web_web_scrape_images_response.rb +55 -1
  18. data/lib/context_dev/models/web_web_scrape_md_response.rb +54 -1
  19. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +10 -1
  20. data/lib/context_dev/resources/web.rb +10 -6
  21. data/lib/context_dev/version.rb +1 -1
  22. data/rbi/context_dev/models/ai_extract_product_response.rbi +119 -0
  23. data/rbi/context_dev/models/ai_extract_products_response.rbi +119 -0
  24. data/rbi/context_dev/models/batch_get_results_response.rbi +121 -0
  25. data/rbi/context_dev/models/batch_submit_response.rbi +117 -0
  26. data/rbi/context_dev/models/brand_retrieve_response.rbi +123 -2
  27. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +121 -0
  28. data/rbi/context_dev/models/web_extract_fonts_response.rbi +119 -0
  29. data/rbi/context_dev/models/web_extract_response.rbi +117 -0
  30. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +119 -0
  31. data/rbi/context_dev/models/web_screenshot_response.rbi +117 -0
  32. data/rbi/context_dev/models/web_search_response.rbi +117 -0
  33. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +117 -0
  34. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +119 -0
  35. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +119 -0
  36. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +117 -0
  37. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +13 -0
  38. data/rbi/context_dev/resources/web.rbi +10 -5
  39. data/sig/context_dev/models/ai_extract_product_response.rbs +39 -0
  40. data/sig/context_dev/models/ai_extract_products_response.rbs +39 -0
  41. data/sig/context_dev/models/batch_get_results_response.rbs +39 -0
  42. data/sig/context_dev/models/batch_submit_response.rbs +39 -0
  43. data/sig/context_dev/models/brand_retrieve_response.rbs +39 -0
  44. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +39 -0
  45. data/sig/context_dev/models/web_extract_fonts_response.rbs +39 -0
  46. data/sig/context_dev/models/web_extract_response.rbs +39 -0
  47. data/sig/context_dev/models/web_extract_styleguide_response.rbs +39 -0
  48. data/sig/context_dev/models/web_screenshot_response.rbs +39 -0
  49. data/sig/context_dev/models/web_search_response.rbs +39 -0
  50. data/sig/context_dev/models/web_web_crawl_md_response.rbs +39 -0
  51. data/sig/context_dev/models/web_web_scrape_html_response.rbs +39 -0
  52. data/sig/context_dev/models/web_web_scrape_images_response.rbs +39 -0
  53. data/sig/context_dev/models/web_web_scrape_md_response.rbs +39 -0
  54. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +7 -0
  55. data/sig/context_dev/resources/web.rbs +1 -0
  56. metadata +2 -2
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#extract
6
6
  class WebExtractResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebExtractResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebExtractResponse::CacheMetadata }
14
+
7
15
  # @!attribute data
8
16
  # Extracted data matching the request schema
9
17
  #
@@ -40,10 +48,12 @@ module ContextDev
40
48
  # @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil]
41
49
  optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }
42
50
 
43
- # @!method initialize(data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil)
51
+ # @!method initialize(cache_metadata:, data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil)
44
52
  # Some parameter documentations has been truncated, see
45
53
  # {ContextDev::Models::WebExtractResponse} for more details.
46
54
  #
55
+ # @param cache_metadata [ContextDev::Models::WebExtractResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
56
+ #
47
57
  # @param data [Hash{Symbol=>Object}] Extracted data matching the request schema
48
58
  #
49
59
  # @param metadata [ContextDev::Models::WebExtractResponse::Metadata]
@@ -56,6 +66,49 @@ module ContextDev
56
66
  #
57
67
  # @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
58
68
 
69
+ # @see ContextDev::Models::WebExtractResponse#cache_metadata
70
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
71
+ # @!attribute age_ms
72
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
73
+ #
74
+ # @return [Integer]
75
+ required :age_ms, Integer
76
+
77
+ # @!attribute status
78
+ # Whether the response was served from cache, required fresh work, or honored
79
+ # zero-data-retention cache bypass.
80
+ #
81
+ # @return [Symbol, ContextDev::Models::WebExtractResponse::CacheMetadata::Status]
82
+ required :status, enum: -> { ContextDev::Models::WebExtractResponse::CacheMetadata::Status }
83
+
84
+ # @!method initialize(age_ms:, status:)
85
+ # Some parameter documentations has been truncated, see
86
+ # {ContextDev::Models::WebExtractResponse::CacheMetadata} for more details.
87
+ #
88
+ # Cache outcome for this response. Composite responses are hits only when every
89
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
90
+ # oldest contributing hit.
91
+ #
92
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
93
+ #
94
+ # @param status [Symbol, ContextDev::Models::WebExtractResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
95
+
96
+ # Whether the response was served from cache, required fresh work, or honored
97
+ # zero-data-retention cache bypass.
98
+ #
99
+ # @see ContextDev::Models::WebExtractResponse::CacheMetadata#status
100
+ module Status
101
+ extend ContextDev::Internal::Type::Enum
102
+
103
+ HIT = :hit
104
+ MISS = :miss
105
+ ZDR = :zdr
106
+
107
+ # @!method self.values
108
+ # @return [Array<Symbol>]
109
+ end
110
+ end
111
+
59
112
  # @see ContextDev::Models::WebExtractResponse#metadata
60
113
  class Metadata < ContextDev::Internal::Type::BaseModel
61
114
  # @!attribute max_crawl_depth
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#extract_styleguide
6
6
  class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata }
14
+
7
15
  # @!attribute code
8
16
  # HTTP status code
9
17
  #
@@ -35,10 +43,12 @@ module ContextDev
35
43
  # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil]
36
44
  optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide }
37
45
 
38
- # @!method initialize(code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil)
46
+ # @!method initialize(cache_metadata:, code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil)
39
47
  # Some parameter documentations has been truncated, see
40
48
  # {ContextDev::Models::WebExtractStyleguideResponse} for more details.
41
49
  #
50
+ # @param cache_metadata [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
51
+ #
42
52
  # @param code [Integer] HTTP status code
43
53
  #
44
54
  # @param domain [String] The normalized domain that was processed
@@ -49,6 +59,50 @@ module ContextDev
49
59
  #
50
60
  # @param styleguide [ContextDev::Models::WebExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website
51
61
 
62
+ # @see ContextDev::Models::WebExtractStyleguideResponse#cache_metadata
63
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
64
+ # @!attribute age_ms
65
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
66
+ #
67
+ # @return [Integer]
68
+ required :age_ms, Integer
69
+
70
+ # @!attribute status
71
+ # Whether the response was served from cache, required fresh work, or honored
72
+ # zero-data-retention cache bypass.
73
+ #
74
+ # @return [Symbol, ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status]
75
+ required :status, enum: -> { ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status }
76
+
77
+ # @!method initialize(age_ms:, status:)
78
+ # Some parameter documentations has been truncated, see
79
+ # {ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata} for more
80
+ # details.
81
+ #
82
+ # Cache outcome for this response. Composite responses are hits only when every
83
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
84
+ # oldest contributing hit.
85
+ #
86
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
87
+ #
88
+ # @param status [Symbol, ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
89
+
90
+ # Whether the response was served from cache, required fresh work, or honored
91
+ # zero-data-retention cache bypass.
92
+ #
93
+ # @see ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata#status
94
+ module Status
95
+ extend ContextDev::Internal::Type::Enum
96
+
97
+ HIT = :hit
98
+ MISS = :miss
99
+ ZDR = :zdr
100
+
101
+ # @!method self.values
102
+ # @return [Array<Symbol>]
103
+ end
104
+ end
105
+
52
106
  # @see ContextDev::Models::WebExtractStyleguideResponse#key_metadata
53
107
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
54
108
  # @!attribute credits_consumed
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#screenshot
6
6
  class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebScreenshotResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebScreenshotResponse::CacheMetadata }
14
+
7
15
  # @!attribute code
8
16
  # HTTP status code
9
17
  #
@@ -56,10 +64,12 @@ module ContextDev
56
64
  # @return [Integer, nil]
57
65
  optional :width, Integer
58
66
 
59
- # @!method initialize(code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
67
+ # @!method initialize(cache_metadata:, code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
60
68
  # Some parameter documentations has been truncated, see
61
69
  # {ContextDev::Models::WebScreenshotResponse} for more details.
62
70
  #
71
+ # @param cache_metadata [ContextDev::Models::WebScreenshotResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
72
+ #
63
73
  # @param code [Integer] HTTP status code
64
74
  #
65
75
  # @param domain [String] The normalized domain that was processed
@@ -76,6 +86,49 @@ module ContextDev
76
86
  #
77
87
  # @param width [Integer] Width in pixels of the returned screenshot image
78
88
 
89
+ # @see ContextDev::Models::WebScreenshotResponse#cache_metadata
90
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
91
+ # @!attribute age_ms
92
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
93
+ #
94
+ # @return [Integer]
95
+ required :age_ms, Integer
96
+
97
+ # @!attribute status
98
+ # Whether the response was served from cache, required fresh work, or honored
99
+ # zero-data-retention cache bypass.
100
+ #
101
+ # @return [Symbol, ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status]
102
+ required :status, enum: -> { ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status }
103
+
104
+ # @!method initialize(age_ms:, status:)
105
+ # Some parameter documentations has been truncated, see
106
+ # {ContextDev::Models::WebScreenshotResponse::CacheMetadata} for more details.
107
+ #
108
+ # Cache outcome for this response. Composite responses are hits only when every
109
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
110
+ # oldest contributing hit.
111
+ #
112
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
113
+ #
114
+ # @param status [Symbol, ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
115
+
116
+ # Whether the response was served from cache, required fresh work, or honored
117
+ # zero-data-retention cache bypass.
118
+ #
119
+ # @see ContextDev::Models::WebScreenshotResponse::CacheMetadata#status
120
+ module Status
121
+ extend ContextDev::Internal::Type::Enum
122
+
123
+ HIT = :hit
124
+ MISS = :miss
125
+ ZDR = :zdr
126
+
127
+ # @!method self.values
128
+ # @return [Array<Symbol>]
129
+ end
130
+ end
131
+
79
132
  # @see ContextDev::Models::WebScreenshotResponse#key_metadata
80
133
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
81
134
  # @!attribute credits_consumed
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#search
6
6
  class WebSearchResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebSearchResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebSearchResponse::CacheMetadata }
14
+
7
15
  # @!attribute query
8
16
  # Echo of the original query (useful when fanout was enabled).
9
17
  #
@@ -23,16 +31,61 @@ module ContextDev
23
31
  # @return [ContextDev::Models::WebSearchResponse::KeyMetadata, nil]
24
32
  optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata }
25
33
 
26
- # @!method initialize(query:, results:, key_metadata: nil)
34
+ # @!method initialize(cache_metadata:, query:, results:, key_metadata: nil)
27
35
  # Some parameter documentations has been truncated, see
28
36
  # {ContextDev::Models::WebSearchResponse} for more details.
29
37
  #
38
+ # @param cache_metadata [ContextDev::Models::WebSearchResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
39
+ #
30
40
  # @param query [String] Echo of the original query (useful when fanout was enabled).
31
41
  #
32
42
  # @param results [Array<ContextDev::Models::WebSearchResponse::Result>]
33
43
  #
34
44
  # @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
35
45
 
46
+ # @see ContextDev::Models::WebSearchResponse#cache_metadata
47
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
48
+ # @!attribute age_ms
49
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
50
+ #
51
+ # @return [Integer]
52
+ required :age_ms, Integer
53
+
54
+ # @!attribute status
55
+ # Whether the response was served from cache, required fresh work, or honored
56
+ # zero-data-retention cache bypass.
57
+ #
58
+ # @return [Symbol, ContextDev::Models::WebSearchResponse::CacheMetadata::Status]
59
+ required :status, enum: -> { ContextDev::Models::WebSearchResponse::CacheMetadata::Status }
60
+
61
+ # @!method initialize(age_ms:, status:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {ContextDev::Models::WebSearchResponse::CacheMetadata} for more details.
64
+ #
65
+ # Cache outcome for this response. Composite responses are hits only when every
66
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
67
+ # oldest contributing hit.
68
+ #
69
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
70
+ #
71
+ # @param status [Symbol, ContextDev::Models::WebSearchResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
72
+
73
+ # Whether the response was served from cache, required fresh work, or honored
74
+ # zero-data-retention cache bypass.
75
+ #
76
+ # @see ContextDev::Models::WebSearchResponse::CacheMetadata#status
77
+ module Status
78
+ extend ContextDev::Internal::Type::Enum
79
+
80
+ HIT = :hit
81
+ MISS = :miss
82
+ ZDR = :zdr
83
+
84
+ # @!method self.values
85
+ # @return [Array<Symbol>]
86
+ end
87
+ end
88
+
36
89
  class Result < ContextDev::Internal::Type::BaseModel
37
90
  # @!attribute description
38
91
  # Snippet excerpt from the page.
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#web_crawl_md
6
6
  class WebWebCrawlMdResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata }
14
+
7
15
  # @!attribute metadata
8
16
  #
9
17
  # @return [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
@@ -22,16 +30,61 @@ module ContextDev
22
30
  # @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil]
23
31
  optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata }
24
32
 
25
- # @!method initialize(metadata:, results:, key_metadata: nil)
33
+ # @!method initialize(cache_metadata:, metadata:, results:, key_metadata: nil)
26
34
  # Some parameter documentations has been truncated, see
27
35
  # {ContextDev::Models::WebWebCrawlMdResponse} for more details.
28
36
  #
37
+ # @param cache_metadata [ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
38
+ #
29
39
  # @param metadata [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
30
40
  #
31
41
  # @param results [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
32
42
  #
33
43
  # @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
34
44
 
45
+ # @see ContextDev::Models::WebWebCrawlMdResponse#cache_metadata
46
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
47
+ # @!attribute age_ms
48
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
49
+ #
50
+ # @return [Integer]
51
+ required :age_ms, Integer
52
+
53
+ # @!attribute status
54
+ # Whether the response was served from cache, required fresh work, or honored
55
+ # zero-data-retention cache bypass.
56
+ #
57
+ # @return [Symbol, ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status]
58
+ required :status, enum: -> { ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status }
59
+
60
+ # @!method initialize(age_ms:, status:)
61
+ # Some parameter documentations has been truncated, see
62
+ # {ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata} for more details.
63
+ #
64
+ # Cache outcome for this response. Composite responses are hits only when every
65
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
66
+ # oldest contributing hit.
67
+ #
68
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
69
+ #
70
+ # @param status [Symbol, ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
71
+
72
+ # Whether the response was served from cache, required fresh work, or honored
73
+ # zero-data-retention cache bypass.
74
+ #
75
+ # @see ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata#status
76
+ module Status
77
+ extend ContextDev::Internal::Type::Enum
78
+
79
+ HIT = :hit
80
+ MISS = :miss
81
+ ZDR = :zdr
82
+
83
+ # @!method self.values
84
+ # @return [Array<Symbol>]
85
+ end
86
+ end
87
+
35
88
  # @see ContextDev::Models::WebWebCrawlMdResponse#metadata
36
89
  class Metadata < ContextDev::Internal::Type::BaseModel
37
90
  # @!attribute max_crawl_depth
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#web_scrape_html
6
6
  class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata }
14
+
7
15
  # @!attribute html
8
16
  # The scraped content of the page. For normal pages this is the raw HTML. When the
9
17
  # page is a sitemap or feed served behind an XSL stylesheet (which browsers render
@@ -61,10 +69,12 @@ module ContextDev
61
69
  # @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
62
70
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
63
71
 
64
- # @!method initialize(html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
72
+ # @!method initialize(cache_metadata:, html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
65
73
  # Some parameter documentations has been truncated, see
66
74
  # {ContextDev::Models::WebWebScrapeHTMLResponse} for more details.
67
75
  #
76
+ # @param cache_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
77
+ #
68
78
  # @param html [String] The scraped content of the page. For normal pages this is the raw HTML. When the
69
79
  #
70
80
  # @param metadata [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata] Metadata extracted from the scraped page HTML.
@@ -81,6 +91,49 @@ module ContextDev
81
91
  #
82
92
  # @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
83
93
 
94
+ # @see ContextDev::Models::WebWebScrapeHTMLResponse#cache_metadata
95
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
96
+ # @!attribute age_ms
97
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
98
+ #
99
+ # @return [Integer]
100
+ required :age_ms, Integer
101
+
102
+ # @!attribute status
103
+ # Whether the response was served from cache, required fresh work, or honored
104
+ # zero-data-retention cache bypass.
105
+ #
106
+ # @return [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status]
107
+ required :status, enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status }
108
+
109
+ # @!method initialize(age_ms:, status:)
110
+ # Some parameter documentations has been truncated, see
111
+ # {ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata} for more details.
112
+ #
113
+ # Cache outcome for this response. Composite responses are hits only when every
114
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
115
+ # oldest contributing hit.
116
+ #
117
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
118
+ #
119
+ # @param status [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
120
+
121
+ # Whether the response was served from cache, required fresh work, or honored
122
+ # zero-data-retention cache bypass.
123
+ #
124
+ # @see ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata#status
125
+ module Status
126
+ extend ContextDev::Internal::Type::Enum
127
+
128
+ HIT = :hit
129
+ MISS = :miss
130
+ ZDR = :zdr
131
+
132
+ # @!method self.values
133
+ # @return [Array<Symbol>]
134
+ end
135
+ end
136
+
84
137
  # @see ContextDev::Models::WebWebScrapeHTMLResponse#metadata
85
138
  class Metadata < ContextDev::Internal::Type::BaseModel
86
139
  # @!attribute final_url
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#web_scrape_images
6
6
  class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata }
14
+
7
15
  # @!attribute images
8
16
  # Images found on the page.
9
17
  #
@@ -38,10 +46,12 @@ module ContextDev
38
46
  # @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil]
39
47
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata }
40
48
 
41
- # @!method initialize(images:, success:, url:, actions_applied: nil, key_metadata: nil)
49
+ # @!method initialize(cache_metadata:, images:, success:, url:, actions_applied: nil, key_metadata: nil)
42
50
  # Some parameter documentations has been truncated, see
43
51
  # {ContextDev::Models::WebWebScrapeImagesResponse} for more details.
44
52
  #
53
+ # @param cache_metadata [ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
54
+ #
45
55
  # @param images [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>] Images found on the page.
46
56
  #
47
57
  # @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success.
@@ -52,6 +62,50 @@ module ContextDev
52
62
  #
53
63
  # @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
54
64
 
65
+ # @see ContextDev::Models::WebWebScrapeImagesResponse#cache_metadata
66
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
67
+ # @!attribute age_ms
68
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
69
+ #
70
+ # @return [Integer]
71
+ required :age_ms, Integer
72
+
73
+ # @!attribute status
74
+ # Whether the response was served from cache, required fresh work, or honored
75
+ # zero-data-retention cache bypass.
76
+ #
77
+ # @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status]
78
+ required :status, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status }
79
+
80
+ # @!method initialize(age_ms:, status:)
81
+ # Some parameter documentations has been truncated, see
82
+ # {ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata} for more
83
+ # details.
84
+ #
85
+ # Cache outcome for this response. Composite responses are hits only when every
86
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
87
+ # oldest contributing hit.
88
+ #
89
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
90
+ #
91
+ # @param status [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
92
+
93
+ # Whether the response was served from cache, required fresh work, or honored
94
+ # zero-data-retention cache bypass.
95
+ #
96
+ # @see ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata#status
97
+ module Status
98
+ extend ContextDev::Internal::Type::Enum
99
+
100
+ HIT = :hit
101
+ MISS = :miss
102
+ ZDR = :zdr
103
+
104
+ # @!method self.values
105
+ # @return [Array<Symbol>]
106
+ end
107
+ end
108
+
55
109
  class Image < ContextDev::Internal::Type::BaseModel
56
110
  # @!attribute alt
57
111
  # Image alt text, or null when unavailable.
@@ -4,6 +4,14 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Web#web_scrape_md
6
6
  class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute cache_metadata
8
+ # Cache outcome for this response. Composite responses are hits only when every
9
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
10
+ # oldest contributing hit.
11
+ #
12
+ # @return [ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata]
13
+ required :cache_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata }
14
+
7
15
  # @!attribute content_length
8
16
  # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result
9
17
  # and compare small values against your workload's minimum useful-content
@@ -66,10 +74,12 @@ module ContextDev
66
74
  # @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
67
75
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
68
76
 
69
- # @!method initialize(content_length:, markdown:, metadata:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
77
+ # @!method initialize(cache_metadata:, content_length:, markdown:, metadata:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
70
78
  # Some parameter documentations has been truncated, see
71
79
  # {ContextDev::Models::WebWebScrapeMdResponse} for more details.
72
80
  #
81
+ # @param cache_metadata [ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
82
+ #
73
83
  # @param content_length [Integer] UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result an
74
84
  #
75
85
  # @param markdown [String] Page content converted to GitHub Flavored Markdown
@@ -88,6 +98,49 @@ module ContextDev
88
98
  #
89
99
  # @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
90
100
 
101
+ # @see ContextDev::Models::WebWebScrapeMdResponse#cache_metadata
102
+ class CacheMetadata < ContextDev::Internal::Type::BaseModel
103
+ # @!attribute age_ms
104
+ # Age of the cached data in milliseconds. Zero for miss and zdr responses.
105
+ #
106
+ # @return [Integer]
107
+ required :age_ms, Integer
108
+
109
+ # @!attribute status
110
+ # Whether the response was served from cache, required fresh work, or honored
111
+ # zero-data-retention cache bypass.
112
+ #
113
+ # @return [Symbol, ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status]
114
+ required :status, enum: -> { ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status }
115
+
116
+ # @!method initialize(age_ms:, status:)
117
+ # Some parameter documentations has been truncated, see
118
+ # {ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata} for more details.
119
+ #
120
+ # Cache outcome for this response. Composite responses are hits only when every
121
+ # cache-controlled fetch contributing to the output was a hit; age_ms is the
122
+ # oldest contributing hit.
123
+ #
124
+ # @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
125
+ #
126
+ # @param status [Symbol, ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
127
+
128
+ # Whether the response was served from cache, required fresh work, or honored
129
+ # zero-data-retention cache bypass.
130
+ #
131
+ # @see ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata#status
132
+ module Status
133
+ extend ContextDev::Internal::Type::Enum
134
+
135
+ HIT = :hit
136
+ MISS = :miss
137
+ ZDR = :zdr
138
+
139
+ # @!method self.values
140
+ # @return [Array<Symbol>]
141
+ end
142
+ end
143
+
91
144
  # @see ContextDev::Models::WebWebScrapeMdResponse#metadata
92
145
  class Metadata < ContextDev::Internal::Type::BaseModel
93
146
  # @!attribute final_url
@@ -21,6 +21,13 @@ module ContextDev
21
21
  # @return [Hash{Symbol=>String}, nil]
22
22
  optional :headers, ContextDev::Internal::Type::HashOf[String]
23
23
 
24
+ # @!attribute include_subdomains
25
+ # When true, discover and include public pages and sitemaps on subdomains of the
26
+ # requested domain. Defaults to false.
27
+ #
28
+ # @return [Boolean, nil]
29
+ optional :include_subdomains, ContextDev::Internal::Type::Boolean
30
+
24
31
  # @!attribute max_links
25
32
  # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
26
33
  # Minimum is 1, maximum is 100,000.
@@ -75,7 +82,7 @@ module ContextDev
75
82
  # @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::Zdr, nil]
76
83
  optional :zdr, enum: -> { ContextDev::WebWebScrapeSitemapParams::Zdr }
77
84
 
78
- # @!method initialize(domain:, headers: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
85
+ # @!method initialize(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
79
86
  # Some parameter documentations has been truncated, see
80
87
  # {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
81
88
  #
@@ -83,6 +90,8 @@ module ContextDev
83
90
  #
84
91
  # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
85
92
  #
93
+ # @param include_subdomains [Boolean] When true, discover and include public pages and sitemaps on subdomains of the r
94
+ #
86
95
  # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
87
96
  #
88
97
  # @param search [String] Optional search phrase. When provided, the crawled sitemap is filtered to the pa