Interface PipelineSourceSelector

Source selector builder contract used by helpers.

interface PipelineSourceSelector {
    artifact(
        select?: PipelineSelectorFn<PipelineSourceArtifact>,
    ): PipelineSourceBinding<PipelineArtifactSelect>;
    audio(
        select?: PipelineSelectorFn<PipelineSourceArtifact>,
    ): PipelineSourceBinding<PipelineArtifactSelect>;
    image(
        select?: PipelineSelectorFn<ClientReferenceImage>,
    ): PipelineSourceBinding<PipelineImageSelect>;
    text(
        select?: PipelineSelectorFn<string>,
    ): PipelineSourceBinding<PipelineTextSelect>;
    video(
        select?: PipelineSelectorFn<PipelineSourceArtifact>,
    ): PipelineSourceBinding<PipelineArtifactSelect>;
}

Index

Methods

artifact audio image text video

Methods

artifact

artifact(
select?: PipelineSelectorFn<PipelineSourceArtifact>,
): PipelineSourceBinding<PipelineArtifactSelect>
Binds a generic artifact selector.
Parameters
- Optionalselect: PipelineSelectorFn<PipelineSourceArtifact>
  Optional projection to artifact shape.
Returns PipelineSourceBinding<PipelineArtifactSelect>
Selector binding for artifact-producing steps.
- Defined in src/core/workflow/Pipeline.ts:148

audio

audio(
select?: PipelineSelectorFn<PipelineSourceArtifact>,
): PipelineSourceBinding<PipelineArtifactSelect>
Binds an audio artifact selector.
Parameters
- Optionalselect: PipelineSelectorFn<PipelineSourceArtifact>
  Optional projection to artifact shape.
Returns PipelineSourceBinding<PipelineArtifactSelect>
Selector binding for audio-producing steps.
- Defined in src/core/workflow/Pipeline.ts:155

image

image(
select?: PipelineSelectorFn<ClientReferenceImage>,
): PipelineSourceBinding<PipelineImageSelect>
Binds an image reference selector.
Parameters
- Optionalselect: PipelineSelectorFn<ClientReferenceImage>
  Optional projection to image reference shape.
Returns PipelineSourceBinding<PipelineImageSelect>
Selector binding for image-producing steps.
- Defined in src/core/workflow/Pipeline.ts:169

text

text(
select?: PipelineSelectorFn<string>,
): PipelineSourceBinding<PipelineTextSelect>
Binds a text source selector.
Parameters
- Optionalselect: PipelineSelectorFn<string>
  Optional projection from source value to text.
Returns PipelineSourceBinding<PipelineTextSelect>
Selector binding for text-producing steps.
- Defined in src/core/workflow/Pipeline.ts:141

video

video(
select?: PipelineSelectorFn<PipelineSourceArtifact>,
): PipelineSourceBinding<PipelineArtifactSelect>
Binds a video artifact selector.
Parameters
- Optionalselect: PipelineSelectorFn<PipelineSourceArtifact>
  Optional projection to artifact shape.
Returns PipelineSourceBinding<PipelineArtifactSelect>
Selector binding for video-producing steps.
- Defined in src/core/workflow/Pipeline.ts:162