Class: ContextDev::Models::WebWebScrapeImagesResponse::Image

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::WebWebScrapeImagesResponse::Image

Defined in:

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

Defined Under Namespace

Modules: Element, Type Classes: Enrichment

Instance Attribute Summary

• #alt ⇒ String^?

  Image alt text, or null when unavailable.

• #element ⇒ Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element

  Where the image was found.

• #enrichment ⇒ ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment^?

  Requested metadata for images that could be processed.

• #src ⇒ String

  Original image value: URL, inline SVG or HTML, or base64 data URI.

• #type ⇒ Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type

  Format of src.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(alt:, element:, src:, type:, enrichment: nil) ⇒ Object constructor
• #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(alt:, element:, src:, type:, enrichment: nil) ⇒ Object

Parameters:

• alt (String, nil) —

  Image alt text, or null when unavailable.

• element (Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element) —

  Where the image was found.

• src (String) —

  Original image value: URL, inline SVG or HTML, or base64 data URI.

• type (Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type) —

  Format of src.

• enrichment (ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment) (defaults to: nil) —

  Requested metadata for images that could be processed.

# File 'lib/context_dev/models/web_web_scrape_images_response.rb', line 140

Instance Attribute Details

#alt ⇒ String^?

Image alt text, or null when unavailable.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/context_dev/models/web_web_scrape_images_response.rb', line 114

required :alt, String, nil?: true

#element ⇒ Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element

Where the image was found.

Parameters:

• value (ContextDev::Models::WebWebScrapeImagesResponse::Image::element)

Returns:

• (Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element)

# File 'lib/context_dev/models/web_web_scrape_images_response.rb', line 120

required :element, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Element }

#enrichment ⇒ ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment^?

Requested metadata for images that could be processed.

Returns:

• (ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment, nil)

# File 'lib/context_dev/models/web_web_scrape_images_response.rb', line 138

optional :enrichment, -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment }

#src ⇒ String

Original image value: URL, inline SVG or HTML, or base64 data URI.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/context_dev/models/web_web_scrape_images_response.rb', line 126

required :src, String

#type ⇒ Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type

Format of src.

Parameters:

• value (ContextDev::Models::WebWebScrapeImagesResponse::Image::type_)

Returns:

• (Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type)

# File 'lib/context_dev/models/web_web_scrape_images_response.rb', line 132

required :type, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/context_dev/models/web_web_scrape_images_response.rb', line 167

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/context_dev/models/web_web_scrape_images_response.rbs', line 118

def to_hash: -> {