Class: ContextDev::Models::WebSearchParams::MarkdownOptions::Pdf

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

Overview

See Also:

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(end_: nil, should_parse: nil, start: nil) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::WebSearchParams::MarkdownOptions::Pdf for more details.

PDF handling. Use start/end to bound text extraction and OCR to a page range.

Parameters:

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

    Last PDF page to parse (1-based, inclusive). Defaults to the final page. Must be

  • should_parse (Boolean) (defaults to: nil) —

    Parse PDF URLs. When false, PDF results are skipped with WEBSITE_ACCESS_ERROR.

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

    First PDF page to parse (1-based, inclusive). Defaults to page 1.




# File 'lib/context_dev/models/web_search_params.rb', line 203

Instance Attribute Details

#end_ ⇒ Integer?

Last PDF page to parse (1-based, inclusive). Defaults to the final page. Must be >= start.

Returns:

  • (Integer, nil) 


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

optional :end_, Integer, api_name: :end

#should_parse ⇒ Boolean?

Parse PDF URLs. When false, PDF results are skipped with WEBSITE_ACCESS_ERROR.

Returns:

  • (Boolean, nil) 


195
 
# File 'lib/context_dev/models/web_search_params.rb', line 195

optional :should_parse, ContextDev::Internal::Type::Boolean, api_name: :shouldParse

#start ⇒ Integer?

First PDF page to parse (1-based, inclusive). Defaults to page 1.

Returns:

  • (Integer, nil) 


201
 
# File 'lib/context_dev/models/web_search_params.rb', line 201

optional :start, Integer