Interface that defines the arguments required to create a PGVectorStore instance. It includes Postgres connection options, table name, filter, and verbosity level.

interface PGVectorStoreArgs {
    chunkSize?: number;
    collectionMetadata?: null | Metadata;
    collectionName?: string;
    collectionTableName?: string;
    columns?: {
        contentColumnName?: string;
        idColumnName?: string;
        metadataColumnName?: string;
        vectorColumnName?: string;
    };
    distanceStrategy?: DistanceStrategy;
    extensionSchemaName?: null | string;
    filter?: Metadata;
    ids?: string[];
    pool?: Pool;
    postgresConnectionOptions?: PoolConfig;
    schemaName?: null | string;
    tableName: string;
    verbose?: boolean;
}

Properties

chunkSize?: number

The amount of documents to chunk by when adding vectors.

500
collectionMetadata?: null | Metadata
collectionName?: string
collectionTableName?: string
columns?: {
    contentColumnName?: string;
    idColumnName?: string;
    metadataColumnName?: string;
    vectorColumnName?: string;
}
distanceStrategy?: DistanceStrategy
extensionSchemaName?: null | string
filter?: Metadata
ids?: string[]
pool?: Pool
postgresConnectionOptions?: PoolConfig
schemaName?: null | string
tableName: string
verbose?: boolean