Class: ContextDev::Models::WebWebScrapeImagesParams::Enrichment

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

Modules: Classification, HostedURL, Resolution

Instance Attribute Summary

• #classification ⇒ Boolean, ...

  Classify each image by visual asset type.

• #hosted_url ⇒ Boolean, ...

  Host materializable images on the Brand.dev CDN and return their URL and MIME type.

• #max_time_per_ms ⇒ Integer^?

  Per-image enrichment timeout in milliseconds.

• #resolution ⇒ Boolean, ...

  Measure image width and height when possible.

Instance Method Summary

• #initialize(classification: nil, hosted_url: nil, max_time_per_ms: nil, resolution: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Enrichment for more details.

• #to_hash ⇒ {

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(classification: nil, hosted_url: nil, max_time_per_ms: nil, resolution: nil) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::WebWebScrapeImagesParams::Enrichment for more details.

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

Parameters:

• classification (Boolean, Symbol, ContextDev::Models::WebWebScrapeImagesParams::Enrichment::Classification) (defaults to: nil) —

  Classify each image by visual asset type.

• hosted_url (Boolean, Symbol, ContextDev::Models::WebWebScrapeImagesParams::Enrichment::HostedURL) (defaults to: nil) —

  Host materializable images on the Brand.dev CDN and return their URL and MIME ty

• max_time_per_ms (Integer) (defaults to: nil) —

  Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.

• resolution (Boolean, Symbol, ContextDev::Models::WebWebScrapeImagesParams::Enrichment::Resolution) (defaults to: nil) —

  Measure image width and height when possible.

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

Instance Attribute Details

#classification ⇒ Boolean, ...

Classify each image by visual asset type.

Returns:

• (Boolean, Symbol, ContextDev::Models::WebWebScrapeImagesParams::Enrichment::Classification, nil)

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

optional :classification, union: -> { ContextDev::WebWebScrapeImagesParams::Enrichment::Classification }

#hosted_url ⇒ Boolean, ...

Host materializable images on the Brand.dev CDN and return their URL and MIME type.

Returns:

• (Boolean, Symbol, ContextDev::Models::WebWebScrapeImagesParams::Enrichment::HostedURL, nil)

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

optional :hosted_url,
union: -> { ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL },
api_name: :hostedUrl

#max_time_per_ms ⇒ Integer^?

Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :max_time_per_ms, Integer, api_name: :maxTimePerMs

#resolution ⇒ Boolean, ...

Measure image width and height when possible.

Returns:

• (Boolean, Symbol, ContextDev::Models::WebWebScrapeImagesParams::Enrichment::Resolution, nil)

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

optional :resolution, union: -> { ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {