Class MozillaReadabilityTransformer

A transformer that uses the Mozilla Readability library to extract the main content from a web page.

Example

const loader = new CheerioWebBaseLoader("https://example.com/article");
const docs = await loader.load();

const splitter = new RecursiveCharacterTextSplitter({
 maxCharacterCount: 5000,
});
const transformer = new MozillaReadabilityTransformer();

// The sequence processes the loaded documents through the splitter and then the transformer.
const sequence = splitter.pipe(transformer);

// Invoke the sequence to transform the documents into a more readable format.
const newDocuments = await sequence.invoke(docs);

console.log(newDocuments);

Hierarchy

Constructors

constructor

Properties

name? options

Methods

assign batch bind getName invoke map pick pipe stream streamLog toJSON toJSONNotImplemented transform transformDocuments withConfig withFallbacks withListeners withRetry isRunnable

Constructors

constructor

Properties

Optional name

name?: string

Protected options

options: Options = {}

Methods

assign

batch

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: DocumentInterface<Record<string, any>>[][]

      Array of inputs to each batch call.

    • Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<DocumentInterface<Record<string, any>>[][]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(Error | DocumentInterface<Record<string, any>>[])[]>

  • Parameters

    Returns Promise<(Error | DocumentInterface<Record<string, any>>[])[]>

bind

  • Bind arguments to a Runnable, returning a new Runnable.

    Parameters

    Returns Runnable<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[], RunnableConfig>

    A new RunnableBinding that, when invoked, will apply the bound args.

getName

  • Parameters

    • Optional suffix: string

    Returns string

invoke

  • Method to invoke the document transformation. This method calls the transformDocuments method with the provided input.

    Parameters

    • input: DocumentInterface<Record<string, any>>[]

      The input documents to be transformed.

    • _options: BaseCallbackConfig

      Optional configuration object to customize the behavior of callbacks.

    Returns Promise<DocumentInterface<Record<string, any>>[]>

    A Promise that resolves to the transformed documents.

map

  • Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

    Returns Runnable<DocumentInterface<Record<string, any>>[][], DocumentInterface<Record<string, any>>[][], RunnableConfig>

pick

pipe

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<DocumentInterface<Record<string, any>>[], NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns Runnable<DocumentInterface<Record<string, any>>[], Exclude<NewRunOutput, Error>, RunnableConfig>

    A new runnable sequence.

stream

  • Stream output in chunks.

    Parameters

    • input: DocumentInterface<Record<string, any>>[]
    • Optional options: Partial<RunnableConfig>

    Returns Promise<IterableReadableStream<DocumentInterface<Record<string, any>>[]>>

    A readable stream that is also an iterable.

streamLog

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: DocumentInterface<Record<string, any>>[]
    • Optional options: Partial<RunnableConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

toJSON

toJSONNotImplemented

transform

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    • generator: AsyncGenerator<DocumentInterface<Record<string, any>>[], any, unknown>
    • options: Partial<RunnableConfig>

    Returns AsyncGenerator<DocumentInterface<Record<string, any>>[], any, unknown>

transformDocuments

  • Transform a list of documents.

    Parameters

    • documents: DocumentInterface<Record<string, any>>[]

      A sequence of documents to be transformed.

    Returns Promise<DocumentInterface<Record<string, any>>[]>

    A list of transformed documents.

withConfig

  • Bind config to a Runnable, returning a new Runnable.

    Parameters

    • config: RunnableConfig

      New configuration parameters to attach to the new runnable.

    Returns RunnableBinding<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[], RunnableConfig>

    A new RunnableBinding with a config matching what's passed.

withFallbacks

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    • fields: {
          fallbacks: Runnable<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[], RunnableConfig>[];
      }
      • fallbacks: Runnable<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[], RunnableConfig>[]

        Other runnables to call if the runnable errors.

    Returns RunnableWithFallbacks<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[]>

    A new RunnableWithFallbacks.

withListeners

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[], RunnableConfig>

withRetry

Static isRunnable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc