Skip to content
1 min read · 218 words

Interface: ArticleToRetrievableOptions

Defined in: src/batteries/tools/web_retrieval/index.ts:196

Options for scrapperArticleToRetrievable.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
asMarkdown?booleanWhether the chosen content is markdown (recommend markdown) rather than plain text. Default false. Use when an output pipeline rendered the article to markdown.-src/batteries/tools/web_retrieval/index.ts:203
contentSource?ArticleContentSourceWhich field to use as content (default 'textContent'). 'content' is HTML.-src/batteries/tools/web_retrieval/index.ts:198
idPrefix?stringPrefix for the stable, hashed record id (namespacing across sources).ToRetrievableOptions.idPrefixsrc/batteries/tools/web_retrieval/index.ts:62
inline?booleanWhether spooled content should be materialized inline instead of rendered as a handle.ToRetrievableOptions.inlinesrc/batteries/tools/web_retrieval/index.ts:66
kind?stringSemantic kind label, e.g. 'web-search-result', 'web-article', 'web-links'.ToRetrievableOptions.kindsrc/batteries/tools/web_retrieval/index.ts:60
spool?SpoolHookOptional reader-backed-artifact hook for large content. See SpoolHook.ToRetrievableOptions.spoolsrc/batteries/tools/web_retrieval/index.ts:64
trustTier?RetrievableTrustTierTrust tier for the produced records. Default 'third-party-public' (web content is third-party by definition — this is a constant, not URL inference).ToRetrievableOptions.trustTiersrc/batteries/tools/web_retrieval/index.ts:58