Class: ContextDev::Models::WebSearchResponse::Result::Markdown

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::WebSearchResponse::Result::Markdown

Defined in:

lib/context_dev/models/web_search_response.rb

Overview

See Also:

• #markdown

Defined Under Namespace

Modules: Code

Instance Attribute Summary

• #code ⇒ Symbol, ContextDev::Models::WebSearchResponse::Result::Markdown::Code

  Per-result scrape outcome.

• #markdown ⇒ String^?

  GFM Markdown of the page.

Instance Method Summary

• #initialize(code:, markdown:) ⇒ Object constructor

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

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(code:, markdown:) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::WebSearchResponse::Result::Markdown for more details.

Markdown scrape status and content for this result.

Parameters:

• code (Symbol, ContextDev::Models::WebSearchResponse::Result::Markdown::Code) —

  Per-result scrape outcome. Inspect this before reading ‘markdown`.

• markdown (String, nil) —

  GFM Markdown of the page. Null unless markdownOptions.enabled is true and scrapi

# File 'lib/context_dev/models/web_search_response.rb', line 81

Instance Attribute Details

#code ⇒ Symbol, ContextDev::Models::WebSearchResponse::Result::Markdown::Code

Per-result scrape outcome. Inspect this before reading ‘markdown`.

Returns:

• (Symbol, ContextDev::Models::WebSearchResponse::Result::Markdown::Code)

# File 'lib/context_dev/models/web_search_response.rb', line 72

required :code, enum: -> { ContextDev::Models::WebSearchResponse::Result::Markdown::Code }

#markdown ⇒ String^?

GFM Markdown of the page. Null unless markdownOptions.enabled is true and scraping succeeded.

Returns:

• (String, nil)

# File 'lib/context_dev/models/web_search_response.rb', line 79

required :markdown, String, nil?: true