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 {
    tableName: string;
    chunkSize?: number;
    collectionMetadata?: null | Metadata;
    collectionName?: string;
    collectionTableName?: string;
    columns?: {
        contentColumnName?: string;
        idColumnName?: string;
        metadataColumnName?: string;
        vectorColumnName?: string;
    };
    distanceStrategy?: "cosine" | "innerProduct" | "euclidean";
    extensionSchemaName?: null | string;
    filter?: Metadata;
    ids?: string[];
    pool?: Pool;
    postgresConnectionOptions?: PoolConfig;
    schemaName?: null | string;
    verbose?: boolean;
}

Properties

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

Properties

tableName

tableName: string

Optional chunkSize

chunkSize?: number

The amount of documents to chunk by when adding vectors.

Default

500

Optional collectionMetadata

collectionMetadata?: null | Metadata

Optional collectionName

collectionName?: string

Optional collectionTableName

collectionTableName?: string

Optional columns

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

Type declaration

  • Optional contentColumnName?: string
  • Optional idColumnName?: string
  • Optional metadataColumnName?: string
  • Optional vectorColumnName?: string

Optional distanceStrategy

distanceStrategy?: "cosine" | "innerProduct" | "euclidean"

Optional extensionSchemaName

extensionSchemaName?: null | string

Optional filter

filter?: Metadata

Optional ids

ids?: string[]

Optional pool

pool?: Pool

Optional postgresConnectionOptions

postgresConnectionOptions?: PoolConfig

Optional schemaName

schemaName?: null | string

Optional verbose

verbose?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc