Interface PipelineInvocable

A capability stage — an Action or artifact tool. Effectful + async. The executor resolves templating and pipeInto into params before calling invoke; the raw upstream input is passed too for providers that want it.

interface PipelineInvocable {
    isSource: boolean;
    providerKind: PipelineProviderKind;
    toolName: string;
    invoke(
        input: PipeValue,
        params: Record<string, unknown>,
    ): Promise<PipelineStepResult>;
}

Implemented by

Index

Properties

isSource providerKind toolName

Methods

Properties

`Readonly`isSource

isSource: boolean

Whether this can be a pipeline's first stage (produces data without upstream).

`Readonly`providerKind

providerKind: PipelineProviderKind

`Readonly`toolName

toolName: string

Methods

invoke

invoke(
input: PipeValue,
params: Record<string, unknown>,
): Promise<PipelineStepResult>
Parameters
- input: PipeValue
- params: Record<string, unknown>
Returns Promise<PipelineStepResult>
- Defined in AI/Agents/src/pipeline/pipeline.types.ts:46