context.dev 2.7.0 → 2.9.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 +23 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +5 -0
- data/lib/context_dev/models/batch_delete_params.rb +22 -0
- data/lib/context_dev/models/batch_delete_response.rb +60 -0
- data/lib/context_dev/models/batch_get_results_response.rb +13 -1
- data/lib/context_dev/models/batch_list_response.rb +13 -4
- data/lib/context_dev/models/batch_retrieve_response.rb +13 -4
- data/lib/context_dev/models/batch_submit_params.rb +2352 -26
- data/lib/context_dev/models/batch_submit_response.rb +125 -531
- data/lib/context_dev/models/brand_retrieve_response.rb +50 -1
- data/lib/context_dev/models/brand_search_params.rb +36 -0
- data/lib/context_dev/models/brand_search_response.rb +85 -0
- data/lib/context_dev/models/crawl_controls.rb +21 -15
- data/lib/context_dev/models/parse_handle_params.rb +11 -9
- data/lib/context_dev/models/person_enrich_params.rb +176 -0
- data/lib/context_dev/models/person_enrich_response.rb +581 -0
- data/lib/context_dev/models/web_search_response.rb +1 -0
- data/lib/context_dev/models/web_web_crawl_md_params.rb +5 -4
- data/lib/context_dev/models/web_web_scrape_html_params.rb +11 -9
- data/lib/context_dev/models/web_web_scrape_md_params.rb +11 -9
- data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +11 -1
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +3 -2
- data/lib/context_dev/models.rb +6 -0
- data/lib/context_dev/resources/batch.rb +33 -7
- data/lib/context_dev/resources/brand.rb +35 -0
- data/lib/context_dev/resources/parse.rb +1 -1
- data/lib/context_dev/resources/people.rb +56 -0
- data/lib/context_dev/resources/web.rb +21 -2
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +7 -0
- data/rbi/context_dev/client.rbi +4 -0
- data/rbi/context_dev/models/batch_delete_params.rbi +40 -0
- data/rbi/context_dev/models/batch_delete_response.rbi +116 -0
- data/rbi/context_dev/models/batch_get_results_response.rbi +14 -1
- data/rbi/context_dev/models/batch_list_response.rbi +24 -8
- data/rbi/context_dev/models/batch_retrieve_response.rbi +24 -8
- data/rbi/context_dev/models/batch_submit_params.rbi +6955 -44
- data/rbi/context_dev/models/batch_submit_response.rbi +184 -1151
- data/rbi/context_dev/models/brand_retrieve_response.rbi +152 -0
- data/rbi/context_dev/models/brand_search_params.rbi +60 -0
- data/rbi/context_dev/models/brand_search_response.rbi +148 -0
- data/rbi/context_dev/models/crawl_controls.rbi +22 -28
- data/rbi/context_dev/models/parse_handle_params.rbi +15 -12
- data/rbi/context_dev/models/person_enrich_params.rbi +332 -0
- data/rbi/context_dev/models/person_enrich_response.rbi +1208 -0
- data/rbi/context_dev/models/web_search_response.rbi +5 -0
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +8 -6
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +15 -12
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +15 -12
- data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +15 -0
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +4 -2
- data/rbi/context_dev/models.rbi +6 -0
- data/rbi/context_dev/resources/batch.rbi +32 -10
- data/rbi/context_dev/resources/brand.rbi +27 -0
- data/rbi/context_dev/resources/parse.rbi +5 -5
- data/rbi/context_dev/resources/people.rbi +47 -0
- data/rbi/context_dev/resources/web.rbi +23 -1
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/batch_delete_params.rbs +23 -0
- data/sig/context_dev/models/batch_delete_response.rbs +57 -0
- data/sig/context_dev/models/batch_get_results_response.rbs +9 -2
- data/sig/context_dev/models/batch_list_response.rbs +16 -2
- data/sig/context_dev/models/batch_retrieve_response.rbs +16 -2
- data/sig/context_dev/models/batch_submit_params.rbs +2756 -15
- data/sig/context_dev/models/batch_submit_response.rbs +78 -466
- data/sig/context_dev/models/brand_retrieve_response.rbs +62 -0
- data/sig/context_dev/models/brand_search_params.rbs +30 -0
- data/sig/context_dev/models/brand_search_response.rbs +62 -0
- data/sig/context_dev/models/crawl_controls.rbs +16 -16
- data/sig/context_dev/models/person_enrich_params.rbs +199 -0
- data/sig/context_dev/models/person_enrich_response.rbs +607 -0
- data/sig/context_dev/models/web_search_response.rbs +2 -0
- data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +7 -0
- data/sig/context_dev/models.rbs +6 -0
- data/sig/context_dev/resources/batch.rbs +8 -2
- data/sig/context_dev/resources/brand.rbs +6 -0
- data/sig/context_dev/resources/people.rbs +19 -0
- data/sig/context_dev/resources/web.rbs +1 -0
- metadata +23 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 69a2da1329540a2c1c0c290e8a62fbf719dfd285d7bafa68f0f1bae6a691d46d
|
|
4
|
+
data.tar.gz: 6bb32ce7431dbc1d7e831d6401058a52e6fec88bce87f782c12bc77a2f94d945
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 05f9612ffb040bf683cf176f4c29054037587a7896fce546afc631b0c412075a5292bdcb60ef8d7cf7aa9b665ba8b555d2a4e8f6697989e9effb1eed243597b5
|
|
7
|
+
data.tar.gz: a98751043b31c39b8005fe357584cbddbd0685b8af8e400c6ca3f227f49cee25a07e6c4346d773be85bac7a4480d5e3ac0d32c9496c5b7b775c7fc41dfc5a01b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.9.0 (2026-08-07)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v2.8.0...v2.9.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.8.0...v2.9.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([ea29f67](https://github.com/context-dot-dev/context-ruby-sdk/commit/ea29f67042bd6fd9b987d7ad4ad9f8993a871653))
|
|
10
|
+
* **api:** api update ([e7c64e4](https://github.com/context-dot-dev/context-ruby-sdk/commit/e7c64e4540db4cc313d70cebe5409739b052e567))
|
|
11
|
+
* **api:** api update ([975de89](https://github.com/context-dot-dev/context-ruby-sdk/commit/975de893c9145f20f541a443730d7d99f575a313))
|
|
12
|
+
* **api:** api update ([a1f13c2](https://github.com/context-dot-dev/context-ruby-sdk/commit/a1f13c2244b0ac81a58c350e6cba79875e0c4bf1))
|
|
13
|
+
* **api:** api update ([e7cfd87](https://github.com/context-dot-dev/context-ruby-sdk/commit/e7cfd87ff2e163f572cc33ee4b6af5be79811d03))
|
|
14
|
+
* **api:** api update ([c827408](https://github.com/context-dot-dev/context-ruby-sdk/commit/c8274088947813e1090d6232190b5333c025696a))
|
|
15
|
+
* **api:** api update ([5c09f03](https://github.com/context-dot-dev/context-ruby-sdk/commit/5c09f03dd90cda2cad388ac2605d6cadebf0e137))
|
|
16
|
+
* **api:** manual updates ([cf2f79f](https://github.com/context-dot-dev/context-ruby-sdk/commit/cf2f79ff77dca3e57069cfac612e7fd333a8d83f))
|
|
17
|
+
|
|
18
|
+
## 2.8.0 (2026-08-05)
|
|
19
|
+
|
|
20
|
+
Full Changelog: [v2.7.0...v2.8.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.7.0...v2.8.0)
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* **api:** manual updates ([054713e](https://github.com/context-dot-dev/context-ruby-sdk/commit/054713ecd7a6c12c29a2aaf0df0ea0eeb0ff61fc))
|
|
25
|
+
|
|
3
26
|
## 2.7.0 (2026-08-01)
|
|
4
27
|
|
|
5
28
|
Full Changelog: [v2.6.0...v2.7.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.6.0...v2.7.0)
|
data/README.md
CHANGED
data/lib/context_dev/client.rb
CHANGED
|
@@ -43,9 +43,13 @@ module ContextDev
|
|
|
43
43
|
# @return [ContextDev::Resources::Monitors]
|
|
44
44
|
attr_reader :monitors
|
|
45
45
|
|
|
46
|
+
# Scrape many pages or crawl a site asynchronously.
|
|
46
47
|
# @return [ContextDev::Resources::Batch]
|
|
47
48
|
attr_reader :batch
|
|
48
49
|
|
|
50
|
+
# @return [ContextDev::Resources::People]
|
|
51
|
+
attr_reader :people
|
|
52
|
+
|
|
49
53
|
# @api private
|
|
50
54
|
#
|
|
51
55
|
# @return [Hash{String=>String}]
|
|
@@ -115,6 +119,7 @@ module ContextDev
|
|
|
115
119
|
@utility = ContextDev::Resources::Utility.new(client: self)
|
|
116
120
|
@monitors = ContextDev::Resources::Monitors.new(client: self)
|
|
117
121
|
@batch = ContextDev::Resources::Batch.new(client: self)
|
|
122
|
+
@people = ContextDev::Resources::People.new(client: self)
|
|
118
123
|
end
|
|
119
124
|
end
|
|
120
125
|
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
# @see ContextDev::Resources::Batch#delete
|
|
6
|
+
class BatchDeleteParams < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
extend ContextDev::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include ContextDev::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute batch_id
|
|
11
|
+
# ID of the batch to retrieve or cancel.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :batch_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(batch_id:, request_options: {})
|
|
17
|
+
# @param batch_id [String] ID of the batch to retrieve or cancel.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
# @see ContextDev::Resources::Batch#delete
|
|
6
|
+
class BatchDeleteResponse < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# ID of the deleted batch.
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute deleted
|
|
14
|
+
# Always true on success.
|
|
15
|
+
#
|
|
16
|
+
# @return [Boolean, nil]
|
|
17
|
+
optional :deleted, ContextDev::Internal::Type::Boolean
|
|
18
|
+
|
|
19
|
+
# @!attribute key_metadata
|
|
20
|
+
# Metadata about the API key used for the request. Included in every response
|
|
21
|
+
# whenever a valid API key is provided, even when the response status is not 200.
|
|
22
|
+
#
|
|
23
|
+
# @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
|
|
24
|
+
optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
|
|
25
|
+
|
|
26
|
+
# @!method initialize(id: nil, deleted: nil, key_metadata: nil)
|
|
27
|
+
# Some parameter documentations has been truncated, see
|
|
28
|
+
# {ContextDev::Models::BatchDeleteResponse} for more details.
|
|
29
|
+
#
|
|
30
|
+
# @param id [String] ID of the deleted batch.
|
|
31
|
+
#
|
|
32
|
+
# @param deleted [Boolean] Always true on success.
|
|
33
|
+
#
|
|
34
|
+
# @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
|
|
35
|
+
|
|
36
|
+
# @see ContextDev::Models::BatchDeleteResponse#key_metadata
|
|
37
|
+
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
38
|
+
# @!attribute credits_consumed
|
|
39
|
+
# The number of credits consumed by this request.
|
|
40
|
+
#
|
|
41
|
+
# @return [Integer]
|
|
42
|
+
required :credits_consumed, Integer
|
|
43
|
+
|
|
44
|
+
# @!attribute credits_remaining
|
|
45
|
+
# The number of credits remaining for your organization after this request.
|
|
46
|
+
#
|
|
47
|
+
# @return [Integer]
|
|
48
|
+
required :credits_remaining, Integer
|
|
49
|
+
|
|
50
|
+
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
51
|
+
# Metadata about the API key used for the request. Included in every response
|
|
52
|
+
# whenever a valid API key is provided, even when the response status is not 200.
|
|
53
|
+
#
|
|
54
|
+
# @param credits_consumed [Integer] The number of credits consumed by this request.
|
|
55
|
+
#
|
|
56
|
+
# @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
@@ -109,7 +109,17 @@ module ContextDev
|
|
|
109
109
|
# @return [Hash{Symbol=>Object}, nil]
|
|
110
110
|
optional :meta, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
|
|
111
111
|
|
|
112
|
-
# @!
|
|
112
|
+
# @!attribute ocr_pages
|
|
113
|
+
# PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
|
|
114
|
+
# bills 1 credit on top of the page base credit; absent when no OCR ran.
|
|
115
|
+
#
|
|
116
|
+
# @return [Integer, nil]
|
|
117
|
+
optional :ocr_pages, Integer
|
|
118
|
+
|
|
119
|
+
# @!method initialize(final_url:, http_status:, metadata:, url:, html: nil, item_id: nil, markdown: nil, meta: nil, ocr_pages: nil, status: :ok)
|
|
120
|
+
# Some parameter documentations has been truncated, see
|
|
121
|
+
# {ContextDev::Models::BatchGetResultsResponse::Data::Ok} for more details.
|
|
122
|
+
#
|
|
113
123
|
# A page the batch fetched successfully.
|
|
114
124
|
#
|
|
115
125
|
# @param final_url [String] URL the content was read from, after redirects.
|
|
@@ -128,6 +138,8 @@ module ContextDev
|
|
|
128
138
|
#
|
|
129
139
|
# @param meta [Hash{Symbol=>Object}] Caller-supplied metadata echoed from submission.
|
|
130
140
|
#
|
|
141
|
+
# @param ocr_pages [Integer] PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
|
|
142
|
+
#
|
|
131
143
|
# @param status [Symbol, :ok] The page was scraped.
|
|
132
144
|
|
|
133
145
|
# @see ContextDev::Models::BatchGetResultsResponse::Data::Ok#metadata
|
|
@@ -160,12 +160,19 @@ module ContextDev
|
|
|
160
160
|
# @see ContextDev::Models::BatchListResponse::Data#credits
|
|
161
161
|
class Credits < ContextDev::Internal::Type::BaseModel
|
|
162
162
|
# @!attribute net
|
|
163
|
-
# `reserved` minus `refunded` — what the batch has cost so far.
|
|
164
|
-
# `reserved` until the batch settles.
|
|
163
|
+
# `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
|
|
164
|
+
# Equal to `reserved` until the batch settles.
|
|
165
165
|
#
|
|
166
166
|
# @return [Integer]
|
|
167
167
|
required :net, Integer
|
|
168
168
|
|
|
169
|
+
# @!attribute ocr_charged
|
|
170
|
+
# Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered
|
|
171
|
+
# page, on top of `reserved`. Stays 0 until the batch settles.
|
|
172
|
+
#
|
|
173
|
+
# @return [Integer]
|
|
174
|
+
required :ocr_charged, Integer
|
|
175
|
+
|
|
169
176
|
# @!attribute refunded
|
|
170
177
|
# Credits returned for pages that did not succeed. Stays 0 until the batch reaches
|
|
171
178
|
# a final status, then settles in one movement.
|
|
@@ -180,13 +187,15 @@ module ContextDev
|
|
|
180
187
|
# @return [Integer]
|
|
181
188
|
required :reserved, Integer
|
|
182
189
|
|
|
183
|
-
# @!method initialize(net:, refunded:, reserved:)
|
|
190
|
+
# @!method initialize(net:, ocr_charged:, refunded:, reserved:)
|
|
184
191
|
# Some parameter documentations has been truncated, see
|
|
185
192
|
# {ContextDev::Models::BatchListResponse::Data::Credits} for more details.
|
|
186
193
|
#
|
|
187
194
|
# What this batch has done to your credit balance.
|
|
188
195
|
#
|
|
189
|
-
# @param net [Integer] `reserved` minus `refunded` — what the batch has cost so far.
|
|
196
|
+
# @param net [Integer] `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
|
|
197
|
+
#
|
|
198
|
+
# @param ocr_charged [Integer] Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered p
|
|
190
199
|
#
|
|
191
200
|
# @param refunded [Integer] Credits returned for pages that did not succeed. Stays 0 until the batch reaches
|
|
192
201
|
#
|
|
@@ -137,12 +137,19 @@ module ContextDev
|
|
|
137
137
|
# @see ContextDev::Models::BatchRetrieveResponse#credits
|
|
138
138
|
class Credits < ContextDev::Internal::Type::BaseModel
|
|
139
139
|
# @!attribute net
|
|
140
|
-
# `reserved` minus `refunded` — what the batch has cost so far.
|
|
141
|
-
# `reserved` until the batch settles.
|
|
140
|
+
# `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
|
|
141
|
+
# Equal to `reserved` until the batch settles.
|
|
142
142
|
#
|
|
143
143
|
# @return [Integer]
|
|
144
144
|
required :net, Integer
|
|
145
145
|
|
|
146
|
+
# @!attribute ocr_charged
|
|
147
|
+
# Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered
|
|
148
|
+
# page, on top of `reserved`. Stays 0 until the batch settles.
|
|
149
|
+
#
|
|
150
|
+
# @return [Integer]
|
|
151
|
+
required :ocr_charged, Integer
|
|
152
|
+
|
|
146
153
|
# @!attribute refunded
|
|
147
154
|
# Credits returned for pages that did not succeed. Stays 0 until the batch reaches
|
|
148
155
|
# a final status, then settles in one movement.
|
|
@@ -157,13 +164,15 @@ module ContextDev
|
|
|
157
164
|
# @return [Integer]
|
|
158
165
|
required :reserved, Integer
|
|
159
166
|
|
|
160
|
-
# @!method initialize(net:, refunded:, reserved:)
|
|
167
|
+
# @!method initialize(net:, ocr_charged:, refunded:, reserved:)
|
|
161
168
|
# Some parameter documentations has been truncated, see
|
|
162
169
|
# {ContextDev::Models::BatchRetrieveResponse::Credits} for more details.
|
|
163
170
|
#
|
|
164
171
|
# What this batch has done to your credit balance.
|
|
165
172
|
#
|
|
166
|
-
# @param net [Integer] `reserved` minus `refunded` — what the batch has cost so far.
|
|
173
|
+
# @param net [Integer] `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
|
|
174
|
+
#
|
|
175
|
+
# @param ocr_charged [Integer] Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered p
|
|
167
176
|
#
|
|
168
177
|
# @param refunded [Integer] Credits returned for pages that did not succeed. Stays 0 until the batch reaches
|
|
169
178
|
#
|