BaseDocumentTransformer class abstract

Base interface for transforming documents.

Inheritance

Constructors

BaseDocumentTransformer()
Base interface for transforming documents.
const

Properties

defaultOptions BaseLangChainOptions
The default options to use when invoking the Runnable.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

batch(List<List<Document>> inputs, {List<BaseLangChainOptions>? options}) Future<List<List<Document>>>
Batches the invocation of the Runnable on the given inputs.
inherited
bind(BaseLangChainOptions options) RunnableBinding<List<Document>, BaseLangChainOptions, List<Document>>
Binds the Runnable to the given options.
inherited
close() → void
Cleans up any resources associated with it the Runnable.
inherited
getCompatibleOptions(RunnableOptions? options) BaseLangChainOptions?
Returns the given options if they are compatible with the Runnable, otherwise returns null.
inherited
invoke(List<Document> input, {BaseLangChainOptions? options}) Future<List<Document>>
Transform a list of documents.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pipe<NewRunOutput extends Object?, NewCallOptions extends RunnableOptions>(Runnable<List<Document>, NewCallOptions, NewRunOutput> next) RunnableSequence<List<Document>, NewRunOutput>
Pipes the output of this Runnable into another Runnable using a RunnableSequence.
inherited
stream(List<Document> input, {BaseLangChainOptions? options}) Stream<List<Document>>
Streams the output of invoking the Runnable on the given input.
inherited
streamFromInputStream(Stream<List<Document>> inputStream, {BaseLangChainOptions? options}) Stream<List<Document>>
Streams the output of invoking the Runnable on the given inputStream.
inherited
toString() String
A string representation of this object.
inherited
transformDocuments(List<Document> documents) Future<List<Document>>
Transform a list of documents.
withFallbacks(List<Runnable<List<Document>, RunnableOptions, List<Document>>> fallbacks) RunnableWithFallback<List<Document>, List<Document>>
Adds fallback runnables to be invoked if the primary runnable fails.
inherited
withRetry({int maxRetries = 3, FutureOr<bool> retryIf(Object e)?, List<Duration?>? delayDurations, bool addJitter = false}) RunnableRetry<List<Document>, List<Document>>
Adds retry logic to an existing runnable.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited