Class: ContextDev::Models::WebWebScrapeMdResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/web_web_scrape_md_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Success Classes: KeyMetadata

Instance Attribute Summary collapse

Class Method 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(markdown:, success:, url:, key_metadata: nil) ⇒ Object

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

Parameters:




# File 'lib/context_dev/models/web_web_scrape_md_response.rb', line 32

Instance Attribute Details

#key_metadata ⇒ ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata?

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Returns:



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

optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }

#markdown ⇒ String

Page content converted to GitHub Flavored Markdown

Returns:

  • (String) 


11
 
# File 'lib/context_dev/models/web_web_scrape_md_response.rb', line 11

required :markdown, String

#success ⇒ Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success

Indicates success

Returns:



17
 
# File 'lib/context_dev/models/web_web_scrape_md_response.rb', line 17

required :success, enum: -> { ContextDev::Models::WebWebScrapeMdResponse::Success }

#url ⇒ String

The URL that was scraped

Returns:

  • (String) 


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

required :url, String

Class Method Details

.values ⇒ Array<Boolean>

Returns:

  • (Array<Boolean>) 



# File 'lib/context_dev/models/web_web_scrape_md_response.rb', line 52