Interface PGVectorStoreArgs

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

Hierarchy

  • PGVectorStoreArgs

Properties

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

Properties

postgresConnectionOptions

postgresConnectionOptions: PoolConfig

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 extensionSchemaName

extensionSchemaName?: null | string

Optional filter

filter?: Metadata

Optional ids

ids?: string[]

Optional schemaName

schemaName?: null | string

Optional verbose

verbose?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc