Skip to content

VectorPipeline

Pipeline that loads and processes vectors

Implements the Pipeline protocol.

PARAMETER DESCRIPTION
vector_loader

Vector loader

TYPE: VectorLoader

vector_processor

Vector processor

TYPE: VectorProcessor

from_config classmethod

Creates a vector pipeline from the configuration.

PARAMETER DESCRIPTION
config

Configuration

TYPE: VectorPipelineConfig

RETURNS DESCRIPTION
VectorPipeline

Vector pipeline

__call__

Runs the vector pipeline.


VectorPipelineConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of VectorPipeline

Create the configuration from a config file
  • Use null instead of None
Example

You can create the configuration from a config file.

config.yaml
package: 'aviary'
name: 'VectorPipeline'
config:
  plugins_dir_path: null

  vector_loader_config:
    ...

  vector_processor_config:
    ...
ATTRIBUTE DESCRIPTION
plugins_dir_path

Path to the plugins directory - defaults to None

TYPE: Path | None

vector_loader_config

Configuration for the vector loader

TYPE: VectorLoaderConfig

vector_processor_config

Configuration for the vector processor

TYPE: VectorProcessorConfig