Interface PGVectorStoreArgs

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?: MetadataFilter;
    ids?: string[];
    pool?: Pool;
    postgresConnectionOptions?: PoolConfig;
    schemaName?: null | string;
    skipInitializationCheck?: boolean;
    tableName: string;
    verbose?: boolean;
}

Properties

chunkSize? collectionMetadata? collectionName? collectionTableName? columns? distanceStrategy? extensionSchemaName? filter? ids? pool? postgresConnectionOptions? schemaName? skipInitializationCheck? tableName verbose?

Properties

OptionalchunkSize

chunkSize?: number

The amount of documents to chunk by when adding vectors.

Default

500

OptionalcollectionMetadata

collectionMetadata?: null | Metadata

OptionalcollectionName

collectionName?: string

OptionalcollectionTableName

collectionTableName?: string

Optionalcolumns

columns?: {
    contentColumnName?: string;
    idColumnName?: string;
    metadataColumnName?: string;
    vectorColumnName?: string;
}

OptionaldistanceStrategy

distanceStrategy?: DistanceStrategy

OptionalextensionSchemaName

extensionSchemaName?: null | string

Optionalfilter

filter?: MetadataFilter

Optionalids

ids?: string[]

Optionalpool

pool?: Pool

OptionalpostgresConnectionOptions

postgresConnectionOptions?: PoolConfig

OptionalschemaName

schemaName?: null | string

OptionalskipInitializationCheck

skipInitializationCheck?: boolean

tableName

tableName: string

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties