RunnableRetry<RunInput extends Object?, RunOutput extends Object?> class
A Runnable that automatically retries the operation if it fails.
You can create a RunnableRetry using Runnable.withRetry, passing in the RetryOptions.
When invoke or batch is called on the runnable, if the initial attempt fails, it will be retried according to the specified RetryOptions.
Example usage:
final model = ChatOpenAI(...);
final modelWithRetry = model.withRetry(maxRetries: 2);
final res = await modelWithRetry.invoke(...);
- Inheritance
-
- Object
- Runnable<
RunInput, RunnableOptions, RunOutput> - RunnableRetry
- Available extensions
Constructors
-
RunnableRetry({required Runnable<
RunInput, RunnableOptions, RunOutput> runnable, required RunnableOptions defaultOptions, required RetryOptions retryOptions}) - A Runnable that automatically retries the operation if it fails.
Properties
- defaultOptions → RunnableOptions
-
The default options to use when invoking the Runnable.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- retryOptions → RetryOptions
-
Options to retry the runnable.
final
-
runnable
→ Runnable<
RunInput, RunnableOptions, RunOutput> -
Runnable that will be retried on error.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
batch(
List< RunInput> inputs, {List<RunnableOptions> ? options}) → Future<List< RunOutput> > -
Batches the invocation of the Runnable on the given
inputs.override -
bind(
RunnableOptions options) → RunnableBinding< RunInput, RunnableOptions, RunOutput> -
Binds the Runnable to the given
options.inherited -
close(
) → void -
Cleans up any resources associated with it the Runnable.
inherited
-
getCompatibleOptions(
RunnableOptions? options) → RunnableOptions? -
Returns the given
optionsif they are compatible with the Runnable, otherwise returnsnull.inherited -
invoke(
RunInput input, {RunnableOptions? options}) → Future< RunOutput> -
Invokes the Runnable on the given
input.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pipe<
NewRunOutput extends Object?, NewCallOptions extends RunnableOptions> (Runnable< RunOutput, NewCallOptions, NewRunOutput> next) → RunnableSequence<RunInput, NewRunOutput> -
Pipes the output of this Runnable into another Runnable using a
RunnableSequence.
inherited
-
stream(
RunInput input, {RunnableOptions? options}) → Stream< RunOutput> -
Streams the output of invoking the Runnable on the given
input.inherited -
streamFromInputStream(
Stream< RunInput> inputStream, {RunnableOptions? options}) → Stream<RunOutput> -
Streams the output of invoking the Runnable on the given
inputStream.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
withFallbacks(
List< Runnable< fallbacks) → RunnableWithFallback<RunInput, RunnableOptions, RunOutput> >RunInput, RunOutput> -
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<RunInput, RunOutput> -
Adds retry logic to an existing runnable.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator |(
Runnable< RunOutput, RunnableOptions, NewRunOutput> next) → RunnableSequence<RunInput, NewRunOutput> -
Available on Runnable<
Pipes the output of this Runnable into another Runnable.RunInput, CallOptions, RunOutput> , provided by the RunnableX extension