Class: ContextDev::Models::MonitorCreateParams::Target::Extract

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/monitor_create_params.rb,
sig/context_dev/models/monitor_create_params.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize ⇒ Object 



190
 
# File 'sig/context_dev/models/monitor_create_params.rbs', line 190

def initialize: (

Instance Attribute Details

#follow_subdomains ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


199
 
# File 'lib/context_dev/models/monitor_create_params.rb', line 199

optional :follow_subdomains, ContextDev::Internal::Type::Boolean

#instructions ⇒ String

Natural-language instructions guiding which pages and facts to track and which changes to report.

Parameters:

  • value (String)

Returns:

  • (String) 


183
 
# File 'lib/context_dev/models/monitor_create_params.rb', line 183

required :instructions, String

#max_depth ⇒ Integer?

Optional maximum link depth from the starting URL (0 = only the starting page).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


205
 
# File 'lib/context_dev/models/monitor_create_params.rb', line 205

optional :max_depth, Integer

#max_pages ⇒ Integer?

Maximum number of pages to track.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


211
 
# File 'lib/context_dev/models/monitor_create_params.rb', line 211

optional :max_pages, Integer

#schema ⇒ Hash{Symbol=>Object}?

JSON Schema describing the data you care about. It is used three ways: it guides which pages are selected for tracking, it gives the change judge extra context on which changes matter (alongside instructions), and it defines the shape of the baseline data snapshot on GET /monitors/monitor_id (refreshed at most about once a day). It is not a response format for changes: change events and webhook payloads always contain diffs, summaries, and evidence excerpts — never data in this schema's shape. If omitted, a default summary + key-points schema is used.

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


224
 
# File 'lib/context_dev/models/monitor_create_params.rb', line 224

optional :schema, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]

#type ⇒ Symbol, :extract

Parameters:

  • value (:extract)

Returns:

  • (Symbol, :extract) 


188
 
# File 'lib/context_dev/models/monitor_create_params.rb', line 188

required :type, const: :extract

#url ⇒ String

Root URL to extract structured data from.

Parameters:

  • value (String)

Returns:

  • (String) 


194
 
# File 'lib/context_dev/models/monitor_create_params.rb', line 194

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


200
 
# File 'sig/context_dev/models/monitor_create_params.rbs', line 200

def to_hash: -> {