Class: ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata

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

Overview

See Also:

  • ContextDev::Models::WebWebCrawlMdResponse::Result#metadata

Defined Under Namespace

Modules: AdditionalMeta, OpenGraph, Twitter Classes: Alternate, Heading

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(level:, text:) ⇒ Object

Parameters:

  • level (Integer) —

    Heading level, 1–6 (from h1–h6).

  • text (String) —

    Heading text with whitespace collapsed, truncated to 1000 characters.




# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 348

Instance Attribute Details

#additional_meta ⇒ Hash{Symbol=>String, Array<String>}?

Additional non-social meta tags not promoted to top-level metadata fields.

Returns:

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


149
150
151
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 149

optional :additional_meta,
-> { ContextDev::Internal::Type::HashOf[union: ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata::AdditionalMeta] },
api_name: :additionalMeta

#alternates ⇒ Array<ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata::Alternate>?

Resolved alternate links from link rel=alternate tags.

Returns:



157
158
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 157

optional :alternates,
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata::Alternate] }

#author ⇒ String?

Author metadata, when present.

Parameters:

  • (String)

Returns:

  • (String, nil) 


164
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 164

optional :author, String

#canonical_url ⇒ String?

Resolved canonical URL, when present.

Parameters:

  • (String)

Returns:

  • (String, nil) 


170
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 170

optional :canonical_url, String, api_name: :canonicalUrl

#crawl_depth ⇒ Integer

Depth relative to the start URL. 0 = start URL, 1 = one link away.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


106
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 106

required :crawl_depth, Integer, api_name: :crawlDepth

#description ⇒ String?

Best description extracted from standard, Open Graph, or Twitter metadata.

Parameters:

  • (String)

Returns:

  • (String, nil) 


176
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 176

optional :description, String

#favicon ⇒ String?

Resolved favicon URL, when present.

Parameters:

  • (String)

Returns:

  • (String, nil) 


182
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 182

optional :favicon, String

#final_url ⇒ String

Final URL scraped after redirects or scraper fallback, when known. Falls back to sourceUrl when unavailable.

Parameters:

  • value (String)

Returns:

  • (String) 


113
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 113

required :final_url, String, api_name: :finalUrl

#headings ⇒ Array<ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata::Heading>?

Page headings (h1–h6) in document order, extracted from the unfiltered document. Capped at the first 500 headings. Omitted when the page has none.

Returns:



189
190
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 189

optional :headings,
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata::Heading] }

#image ⇒ String?

Primary resolved preview image from Open Graph, Twitter, or image metadata.

Parameters:

  • (String)

Returns:

  • (String, nil) 


196
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 196

optional :image, String

#json_ld ⇒ Array<Hash{Symbol=>Object}>?

JSON-LD structured data blocks parsed from the page.

Returns:

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


202
203
204
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 202

optional :json_ld,
ContextDev::Internal::Type::ArrayOf[ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]],
api_name: :jsonLd

#keywords ⇒ Array<String>?

Keywords extracted from the page's keywords meta tag.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


210
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 210

optional :keywords, ContextDev::Internal::Type::ArrayOf[String]

#language ⇒ String?

Language extracted from html lang or language meta tags.

Parameters:

  • (String)

Returns:

  • (String, nil) 


216
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 216

optional :language, String

#modified_time ⇒ String?

Modified timestamp/date from page metadata, when present.

Parameters:

  • (String)

Returns:

  • (String, nil) 


222
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 222

optional :modified_time, String, api_name: :modifiedTime

#open_graph ⇒ Hash{Symbol=>String, Array<String>}?

Open Graph metadata with the og: prefix removed and keys camel-cased.

Returns:

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


228
229
230
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 228

optional :open_graph,
-> { ContextDev::Internal::Type::HashOf[union: ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata::OpenGraph] },
api_name: :openGraph

#published_time ⇒ String?

Published timestamp/date from page metadata, when present.

Parameters:

  • (String)

Returns:

  • (String, nil) 


236
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 236

optional :published_time, String, api_name: :publishedTime

#robots ⇒ String?

Robots meta directive, when present.

Parameters:

  • (String)

Returns:

  • (String, nil) 


242
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 242

optional :robots, String

#site_name ⇒ String?

Site or application name from page metadata.

Parameters:

  • (String)

Returns:

  • (String, nil) 


248
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 248

optional :site_name, String, api_name: :siteName

#source_url ⇒ String

Original URL requested by the caller.

Parameters:

  • value (String)

Returns:

  • (String) 


119
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 119

required :source_url, String, api_name: :sourceUrl

#status_code ⇒ Integer

HTTP status code of the response

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


125
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 125

required :status_code, Integer, api_name: :statusCode

#success ⇒ Boolean

true if the page was fetched and parsed successfully

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


131
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 131

required :success, ContextDev::Internal::Type::Boolean

#title ⇒ String

Best page title extracted from the page (empty string if unavailable).

Parameters:

  • value (String)

Returns:

  • (String) 


137
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 137

required :title, String

#twitter ⇒ Hash{Symbol=>String, Array<String>}?

Twitter card metadata with the twitter: prefix removed and keys camel-cased.

Returns:

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


254
255
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 254

optional :twitter,
-> { ContextDev::Internal::Type::HashOf[union: ContextDev::Models::WebWebCrawlMdResponse::Result::Metadata::Twitter] }

#url ⇒ String

The crawl URL fetched for this page.

Parameters:

  • value (String)

Returns:

  • (String) 


143
 
# File 'lib/context_dev/models/web_web_crawl_md_response.rb', line 143

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


241
 
# File 'sig/context_dev/models/web_web_crawl_md_response.rbs', line 241

def to_hash: -> {