Class: ContextDev::Models::WebWebScrapeImagesParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::WebWebScrapeImagesParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/context_dev/models/web_web_scrape_images_params.rb,
sig/context_dev/models/web_web_scrape_images_params.rbs

Overview

See Also:

• ContextDev::Resources::Web#web_scrape_images

Defined Under Namespace

Classes: Enrichment

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ContextDev

Instance Attribute Summary

• #dedupe ⇒ Boolean^?

  When true, visually duplicate images are removed: every image is loaded and perceptually hashed, and only the highest-resolution copy of each duplicate group is kept.

• #enrichment ⇒ ContextDev::Models::WebWebScrapeImagesParams::Enrichment^?

  Optional per-image processing, sent as deep-object query params such as enrichment=true.

• #headers ⇒ Hash{Symbol=>String}^?

  Optional outbound HTTP headers forwarded only to the target URL, sent as deep-object query params such as headers=value.

• #max_age_ms ⇒ Integer^?

  Reuse a cached result this many milliseconds old or newer.

• #timeout_ms ⇒ Integer^?

  Optional timeout in milliseconds for the request.

• #url ⇒ String

  Page URL to inspect.

• #wait_for_ms ⇒ Integer^?

  Optional browser wait time in milliseconds after initial page load before collecting images.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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

# File 'sig/context_dev/models/web_web_scrape_images_params.rbs', line 47

def initialize: (

Instance Attribute Details

#dedupe ⇒ Boolean^?

When true, visually duplicate images are removed: every image is loaded and perceptually hashed, and only the highest-resolution copy of each duplicate group is kept. Images that cannot be downloaded or hashed are kept. Default: false.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/context_dev/models/web_web_scrape_images_params.rb', line 23

optional :dedupe, ContextDev::Internal::Type::Boolean

#enrichment ⇒ ContextDev::Models::WebWebScrapeImagesParams::Enrichment^?

Optional per-image processing, sent as deep-object query params such as enrichment=true.

Returns:

• (ContextDev::Models::WebWebScrapeImagesParams::Enrichment, nil)

# File 'lib/context_dev/models/web_web_scrape_images_params.rb', line 30

optional :enrichment, -> { ContextDev::WebWebScrapeImagesParams::Enrichment }

#headers ⇒ Hash{Symbol=>String}^?

Optional outbound HTTP headers forwarded only to the target URL, sent as deep-object query params such as headers=value. When provided, caching is bypassed: the result is neither read from nor written to cache.

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/context_dev/models/web_web_scrape_images_params.rb', line 38

optional :headers, ContextDev::Internal::Type::HashOf[String]

#max_age_ms ⇒ Integer^?

Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_web_scrape_images_params.rb', line 45

optional :max_age_ms, Integer

#timeout_ms ⇒ Integer^?

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_web_scrape_images_params.rb', line 53

optional :timeout_ms, Integer

#url ⇒ String

Page URL to inspect. Must include http:// or https://.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/context_dev/models/web_web_scrape_images_params.rb', line 14

required :url, String

#wait_for_ms ⇒ Integer^?

Optional browser wait time in milliseconds after initial page load before collecting images. Min: 0. Max: 30000 (30 seconds).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_web_scrape_images_params.rb', line 60

optional :wait_for_ms, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/context_dev/models/web_web_scrape_images_params.rbs', line 58

def to_hash: -> {