Struct ScrapeOptions 

pub struct ScrapeOptions {

    pub formats: Vec<Format>,
    pub headers: BTreeMap<String, String>,
    pub include_tags: Vec<String>,
    pub exclude_tags: Vec<String>,
    pub only_main_content: bool,
    pub timeout: Option<u64>,
    pub wait_for: u64,
    pub mobile: bool,
    pub actions: Vec<Value>,
    pub location: Option<Location>,
    pub parsers: Option<Value>,
    pub remove_base64_images: bool,
    pub block_ads: bool,
    pub proxy: Option<String>,
    pub egress: Option<String>,
    pub skip_tls_verification: Option<bool>,
    pub max_age: Option<u64>,
    pub min_age: Option<u64>,
    pub store_in_cache: bool,
    pub engine: Option<String>,
    pub keep_session: bool,
    pub discover_scripts: bool,
    pub owner: Option<String>,
    pub explain: bool,
    pub export_images: bool,
    pub image_assets: Option<ImageAssetMode>,
    pub asset_fetch_cache: Option<AssetFetchCache>,
    pub markdown_progress: Option<MarkdownProgress>,
    pub if_none_match: Option<String>,
    pub if_modified_since: Option<String>,
    pub ignore_robots_txt: bool,
    pub store_snapshot: bool,
    pub query_filter: Option<QueryFilter>,
    pub chunking: Option<Value>,
    pub respond_timing: Option<String>,
}

Single page scrape options (scrapeOptions).

Fields

formats: Vec<Format>

headers: BTreeMap<String, String>

include_tags: Vec<String>

exclude_tags: Vec<String>

only_main_content: bool

timeout: Option<u64>

Milliseconds.

wait_for: u64

Milliseconds.

mobile: bool

actions: Vec<Value>

location: Option<Location>

parsers: Option<Value>

remove_base64_images: bool

block_ads: bool

proxy: Option<String>

basic, auto pass through; others return UNSUPPORTED_OPTION.

egress: Option<String>

PageSift extension: designated named egress ([[egress]]).

skip_tls_verification: Option<bool>

TLS skip verification flag (PageSift always verifies certificates).

max_age: Option<u64>

Milliseconds.

min_age: Option<u64>

Milliseconds.

store_in_cache: bool

engine: Option<String>

http, browser, auto (default).

keep_session: bool

PageSift extension: keep the browser page open for /v2/scrape/{id}/interact (only on POST /v2/scrape). Without it the first interact opens the URL again. Not serialized when false, so cluster tasks and audit records stay byte-identical.

discover_scripts: bool

PageSift extension: bounded, stateless same-origin external JS discovery.

owner: Option<String>

Internal: stable caller identity used to scope reusable sessions. Never accepted from JSON and never serialized.

explain: bool

PageSift extension: write how the result was produced (render and merge decisions with their inputs) to metadata.pagesift.plan.

export_images: bool

PageSift extension: export images as attachments — PDF embedded images in their original encoding, Office media, and web page images (fetched politely, robots and SSRF rules apply).

image_assets: Option<ImageAssetMode>

Optional image asset presentation; absent leaves existing behavior.

asset_fetch_cache: Option<AssetFetchCache>

Internal cache scoped to one batch/crawl; not part of the public request.

markdown_progress: Option<MarkdownProgress>

Internal channel for provisional extracted Markdown; never serialized.

if_none_match: Option<String>

if_modified_since: Option<String>

ignore_robots_txt: bool

Client-side robots.txt bypass flag.

store_snapshot: bool

query_filter: Option<QueryFilter>

BM25 query filter on main content markdown.

chunking: Option<Value>

PageSift extension: chunking options ({"type": "recursive", "size": 400}, etc.).

respond_timing: Option<String>

PageSift extension: when a rendered page counts as ready (Jina’s x-respond-timing), one of RESPOND_TIMINGS. html does not run scripts; the others need the browser.

Implementations

impl ScrapeOptions

pub fn wants(&self, kind: &str) -> bool

Trait Implementations

impl Clone for ScrapeOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScrapeOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScrapeOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScrapeOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScrapeOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ScrapeOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScrapeOptions