Skip to main content

ExtractOptions

Struct ExtractOptions 

Source
pub struct ExtractOptions<'a> {
Show 23 fields pub raw_html: &'a str, pub source_url: &'a str, pub status_code: u16, pub rendered_with: Option<String>, pub elapsed_ms: u64, pub render_decision: Option<RenderDecision>, pub credit_cost: u32, pub warnings: Vec<String>, pub formats: &'a [OutputFormat], pub only_main_content: bool, pub include_tags: &'a [String], pub exclude_tags: &'a [String], pub css_selector: Option<&'a str>, pub xpath: Option<&'a str>, pub chunk_strategy: Option<&'a ChunkStrategy>, pub query: Option<&'a str>, pub filter_mode: Option<&'a FilterMode>, pub top_k: Option<usize>, pub domain_selectors: Option<&'a HashMap<String, String>>, pub captured_responses: &'a [CapturedNetworkResponse], pub llm_fallback: Option<LlmFallbackParams<'a>>, pub debug: bool, pub debug_sink: Option<Arc<Mutex<DebugCollector>>>,
}
Expand description

Options for the high-level extraction pipeline.

Fields§

§raw_html: &'a str§source_url: &'a str§status_code: u16§rendered_with: Option<String>§elapsed_ms: u64§render_decision: Option<RenderDecision>

Routing decision metadata to surface to API consumers.

§credit_cost: u32

Credit cost attributed to this fetch.

§warnings: Vec<String>

Soft-failure warnings collected through the render chain.

§formats: &'a [OutputFormat]§only_main_content: bool§include_tags: &'a [String]§exclude_tags: &'a [String]§css_selector: Option<&'a str>

CSS selector to narrow content before readability extraction.

§xpath: Option<&'a str>

XPath expression to narrow content before readability extraction.

§chunk_strategy: Option<&'a ChunkStrategy>

Strategy for chunking the extracted markdown.

§query: Option<&'a str>

Query for chunk filtering (requires filter_mode).

§filter_mode: Option<&'a FilterMode>

Filtering algorithm for chunk ranking.

§top_k: Option<usize>

Number of top chunks to return (default: 5).

§domain_selectors: Option<&'a HashMap<String, String>>

Per-host CSS selector overrides. Used only when the request did not supply an explicit css_selector / xpath. The selector for the source URL’s host is applied before readability narrowing.

§captured_responses: &'a [CapturedNetworkResponse]

XHR/fetch responses captured during navigation. Used as a fallback content source when DOM-based extraction is low quality.

§llm_fallback: Option<LlmFallbackParams<'a>>

LLM-assisted extraction fallback configuration. When the chosen candidate’s quality score is below quality_threshold and enable is true, the raw HTML (truncated to max_html_bytes) is sent to the configured LLM provider for re-extraction.

§debug: bool

Opt-in extraction debug trace. When true, the extractor populates debug_sink with one DebugAttempt per extract() invocation.

§debug_sink: Option<Arc<Mutex<DebugCollector>>>

Sink for debug attempts. Shared across the multi-attempt JS-escalation loop so that all attempts land in one trace.

Auto Trait Implementations§

§

impl<'a> Freeze for ExtractOptions<'a>

§

impl<'a> RefUnwindSafe for ExtractOptions<'a>

§

impl<'a> Send for ExtractOptions<'a>

§

impl<'a> Sync for ExtractOptions<'a>

§

impl<'a> Unpin for ExtractOptions<'a>

§

impl<'a> UnsafeUnpin for ExtractOptions<'a>

§

impl<'a> UnwindSafe for ExtractOptions<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more