context.dev 2.4.0 → 2.6.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 +29 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +4 -0
- data/lib/context_dev/models/ai_extract_product_params.rb +9 -1
- data/lib/context_dev/models/ai_extract_products_params.rb +18 -2
- data/lib/context_dev/models/batch_cancel_params.rb +22 -0
- data/lib/context_dev/models/batch_cancel_response.rb +354 -0
- data/lib/context_dev/models/batch_get_results_params.rb +42 -0
- data/lib/context_dev/models/batch_get_results_response.rb +463 -0
- data/lib/context_dev/models/batch_list_params.rb +94 -0
- data/lib/context_dev/models/batch_list_response.rb +388 -0
- data/lib/context_dev/models/batch_retrieve_params.rb +22 -0
- data/lib/context_dev/models/batch_retrieve_response.rb +390 -0
- data/lib/context_dev/models/batch_submit_params.rb +56 -0
- data/lib/context_dev/models/batch_submit_response.rb +614 -0
- data/lib/context_dev/models/brand_retrieve_params.rb +109 -22
- data/lib/context_dev/models/brand_retrieve_response.rb +4 -6
- data/lib/context_dev/models/brand_retrieve_simplified_params.rb +32 -3
- data/lib/context_dev/models/error.rb +26 -0
- data/lib/context_dev/models/error_count.rb +26 -0
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +11 -1
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +11 -1
- data/lib/context_dev/models/monitor_create_params.rb +147 -132
- data/lib/context_dev/models/monitor_create_response.rb +40 -15
- data/lib/context_dev/models/monitor_get_credit_usage_params.rb +30 -0
- data/lib/context_dev/models/monitor_get_credit_usage_response.rb +59 -0
- data/lib/context_dev/models/monitor_get_limits_params.rb +14 -0
- data/lib/context_dev/models/monitor_get_limits_response.rb +52 -0
- data/lib/context_dev/models/monitor_list_account_changes_params.rb +16 -7
- data/lib/context_dev/models/monitor_list_account_changes_response.rb +2 -1
- data/lib/context_dev/models/monitor_list_account_runs_params.rb +7 -10
- data/lib/context_dev/models/monitor_list_changes_params.rb +8 -4
- data/lib/context_dev/models/monitor_list_changes_response.rb +2 -1
- data/lib/context_dev/models/monitor_list_params.rb +18 -19
- data/lib/context_dev/models/monitor_list_response.rb +27 -12
- data/lib/context_dev/models/monitor_list_runs_params.rb +7 -10
- data/lib/context_dev/models/monitor_retrieve_change_response.rb +2 -1
- data/lib/context_dev/models/monitor_retrieve_response.rb +27 -12
- data/lib/context_dev/models/monitor_update_params.rb +27 -12
- data/lib/context_dev/models/monitor_update_response.rb +27 -12
- data/lib/context_dev/models/parse_handle_params.rb +199 -33
- data/lib/context_dev/models/utility_prefetch_params.rb +9 -1
- data/lib/context_dev/models/web_extract_competitors_params.rb +11 -1
- data/lib/context_dev/models/web_extract_fonts_params.rb +14 -4
- data/lib/context_dev/models/web_extract_params.rb +19 -1
- data/lib/context_dev/models/web_extract_styleguide_params.rb +14 -4
- data/lib/context_dev/models/web_screenshot_params.rb +69 -18
- data/lib/context_dev/models/web_screenshot_response.rb +3 -2
- data/lib/context_dev/models/web_search_params.rb +9 -1
- data/lib/context_dev/models/web_web_crawl_md_params.rb +34 -1
- data/lib/context_dev/models/web_web_scrape_html_params.rb +268 -29
- data/lib/context_dev/models/web_web_scrape_html_response.rb +93 -1
- data/lib/context_dev/models/web_web_scrape_images_params.rb +208 -19
- data/lib/context_dev/models/web_web_scrape_md_params.rb +352 -38
- data/lib/context_dev/models/web_web_scrape_md_response.rb +93 -1
- data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +45 -1
- data/lib/context_dev/models.rb +18 -0
- data/lib/context_dev/resources/ai.rb +3 -1
- data/lib/context_dev/resources/batch.rb +155 -0
- data/lib/context_dev/resources/brand.rb +6 -2
- data/lib/context_dev/resources/industry.rb +6 -2
- data/lib/context_dev/resources/monitors.rb +75 -37
- data/lib/context_dev/resources/parse.rb +15 -11
- data/lib/context_dev/resources/utility.rb +3 -1
- data/lib/context_dev/resources/web.rb +104 -55
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +17 -0
- data/rbi/context_dev/client.rbi +3 -0
- data/rbi/context_dev/models/ai_extract_product_params.rbi +11 -0
- data/rbi/context_dev/models/ai_extract_products_params.rbi +22 -0
- data/rbi/context_dev/models/batch_cancel_params.rbi +40 -0
- data/rbi/context_dev/models/batch_cancel_response.rbi +642 -0
- data/rbi/context_dev/models/batch_get_results_params.rbi +70 -0
- data/rbi/context_dev/models/batch_get_results_response.rbi +848 -0
- data/rbi/context_dev/models/batch_list_params.rbi +166 -0
- data/rbi/context_dev/models/batch_list_response.rbi +738 -0
- data/rbi/context_dev/models/batch_retrieve_params.rbi +40 -0
- data/rbi/context_dev/models/batch_retrieve_response.rbi +707 -0
- data/rbi/context_dev/models/batch_submit_params.rbi +105 -0
- data/rbi/context_dev/models/batch_submit_response.rbi +1330 -0
- data/rbi/context_dev/models/brand_retrieve_params.rbi +175 -64
- data/rbi/context_dev/models/brand_retrieve_response.rbi +8 -11
- data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +68 -5
- data/rbi/context_dev/models/error.rbi +32 -0
- data/rbi/context_dev/models/error_count.rbi +34 -0
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +15 -0
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +15 -0
- data/rbi/context_dev/models/monitor_create_params.rbi +280 -246
- data/rbi/context_dev/models/monitor_create_response.rbi +44 -11
- data/rbi/context_dev/models/monitor_get_credit_usage_params.rbi +60 -0
- data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +111 -0
- data/rbi/context_dev/models/monitor_get_limits_params.rbi +30 -0
- data/rbi/context_dev/models/monitor_get_limits_response.rbi +105 -0
- data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +16 -0
- data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +2 -0
- data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +7 -6
- data/rbi/context_dev/models/monitor_list_changes_params.rbi +8 -0
- data/rbi/context_dev/models/monitor_list_changes_response.rbi +2 -0
- data/rbi/context_dev/models/monitor_list_params.rbi +23 -31
- data/rbi/context_dev/models/monitor_list_response.rbi +30 -9
- data/rbi/context_dev/models/monitor_list_runs_params.rbi +7 -6
- data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +2 -0
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +30 -9
- data/rbi/context_dev/models/monitor_update_params.rbi +30 -9
- data/rbi/context_dev/models/monitor_update_response.rbi +30 -9
- data/rbi/context_dev/models/parse_handle_params.rbi +400 -46
- data/rbi/context_dev/models/utility_prefetch_params.rbi +11 -0
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +15 -0
- data/rbi/context_dev/models/web_extract_fonts_params.rbi +19 -7
- data/rbi/context_dev/models/web_extract_params.rbi +26 -0
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +19 -7
- data/rbi/context_dev/models/web_screenshot_params.rbi +108 -37
- data/rbi/context_dev/models/web_screenshot_response.rbi +4 -2
- data/rbi/context_dev/models/web_search_params.rbi +11 -0
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +53 -0
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +554 -49
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +182 -0
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +426 -30
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +742 -61
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +180 -0
- data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +82 -0
- data/rbi/context_dev/models.rbi +18 -0
- data/rbi/context_dev/resources/ai.rbi +3 -0
- data/rbi/context_dev/resources/batch.rbi +120 -0
- data/rbi/context_dev/resources/brand.rbi +9 -1
- data/rbi/context_dev/resources/industry.rbi +10 -0
- data/rbi/context_dev/resources/monitors.rbi +67 -23
- data/rbi/context_dev/resources/parse.rbi +46 -19
- data/rbi/context_dev/resources/utility.rbi +3 -0
- data/rbi/context_dev/resources/web.rbi +224 -48
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/ai_extract_product_params.rbs +12 -1
- data/sig/context_dev/models/ai_extract_products_params.rbs +14 -0
- data/sig/context_dev/models/batch_cancel_params.rbs +23 -0
- data/sig/context_dev/models/batch_cancel_response.rbs +266 -0
- data/sig/context_dev/models/batch_get_results_params.rbs +36 -0
- data/sig/context_dev/models/batch_get_results_response.rbs +399 -0
- data/sig/context_dev/models/batch_list_params.rbs +94 -0
- data/sig/context_dev/models/batch_list_response.rbs +304 -0
- data/sig/context_dev/models/batch_retrieve_params.rbs +23 -0
- data/sig/context_dev/models/batch_retrieve_response.rbs +290 -0
- data/sig/context_dev/models/batch_submit_params.rbs +52 -0
- data/sig/context_dev/models/batch_submit_response.rbs +542 -0
- data/sig/context_dev/models/brand_retrieve_params.rbs +97 -51
- data/sig/context_dev/models/brand_retrieve_response.rbs +2 -2
- data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +34 -5
- data/sig/context_dev/models/error.rbs +15 -0
- data/sig/context_dev/models/error_count.rbs +15 -0
- data/sig/context_dev/models/industry_retrieve_naics_params.rbs +7 -0
- data/sig/context_dev/models/industry_retrieve_sic_params.rbs +7 -0
- data/sig/context_dev/models/monitor_create_params.rbs +117 -97
- data/sig/context_dev/models/monitor_create_response.rbs +18 -1
- data/sig/context_dev/models/monitor_get_credit_usage_params.rbs +32 -0
- data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +52 -0
- data/sig/context_dev/models/monitor_get_limits_params.rbs +15 -0
- data/sig/context_dev/models/monitor_get_limits_response.rbs +43 -0
- data/sig/context_dev/models/monitor_list_params.rbs +8 -14
- data/sig/context_dev/models/monitor_list_response.rbs +13 -1
- data/sig/context_dev/models/monitor_retrieve_response.rbs +13 -1
- data/sig/context_dev/models/monitor_update_params.rbs +13 -1
- data/sig/context_dev/models/monitor_update_response.rbs +13 -1
- data/sig/context_dev/models/parse_handle_params.rbs +124 -25
- data/sig/context_dev/models/utility_prefetch_params.rbs +7 -0
- data/sig/context_dev/models/web_extract_competitors_params.rbs +12 -1
- data/sig/context_dev/models/web_extract_fonts_params.rbs +10 -5
- data/sig/context_dev/models/web_extract_params.rbs +14 -0
- data/sig/context_dev/models/web_extract_styleguide_params.rbs +10 -5
- data/sig/context_dev/models/web_screenshot_params.rbs +41 -20
- data/sig/context_dev/models/web_search_params.rbs +7 -0
- data/sig/context_dev/models/web_web_crawl_md_params.rbs +28 -1
- data/sig/context_dev/models/web_web_scrape_html_params.rbs +175 -47
- data/sig/context_dev/models/web_web_scrape_html_response.rbs +85 -0
- data/sig/context_dev/models/web_web_scrape_images_params.rbs +128 -38
- data/sig/context_dev/models/web_web_scrape_md_params.rbs +229 -62
- data/sig/context_dev/models/web_web_scrape_md_response.rbs +85 -0
- data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +35 -1
- data/sig/context_dev/models.rbs +18 -0
- data/sig/context_dev/resources/ai.rbs +1 -0
- data/sig/context_dev/resources/batch.rbs +41 -0
- data/sig/context_dev/resources/brand.rbs +3 -1
- data/sig/context_dev/resources/industry.rbs +2 -0
- data/sig/context_dev/resources/monitors.rbs +14 -4
- data/sig/context_dev/resources/parse.rbs +8 -5
- data/sig/context_dev/resources/utility.rbs +1 -0
- data/sig/context_dev/resources/web.rbs +47 -26
- metadata +53 -2
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
# @see ContextDev::Resources::Monitors#get_limits
|
|
6
|
+
class MonitorGetLimitsResponse < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute monitors_limit
|
|
8
|
+
# Maximum number of monitors allowed for the account. Defaults to the plan
|
|
9
|
+
# allowance unless a custom limit is set for the organization.
|
|
10
|
+
#
|
|
11
|
+
# @return [Integer]
|
|
12
|
+
required :monitors_limit, Integer
|
|
13
|
+
|
|
14
|
+
# @!attribute monitors_used
|
|
15
|
+
# Number of monitors the account currently has.
|
|
16
|
+
#
|
|
17
|
+
# @return [Integer]
|
|
18
|
+
required :monitors_used, Integer
|
|
19
|
+
|
|
20
|
+
# @!attribute plan
|
|
21
|
+
# The plan tier the limit was resolved from.
|
|
22
|
+
#
|
|
23
|
+
# @return [Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan]
|
|
24
|
+
required :plan, enum: -> { ContextDev::Models::MonitorGetLimitsResponse::Plan }
|
|
25
|
+
|
|
26
|
+
# @!method initialize(monitors_limit:, monitors_used:, plan:)
|
|
27
|
+
# Some parameter documentations has been truncated, see
|
|
28
|
+
# {ContextDev::Models::MonitorGetLimitsResponse} for more details.
|
|
29
|
+
#
|
|
30
|
+
# @param monitors_limit [Integer] Maximum number of monitors allowed for the account. Defaults to the plan allowan
|
|
31
|
+
#
|
|
32
|
+
# @param monitors_used [Integer] Number of monitors the account currently has.
|
|
33
|
+
#
|
|
34
|
+
# @param plan [Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan] The plan tier the limit was resolved from.
|
|
35
|
+
|
|
36
|
+
# The plan tier the limit was resolved from.
|
|
37
|
+
#
|
|
38
|
+
# @see ContextDev::Models::MonitorGetLimitsResponse#plan
|
|
39
|
+
module Plan
|
|
40
|
+
extend ContextDev::Internal::Type::Enum
|
|
41
|
+
|
|
42
|
+
FREE = :free
|
|
43
|
+
STARTER = :starter
|
|
44
|
+
PRO = :pro
|
|
45
|
+
SCALE = :scale
|
|
46
|
+
|
|
47
|
+
# @!method self.values
|
|
48
|
+
# @return [Array<Symbol>]
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
@@ -8,27 +8,32 @@ module ContextDev
|
|
|
8
8
|
include ContextDev::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
10
|
# @!attribute change_detection_type
|
|
11
|
+
# Filter by change detection type.
|
|
11
12
|
#
|
|
12
13
|
# @return [Symbol, ContextDev::Models::MonitorListAccountChangesParams::ChangeDetectionType, nil]
|
|
13
14
|
optional :change_detection_type,
|
|
14
15
|
enum: -> { ContextDev::MonitorListAccountChangesParams::ChangeDetectionType }
|
|
15
16
|
|
|
16
17
|
# @!attribute cursor
|
|
18
|
+
# Opaque pagination cursor from a previous response.
|
|
17
19
|
#
|
|
18
20
|
# @return [String, nil]
|
|
19
21
|
optional :cursor, String
|
|
20
22
|
|
|
21
23
|
# @!attribute limit
|
|
24
|
+
# Maximum number of items to return per page (1-100). Defaults to 25.
|
|
22
25
|
#
|
|
23
26
|
# @return [Integer, nil]
|
|
24
27
|
optional :limit, Integer
|
|
25
28
|
|
|
26
29
|
# @!attribute monitor_id
|
|
30
|
+
# Filter changes to a single monitor.
|
|
27
31
|
#
|
|
28
32
|
# @return [String, nil]
|
|
29
33
|
optional :monitor_id, String
|
|
30
34
|
|
|
31
35
|
# @!attribute since
|
|
36
|
+
# Only include items at or after this ISO 8601 timestamp.
|
|
32
37
|
#
|
|
33
38
|
# @return [Time, nil]
|
|
34
39
|
optional :since, Time
|
|
@@ -40,34 +45,37 @@ module ContextDev
|
|
|
40
45
|
optional :tag, String
|
|
41
46
|
|
|
42
47
|
# @!attribute target_type
|
|
48
|
+
# Filter by target type.
|
|
43
49
|
#
|
|
44
50
|
# @return [Symbol, ContextDev::Models::MonitorListAccountChangesParams::TargetType, nil]
|
|
45
51
|
optional :target_type, enum: -> { ContextDev::MonitorListAccountChangesParams::TargetType }
|
|
46
52
|
|
|
47
53
|
# @!attribute until_
|
|
54
|
+
# Only include items before this ISO 8601 timestamp.
|
|
48
55
|
#
|
|
49
56
|
# @return [Time, nil]
|
|
50
57
|
optional :until_, Time
|
|
51
58
|
|
|
52
59
|
# @!method initialize(change_detection_type: nil, cursor: nil, limit: nil, monitor_id: nil, since: nil, tag: nil, target_type: nil, until_: nil, request_options: {})
|
|
53
|
-
# @param change_detection_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::ChangeDetectionType]
|
|
60
|
+
# @param change_detection_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::ChangeDetectionType] Filter by change detection type.
|
|
54
61
|
#
|
|
55
|
-
# @param cursor [String]
|
|
62
|
+
# @param cursor [String] Opaque pagination cursor from a previous response.
|
|
56
63
|
#
|
|
57
|
-
# @param limit [Integer]
|
|
64
|
+
# @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
|
|
58
65
|
#
|
|
59
|
-
# @param monitor_id [String]
|
|
66
|
+
# @param monitor_id [String] Filter changes to a single monitor.
|
|
60
67
|
#
|
|
61
|
-
# @param since [Time]
|
|
68
|
+
# @param since [Time] Only include items at or after this ISO 8601 timestamp.
|
|
62
69
|
#
|
|
63
70
|
# @param tag [String] Filter to items that have this tag.
|
|
64
71
|
#
|
|
65
|
-
# @param target_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::TargetType]
|
|
72
|
+
# @param target_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::TargetType] Filter by target type.
|
|
66
73
|
#
|
|
67
|
-
# @param until_ [Time]
|
|
74
|
+
# @param until_ [Time] Only include items before this ISO 8601 timestamp.
|
|
68
75
|
#
|
|
69
76
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
70
77
|
|
|
78
|
+
# Filter by change detection type.
|
|
71
79
|
module ChangeDetectionType
|
|
72
80
|
extend ContextDev::Internal::Type::Enum
|
|
73
81
|
|
|
@@ -78,6 +86,7 @@ module ContextDev
|
|
|
78
86
|
# @return [Array<Symbol>]
|
|
79
87
|
end
|
|
80
88
|
|
|
89
|
+
# Filter by target type.
|
|
81
90
|
module TargetType
|
|
82
91
|
extend ContextDev::Internal::Type::Enum
|
|
83
92
|
|
|
@@ -102,6 +102,7 @@ module ContextDev
|
|
|
102
102
|
|
|
103
103
|
# @!attribute tags
|
|
104
104
|
# User-defined tags for grouping and filtering monitors and their changes.
|
|
105
|
+
# Duplicates are removed.
|
|
105
106
|
#
|
|
106
107
|
# @return [Array<String>, nil]
|
|
107
108
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -144,7 +145,7 @@ module ContextDev
|
|
|
144
145
|
#
|
|
145
146
|
# @param removed_url_count [Integer]
|
|
146
147
|
#
|
|
147
|
-
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
|
|
148
|
+
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
|
|
148
149
|
|
|
149
150
|
# @see ContextDev::Models::MonitorListAccountChangesResponse::Data#change_detection_type
|
|
150
151
|
module ChangeDetectionType
|
|
@@ -8,36 +8,33 @@ module ContextDev
|
|
|
8
8
|
include ContextDev::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
10
|
# @!attribute cursor
|
|
11
|
+
# Opaque pagination cursor from a previous response.
|
|
11
12
|
#
|
|
12
13
|
# @return [String, nil]
|
|
13
14
|
optional :cursor, String
|
|
14
15
|
|
|
15
16
|
# @!attribute limit
|
|
17
|
+
# Maximum number of items to return per page (1-100). Defaults to 25.
|
|
16
18
|
#
|
|
17
19
|
# @return [Integer, nil]
|
|
18
20
|
optional :limit, Integer
|
|
19
21
|
|
|
20
22
|
# @!attribute status
|
|
21
|
-
#
|
|
22
|
-
# (insufficient credits, monitor paused, or superseded by a concurrent run).
|
|
23
|
+
# Filter runs by lifecycle status.
|
|
23
24
|
#
|
|
24
25
|
# @return [Symbol, ContextDev::Models::MonitorListAccountRunsParams::Status, nil]
|
|
25
26
|
optional :status, enum: -> { ContextDev::MonitorListAccountRunsParams::Status }
|
|
26
27
|
|
|
27
28
|
# @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
|
|
28
|
-
#
|
|
29
|
-
# {ContextDev::Models::MonitorListAccountRunsParams} for more details.
|
|
29
|
+
# @param cursor [String] Opaque pagination cursor from a previous response.
|
|
30
30
|
#
|
|
31
|
-
# @param
|
|
31
|
+
# @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
|
|
32
32
|
#
|
|
33
|
-
# @param
|
|
34
|
-
#
|
|
35
|
-
# @param status [Symbol, ContextDev::Models::MonitorListAccountRunsParams::Status] Lifecycle status of a run. `skipped` runs never executed — see `skip_reason` (in
|
|
33
|
+
# @param status [Symbol, ContextDev::Models::MonitorListAccountRunsParams::Status] Filter runs by lifecycle status.
|
|
36
34
|
#
|
|
37
35
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
38
36
|
|
|
39
|
-
#
|
|
40
|
-
# (insufficient credits, monitor paused, or superseded by a concurrent run).
|
|
37
|
+
# Filter runs by lifecycle status.
|
|
41
38
|
module Status
|
|
42
39
|
extend ContextDev::Internal::Type::Enum
|
|
43
40
|
|
|
@@ -13,16 +13,19 @@ module ContextDev
|
|
|
13
13
|
required :monitor_id, String
|
|
14
14
|
|
|
15
15
|
# @!attribute cursor
|
|
16
|
+
# Opaque pagination cursor from a previous response.
|
|
16
17
|
#
|
|
17
18
|
# @return [String, nil]
|
|
18
19
|
optional :cursor, String
|
|
19
20
|
|
|
20
21
|
# @!attribute limit
|
|
22
|
+
# Maximum number of items to return per page (1-100). Defaults to 25.
|
|
21
23
|
#
|
|
22
24
|
# @return [Integer, nil]
|
|
23
25
|
optional :limit, Integer
|
|
24
26
|
|
|
25
27
|
# @!attribute since
|
|
28
|
+
# Only include items at or after this ISO 8601 timestamp.
|
|
26
29
|
#
|
|
27
30
|
# @return [Time, nil]
|
|
28
31
|
optional :since, Time
|
|
@@ -34,6 +37,7 @@ module ContextDev
|
|
|
34
37
|
optional :tag, String
|
|
35
38
|
|
|
36
39
|
# @!attribute until_
|
|
40
|
+
# Only include items before this ISO 8601 timestamp.
|
|
37
41
|
#
|
|
38
42
|
# @return [Time, nil]
|
|
39
43
|
optional :until_, Time
|
|
@@ -41,15 +45,15 @@ module ContextDev
|
|
|
41
45
|
# @!method initialize(monitor_id:, cursor: nil, limit: nil, since: nil, tag: nil, until_: nil, request_options: {})
|
|
42
46
|
# @param monitor_id [String]
|
|
43
47
|
#
|
|
44
|
-
# @param cursor [String]
|
|
48
|
+
# @param cursor [String] Opaque pagination cursor from a previous response.
|
|
45
49
|
#
|
|
46
|
-
# @param limit [Integer]
|
|
50
|
+
# @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
|
|
47
51
|
#
|
|
48
|
-
# @param since [Time]
|
|
52
|
+
# @param since [Time] Only include items at or after this ISO 8601 timestamp.
|
|
49
53
|
#
|
|
50
54
|
# @param tag [String] Filter to items that have this tag.
|
|
51
55
|
#
|
|
52
|
-
# @param until_ [Time]
|
|
56
|
+
# @param until_ [Time] Only include items before this ISO 8601 timestamp.
|
|
53
57
|
#
|
|
54
58
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
55
59
|
end
|
|
@@ -101,6 +101,7 @@ module ContextDev
|
|
|
101
101
|
|
|
102
102
|
# @!attribute tags
|
|
103
103
|
# User-defined tags for grouping and filtering monitors and their changes.
|
|
104
|
+
# Duplicates are removed.
|
|
104
105
|
#
|
|
105
106
|
# @return [Array<String>, nil]
|
|
106
107
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -143,7 +144,7 @@ module ContextDev
|
|
|
143
144
|
#
|
|
144
145
|
# @param removed_url_count [Integer]
|
|
145
146
|
#
|
|
146
|
-
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
|
|
147
|
+
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
|
|
147
148
|
|
|
148
149
|
# @see ContextDev::Models::MonitorListChangesResponse::Data#change_detection_type
|
|
149
150
|
module ChangeDetectionType
|
|
@@ -8,16 +8,19 @@ module ContextDev
|
|
|
8
8
|
include ContextDev::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
10
|
# @!attribute change_detection_type
|
|
11
|
+
# Filter by change detection type.
|
|
11
12
|
#
|
|
12
13
|
# @return [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType, nil]
|
|
13
14
|
optional :change_detection_type, enum: -> { ContextDev::MonitorListParams::ChangeDetectionType }
|
|
14
15
|
|
|
15
16
|
# @!attribute cursor
|
|
17
|
+
# Opaque pagination cursor from a previous response.
|
|
16
18
|
#
|
|
17
19
|
# @return [String, nil]
|
|
18
20
|
optional :cursor, String
|
|
19
21
|
|
|
20
22
|
# @!attribute limit
|
|
23
|
+
# Maximum number of items to return per page (1-100). Defaults to 25.
|
|
21
24
|
#
|
|
22
25
|
# @return [Integer, nil]
|
|
23
26
|
optional :limit, Integer
|
|
@@ -34,7 +37,8 @@ module ContextDev
|
|
|
34
37
|
#
|
|
35
38
|
# @return [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil]
|
|
36
39
|
optional :search_by,
|
|
37
|
-
-> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorListParams::SearchBy] }
|
|
40
|
+
-> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorListParams::SearchBy] },
|
|
41
|
+
nil?: true
|
|
38
42
|
|
|
39
43
|
# @!attribute search_type
|
|
40
44
|
# `prefix` for as-you-type prefix matching (default), `exact` for full-token
|
|
@@ -44,11 +48,7 @@ module ContextDev
|
|
|
44
48
|
optional :search_type, enum: -> { ContextDev::MonitorListParams::SearchType }
|
|
45
49
|
|
|
46
50
|
# @!attribute status
|
|
47
|
-
#
|
|
48
|
-
# monitor's `last_error`); failed monitors keep running on schedule and flip back
|
|
49
|
-
# to `active` on the next successful run. Monitors are auto-`paused` after
|
|
50
|
-
# repeated consecutive failures or insufficient-credit skips; resume by PATCHing
|
|
51
|
-
# status to `active`.
|
|
51
|
+
# Filter monitors by lifecycle status.
|
|
52
52
|
#
|
|
53
53
|
# @return [Symbol, ContextDev::Models::MonitorListParams::Status, nil]
|
|
54
54
|
optional :status, enum: -> { ContextDev::MonitorListParams::Status }
|
|
@@ -63,9 +63,10 @@ module ContextDev
|
|
|
63
63
|
# Comma-separated list of tags to filter by (matches monitors having any of them).
|
|
64
64
|
#
|
|
65
65
|
# @return [Array<String>, nil]
|
|
66
|
-
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
66
|
+
optional :tags, ContextDev::Internal::Type::ArrayOf[String], nil?: true
|
|
67
67
|
|
|
68
68
|
# @!attribute target_type
|
|
69
|
+
# Filter by target type.
|
|
69
70
|
#
|
|
70
71
|
# @return [Symbol, ContextDev::Models::MonitorListParams::TargetType, nil]
|
|
71
72
|
optional :target_type, enum: -> { ContextDev::MonitorListParams::TargetType }
|
|
@@ -74,28 +75,29 @@ module ContextDev
|
|
|
74
75
|
# Some parameter documentations has been truncated, see
|
|
75
76
|
# {ContextDev::Models::MonitorListParams} for more details.
|
|
76
77
|
#
|
|
77
|
-
# @param change_detection_type [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType]
|
|
78
|
+
# @param change_detection_type [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType] Filter by change detection type.
|
|
78
79
|
#
|
|
79
|
-
# @param cursor [String]
|
|
80
|
+
# @param cursor [String] Opaque pagination cursor from a previous response.
|
|
80
81
|
#
|
|
81
|
-
# @param limit [Integer]
|
|
82
|
+
# @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
|
|
82
83
|
#
|
|
83
84
|
# @param q [String] Free-text search term, matched against the fields named in `search_by`.
|
|
84
85
|
#
|
|
85
|
-
# @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy
|
|
86
|
+
# @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil] Comma-separated fields to search with `q`. Defaults to all of them. Note `instru
|
|
86
87
|
#
|
|
87
88
|
# @param search_type [Symbol, ContextDev::Models::MonitorListParams::SearchType] `prefix` for as-you-type prefix matching (default), `exact` for full-token match
|
|
88
89
|
#
|
|
89
|
-
# @param status [Symbol, ContextDev::Models::MonitorListParams::Status]
|
|
90
|
+
# @param status [Symbol, ContextDev::Models::MonitorListParams::Status] Filter monitors by lifecycle status.
|
|
90
91
|
#
|
|
91
92
|
# @param tag [String] Filter to items that have this tag.
|
|
92
93
|
#
|
|
93
|
-
# @param tags [Array<String
|
|
94
|
+
# @param tags [Array<String>, nil] Comma-separated list of tags to filter by (matches monitors having any of them).
|
|
94
95
|
#
|
|
95
|
-
# @param target_type [Symbol, ContextDev::Models::MonitorListParams::TargetType]
|
|
96
|
+
# @param target_type [Symbol, ContextDev::Models::MonitorListParams::TargetType] Filter by target type.
|
|
96
97
|
#
|
|
97
98
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
98
99
|
|
|
100
|
+
# Filter by change detection type.
|
|
99
101
|
module ChangeDetectionType
|
|
100
102
|
extend ContextDev::Internal::Type::Enum
|
|
101
103
|
|
|
@@ -130,11 +132,7 @@ module ContextDev
|
|
|
130
132
|
# @return [Array<Symbol>]
|
|
131
133
|
end
|
|
132
134
|
|
|
133
|
-
#
|
|
134
|
-
# monitor's `last_error`); failed monitors keep running on schedule and flip back
|
|
135
|
-
# to `active` on the next successful run. Monitors are auto-`paused` after
|
|
136
|
-
# repeated consecutive failures or insufficient-credit skips; resume by PATCHing
|
|
137
|
-
# status to `active`.
|
|
135
|
+
# Filter monitors by lifecycle status.
|
|
138
136
|
module Status
|
|
139
137
|
extend ContextDev::Internal::Type::Enum
|
|
140
138
|
|
|
@@ -146,6 +144,7 @@ module ContextDev
|
|
|
146
144
|
# @return [Array<Symbol>]
|
|
147
145
|
end
|
|
148
146
|
|
|
147
|
+
# Filter by target type.
|
|
149
148
|
module TargetType
|
|
150
149
|
extend ContextDev::Internal::Type::Enum
|
|
151
150
|
|
|
@@ -115,6 +115,7 @@ module ContextDev
|
|
|
115
115
|
|
|
116
116
|
# @!attribute tags
|
|
117
117
|
# User-defined tags for grouping and filtering monitors and their changes.
|
|
118
|
+
# Duplicates are removed.
|
|
118
119
|
#
|
|
119
120
|
# @return [Array<String>, nil]
|
|
120
121
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -169,7 +170,7 @@ module ContextDev
|
|
|
169
170
|
#
|
|
170
171
|
# @param next_run_at [Time, nil] When the next scheduled run is due.
|
|
171
172
|
#
|
|
172
|
-
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
|
|
173
|
+
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
|
|
173
174
|
#
|
|
174
175
|
# @param webhook [ContextDev::Models::MonitorListResponse::Data::Webhook, nil]
|
|
175
176
|
#
|
|
@@ -186,7 +187,7 @@ module ContextDev
|
|
|
186
187
|
# Detect exact changes. For page targets, this means visible text diffs. For sitemap targets, this means URL additions and removals.
|
|
187
188
|
variant :exact, -> { ContextDev::Models::MonitorListResponse::Data::ChangeDetection::Exact }
|
|
188
189
|
|
|
189
|
-
# Detect meaning-level changes to
|
|
190
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or instruction-irrelevant differences. Which changes are meaningful is judged against the page or extract target's `instructions` (and an extract target's `schema`, when provided).
|
|
190
191
|
variant :semantic, -> { ContextDev::Models::MonitorListResponse::Data::ChangeDetection::Semantic }
|
|
191
192
|
|
|
192
193
|
class Exact < ContextDev::Internal::Type::BaseModel
|
|
@@ -214,9 +215,10 @@ module ContextDev
|
|
|
214
215
|
optional :confidence_threshold, Float
|
|
215
216
|
|
|
216
217
|
# @!method initialize(confidence_threshold: nil, type: :semantic)
|
|
217
|
-
# Detect meaning-level changes to
|
|
218
|
-
#
|
|
219
|
-
# extract target's `instructions` (and
|
|
218
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or
|
|
219
|
+
# instruction-irrelevant differences. Which changes are meaningful is judged
|
|
220
|
+
# against the page or extract target's `instructions` (and an extract target's
|
|
221
|
+
# `schema`, when provided).
|
|
220
222
|
#
|
|
221
223
|
# @param confidence_threshold [Float]
|
|
222
224
|
# @param type [Symbol, :semantic]
|
|
@@ -322,7 +324,7 @@ module ContextDev
|
|
|
322
324
|
|
|
323
325
|
discriminator :type
|
|
324
326
|
|
|
325
|
-
# Watch a single web page.
|
|
327
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic detection judges confirmed stable diffs against `instructions`.
|
|
326
328
|
variant :page, -> { ContextDev::Models::MonitorListResponse::Data::Target::Page }
|
|
327
329
|
|
|
328
330
|
# Watch a sitemap for URL additions and removals. Crawled URLs are normalized (lowercased host, no trailing slash/fragment) and scoped to the monitored site and its subdomains before comparison. On a detected difference the sitemap is re-fetched within the same run and only URLs both observations agree on are reported, suppressing transient crawl flaps.
|
|
@@ -342,17 +344,30 @@ module ContextDev
|
|
|
342
344
|
# @return [String]
|
|
343
345
|
required :url, String
|
|
344
346
|
|
|
347
|
+
# @!attribute instructions
|
|
348
|
+
# Plain-language goal describing which page changes matter. When provided without
|
|
349
|
+
# change_detection, semantic detection is inferred.
|
|
350
|
+
#
|
|
351
|
+
# @return [String, nil]
|
|
352
|
+
optional :instructions, String
|
|
353
|
+
|
|
345
354
|
# @!attribute normalize_whitespace
|
|
346
355
|
# Normalize whitespace before comparing or analyzing text.
|
|
347
356
|
#
|
|
348
357
|
# @return [Boolean, nil]
|
|
349
358
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
350
359
|
|
|
351
|
-
# @!method initialize(url:, normalize_whitespace: nil, type: :page)
|
|
352
|
-
#
|
|
360
|
+
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
361
|
+
# Some parameter documentations has been truncated, see
|
|
362
|
+
# {ContextDev::Models::MonitorListResponse::Data::Target::Page} for more details.
|
|
363
|
+
#
|
|
364
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic
|
|
365
|
+
# detection judges confirmed stable diffs against `instructions`.
|
|
353
366
|
#
|
|
354
367
|
# @param url [String]
|
|
355
368
|
#
|
|
369
|
+
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
370
|
+
#
|
|
356
371
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
357
372
|
#
|
|
358
373
|
# @param type [Symbol, :page]
|
|
@@ -371,13 +386,13 @@ module ContextDev
|
|
|
371
386
|
required :url, String
|
|
372
387
|
|
|
373
388
|
# @!attribute exclude
|
|
374
|
-
# URL path patterns to exclude.
|
|
389
|
+
# URL path patterns to exclude (max 50).
|
|
375
390
|
#
|
|
376
391
|
# @return [Array<String>, nil]
|
|
377
392
|
optional :exclude, ContextDev::Internal::Type::ArrayOf[String]
|
|
378
393
|
|
|
379
394
|
# @!attribute include
|
|
380
|
-
# URL path patterns to include.
|
|
395
|
+
# URL path patterns to include (max 50).
|
|
381
396
|
#
|
|
382
397
|
# @return [Array<String>, nil]
|
|
383
398
|
optional :include, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -397,9 +412,9 @@ module ContextDev
|
|
|
397
412
|
#
|
|
398
413
|
# @param url [String] Sitemap URL to monitor.
|
|
399
414
|
#
|
|
400
|
-
# @param exclude [Array<String>] URL path patterns to exclude.
|
|
415
|
+
# @param exclude [Array<String>] URL path patterns to exclude (max 50).
|
|
401
416
|
#
|
|
402
|
-
# @param include [Array<String>] URL path patterns to include.
|
|
417
|
+
# @param include [Array<String>] URL path patterns to include (max 50).
|
|
403
418
|
#
|
|
404
419
|
# @param max_urls [Integer] Maximum number of sitemap URLs to track (capped at 10,000).
|
|
405
420
|
#
|
|
@@ -13,38 +13,35 @@ module ContextDev
|
|
|
13
13
|
required :monitor_id, String
|
|
14
14
|
|
|
15
15
|
# @!attribute cursor
|
|
16
|
+
# Opaque pagination cursor from a previous response.
|
|
16
17
|
#
|
|
17
18
|
# @return [String, nil]
|
|
18
19
|
optional :cursor, String
|
|
19
20
|
|
|
20
21
|
# @!attribute limit
|
|
22
|
+
# Maximum number of items to return per page (1-100). Defaults to 25.
|
|
21
23
|
#
|
|
22
24
|
# @return [Integer, nil]
|
|
23
25
|
optional :limit, Integer
|
|
24
26
|
|
|
25
27
|
# @!attribute status
|
|
26
|
-
#
|
|
27
|
-
# (insufficient credits, monitor paused, or superseded by a concurrent run).
|
|
28
|
+
# Filter runs by lifecycle status.
|
|
28
29
|
#
|
|
29
30
|
# @return [Symbol, ContextDev::Models::MonitorListRunsParams::Status, nil]
|
|
30
31
|
optional :status, enum: -> { ContextDev::MonitorListRunsParams::Status }
|
|
31
32
|
|
|
32
33
|
# @!method initialize(monitor_id:, cursor: nil, limit: nil, status: nil, request_options: {})
|
|
33
|
-
# Some parameter documentations has been truncated, see
|
|
34
|
-
# {ContextDev::Models::MonitorListRunsParams} for more details.
|
|
35
|
-
#
|
|
36
34
|
# @param monitor_id [String]
|
|
37
35
|
#
|
|
38
|
-
# @param cursor [String]
|
|
36
|
+
# @param cursor [String] Opaque pagination cursor from a previous response.
|
|
39
37
|
#
|
|
40
|
-
# @param limit [Integer]
|
|
38
|
+
# @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
|
|
41
39
|
#
|
|
42
|
-
# @param status [Symbol, ContextDev::Models::MonitorListRunsParams::Status]
|
|
40
|
+
# @param status [Symbol, ContextDev::Models::MonitorListRunsParams::Status] Filter runs by lifecycle status.
|
|
43
41
|
#
|
|
44
42
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
45
43
|
|
|
46
|
-
#
|
|
47
|
-
# (insufficient credits, monitor paused, or superseded by a concurrent run).
|
|
44
|
+
# Filter runs by lifecycle status.
|
|
48
45
|
module Status
|
|
49
46
|
extend ContextDev::Internal::Type::Enum
|
|
50
47
|
|
|
@@ -45,6 +45,7 @@ module ContextDev
|
|
|
45
45
|
|
|
46
46
|
# @!attribute tags
|
|
47
47
|
# User-defined tags for grouping and filtering monitors and their changes.
|
|
48
|
+
# Duplicates are removed.
|
|
48
49
|
#
|
|
49
50
|
# @return [Array<String>]
|
|
50
51
|
required :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -153,7 +154,7 @@ module ContextDev
|
|
|
153
154
|
#
|
|
154
155
|
# @param summary [String]
|
|
155
156
|
#
|
|
156
|
-
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
|
|
157
|
+
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
|
|
157
158
|
#
|
|
158
159
|
# @param target_type [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType]
|
|
159
160
|
#
|
|
@@ -94,6 +94,7 @@ module ContextDev
|
|
|
94
94
|
|
|
95
95
|
# @!attribute tags
|
|
96
96
|
# User-defined tags for grouping and filtering monitors and their changes.
|
|
97
|
+
# Duplicates are removed.
|
|
97
98
|
#
|
|
98
99
|
# @return [Array<String>, nil]
|
|
99
100
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -146,7 +147,7 @@ module ContextDev
|
|
|
146
147
|
#
|
|
147
148
|
# @param next_run_at [Time, nil] When the next scheduled run is due.
|
|
148
149
|
#
|
|
149
|
-
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
|
|
150
|
+
# @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
|
|
150
151
|
#
|
|
151
152
|
# @param webhook [ContextDev::Models::MonitorRetrieveResponse::Webhook, nil]
|
|
152
153
|
#
|
|
@@ -163,7 +164,7 @@ module ContextDev
|
|
|
163
164
|
# Detect exact changes. For page targets, this means visible text diffs. For sitemap targets, this means URL additions and removals.
|
|
164
165
|
variant :exact, -> { ContextDev::Models::MonitorRetrieveResponse::ChangeDetection::Exact }
|
|
165
166
|
|
|
166
|
-
# Detect meaning-level changes to
|
|
167
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or instruction-irrelevant differences. Which changes are meaningful is judged against the page or extract target's `instructions` (and an extract target's `schema`, when provided).
|
|
167
168
|
variant :semantic, -> { ContextDev::Models::MonitorRetrieveResponse::ChangeDetection::Semantic }
|
|
168
169
|
|
|
169
170
|
class Exact < ContextDev::Internal::Type::BaseModel
|
|
@@ -191,9 +192,10 @@ module ContextDev
|
|
|
191
192
|
optional :confidence_threshold, Float
|
|
192
193
|
|
|
193
194
|
# @!method initialize(confidence_threshold: nil, type: :semantic)
|
|
194
|
-
# Detect meaning-level changes to
|
|
195
|
-
#
|
|
196
|
-
# extract target's `instructions` (and
|
|
195
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or
|
|
196
|
+
# instruction-irrelevant differences. Which changes are meaningful is judged
|
|
197
|
+
# against the page or extract target's `instructions` (and an extract target's
|
|
198
|
+
# `schema`, when provided).
|
|
197
199
|
#
|
|
198
200
|
# @param confidence_threshold [Float]
|
|
199
201
|
# @param type [Symbol, :semantic]
|
|
@@ -299,7 +301,7 @@ module ContextDev
|
|
|
299
301
|
|
|
300
302
|
discriminator :type
|
|
301
303
|
|
|
302
|
-
# Watch a single web page.
|
|
304
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic detection judges confirmed stable diffs against `instructions`.
|
|
303
305
|
variant :page, -> { ContextDev::Models::MonitorRetrieveResponse::Target::Page }
|
|
304
306
|
|
|
305
307
|
# Watch a sitemap for URL additions and removals. Crawled URLs are normalized (lowercased host, no trailing slash/fragment) and scoped to the monitored site and its subdomains before comparison. On a detected difference the sitemap is re-fetched within the same run and only URLs both observations agree on are reported, suppressing transient crawl flaps.
|
|
@@ -319,17 +321,30 @@ module ContextDev
|
|
|
319
321
|
# @return [String]
|
|
320
322
|
required :url, String
|
|
321
323
|
|
|
324
|
+
# @!attribute instructions
|
|
325
|
+
# Plain-language goal describing which page changes matter. When provided without
|
|
326
|
+
# change_detection, semantic detection is inferred.
|
|
327
|
+
#
|
|
328
|
+
# @return [String, nil]
|
|
329
|
+
optional :instructions, String
|
|
330
|
+
|
|
322
331
|
# @!attribute normalize_whitespace
|
|
323
332
|
# Normalize whitespace before comparing or analyzing text.
|
|
324
333
|
#
|
|
325
334
|
# @return [Boolean, nil]
|
|
326
335
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
327
336
|
|
|
328
|
-
# @!method initialize(url:, normalize_whitespace: nil, type: :page)
|
|
329
|
-
#
|
|
337
|
+
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
338
|
+
# Some parameter documentations has been truncated, see
|
|
339
|
+
# {ContextDev::Models::MonitorRetrieveResponse::Target::Page} for more details.
|
|
340
|
+
#
|
|
341
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic
|
|
342
|
+
# detection judges confirmed stable diffs against `instructions`.
|
|
330
343
|
#
|
|
331
344
|
# @param url [String]
|
|
332
345
|
#
|
|
346
|
+
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
347
|
+
#
|
|
333
348
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
334
349
|
#
|
|
335
350
|
# @param type [Symbol, :page]
|
|
@@ -348,13 +363,13 @@ module ContextDev
|
|
|
348
363
|
required :url, String
|
|
349
364
|
|
|
350
365
|
# @!attribute exclude
|
|
351
|
-
# URL path patterns to exclude.
|
|
366
|
+
# URL path patterns to exclude (max 50).
|
|
352
367
|
#
|
|
353
368
|
# @return [Array<String>, nil]
|
|
354
369
|
optional :exclude, ContextDev::Internal::Type::ArrayOf[String]
|
|
355
370
|
|
|
356
371
|
# @!attribute include
|
|
357
|
-
# URL path patterns to include.
|
|
372
|
+
# URL path patterns to include (max 50).
|
|
358
373
|
#
|
|
359
374
|
# @return [Array<String>, nil]
|
|
360
375
|
optional :include, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -374,9 +389,9 @@ module ContextDev
|
|
|
374
389
|
#
|
|
375
390
|
# @param url [String] Sitemap URL to monitor.
|
|
376
391
|
#
|
|
377
|
-
# @param exclude [Array<String>] URL path patterns to exclude.
|
|
392
|
+
# @param exclude [Array<String>] URL path patterns to exclude (max 50).
|
|
378
393
|
#
|
|
379
|
-
# @param include [Array<String>] URL path patterns to include.
|
|
394
|
+
# @param include [Array<String>] URL path patterns to include (max 50).
|
|
380
395
|
#
|
|
381
396
|
# @param max_urls [Integer] Maximum number of sitemap URLs to track (capped at 10,000).
|
|
382
397
|
#
|