Interface RunnableInterface<RunInput, RunOutput, CallOptions>

Base interface implemented by all runnables. Used for cross-compatibility between different versions of LangChain core.

Should not change on patch releases.

interface RunnableInterface<
    RunInput = any,
    RunOutput = any,
    CallOptions extends RunnableConfig = RunnableConfig,
> {
    lc_serializable: boolean;
    get lc_id(): string[];
    batch(
        inputs: RunInput[],
        options?: Partial<CallOptions> | Partial<CallOptions>[],
        batchOptions?: RunnableBatchOptions & { returnExceptions?: false },
    ): Promise<RunOutput[]>;
    batch(
        inputs: RunInput[],
        options?: Partial<CallOptions> | Partial<CallOptions>[],
        batchOptions?: RunnableBatchOptions & { returnExceptions: true },
    ): Promise<(Error | RunOutput)[]>;
    batch(
        inputs: RunInput[],
        options?: Partial<CallOptions> | Partial<CallOptions>[],
        batchOptions?: RunnableBatchOptions,
    ): Promise<(Error | RunOutput)[]>;
    getName(suffix?: string): string;
    invoke(input: RunInput, options?: Partial<CallOptions>): Promise<RunOutput>;
    stream(
        input: RunInput,
        options?: Partial<CallOptions>,
    ): Promise<IterableReadableStreamInterface<RunOutput>>;
    transform(
        generator: AsyncGenerator<RunInput>,
        options: Partial<CallOptions>,
    ): AsyncGenerator<RunOutput>;
}

Type Parameters

RunInput = any
RunOutput = any
CallOptions extends RunnableConfig = RunnableConfig

Hierarchy (View Summary)

SerializableInterface
- RunnableInterface

Implemented by

Runnable

Index

Properties

lc_serializable

Accessors

Methods

batch getName invoke stream transform

Properties

lc_serializable

lc_serializable: boolean

Accessors

lc_id

get lc_id(): string[]
Returns string[]
Inherited from SerializableInterface.lc_id
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/load/serializable.ts:79

Methods

batch

batch(
    inputs: RunInput[],
    options?: Partial<CallOptions> | Partial<CallOptions>[],
    batchOptions?: RunnableBatchOptions & { returnExceptions?: false },
): Promise<RunOutput[]>
Parameters
- inputs: RunInput[]
- Optionaloptions: Partial<CallOptions> | Partial<CallOptions>[]
- OptionalbatchOptions: RunnableBatchOptions & { returnExceptions?: false }
Returns Promise<RunOutput[]>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/runnables/types.ts:34
batch(
    inputs: RunInput[],
    options?: Partial<CallOptions> | Partial<CallOptions>[],
    batchOptions?: RunnableBatchOptions & { returnExceptions: true },
): Promise<(Error | RunOutput)[]>
Parameters
- inputs: RunInput[]
- Optionaloptions: Partial<CallOptions> | Partial<CallOptions>[]
- OptionalbatchOptions: RunnableBatchOptions & { returnExceptions: true }
Returns Promise<(Error | RunOutput)[]>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/runnables/types.ts:40
batch(
    inputs: RunInput[],
    options?: Partial<CallOptions> | Partial<CallOptions>[],
    batchOptions?: RunnableBatchOptions,
): Promise<(Error | RunOutput)[]>
Parameters
- inputs: RunInput[]
- Optionaloptions: Partial<CallOptions> | Partial<CallOptions>[]
- OptionalbatchOptions: RunnableBatchOptions
Returns Promise<(Error | RunOutput)[]>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/runnables/types.ts:46

getName

getName(suffix?: string): string
Parameters
- Optionalsuffix: string
Returns string
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/runnables/types.ts:62

invoke

invoke(input: RunInput, options?: Partial<CallOptions>): Promise<RunOutput>
Parameters
- input: RunInput
- Optionaloptions: Partial<CallOptions>
Returns Promise<RunOutput>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/runnables/types.ts:32

stream

stream(
input: RunInput,
options?: Partial<CallOptions>,
): Promise<IterableReadableStreamInterface<RunOutput>>
Parameters
- input: RunInput
- Optionaloptions: Partial<CallOptions>
Returns Promise<IterableReadableStreamInterface<RunOutput>>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/runnables/types.ts:52

transform

transform(
generator: AsyncGenerator<RunInput>,
options: Partial<CallOptions>,
): AsyncGenerator<RunOutput>
Parameters
- generator: AsyncGenerator<RunInput>
- options: Partial<CallOptions>
Returns AsyncGenerator<RunOutput>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/runnables/types.ts:57