@mastra/memory 1.6.0 → 1.6.1

package/dist/docs/references/reference-storage-postgresql.md

@@ -41,35 +41,35 @@ const storage = new PostgresStore({
 
 ## Parameters
 
-**id:** (`string`): Unique identifier for this storage instance.
+**id** (`string`): Unique identifier for this storage instance.
 
-**connectionString?:** (`string`): PostgreSQL connection string (e.g., postgresql://user:pass\@host:5432/dbname). Required unless using \`pool\` or individual host-based parameters (\`host\`, \`port\`, \`database\`, \`user\`, \`password\`).
+**connectionString** (`string`): PostgreSQL connection string (e.g., postgresql://user:pass\@host:5432/dbname). Required unless using \`pool\` or individual host-based parameters (\`host\`, \`port\`, \`database\`, \`user\`, \`password\`).
 
-**host?:** (`string`): Database server hostname or IP address. Used with other host-based parameters as an alternative to connectionString.
+**host** (`string`): Database server hostname or IP address. Used with other host-based parameters as an alternative to connectionString.
 
-**port?:** (`number`): Database server port number. Defaults to 5432 if not specified.
+**port** (`number`): Database server port number. Defaults to 5432 if not specified.
 
-**database?:** (`string`): Name of the database to connect to.
+**database** (`string`): Name of the database to connect to.
 
-**user?:** (`string`): Database user for authentication.
+**user** (`string`): Database user for authentication.
 
-**password?:** (`string`): Password for the database user.
+**password** (`string`): Password for the database user.
 
-**pool?:** (`pg.Pool`): Pre-configured pg.Pool instance. Use this to reuse an existing connection pool. When provided, Mastra will not create its own pool and will not close it when \`store.close()\` is called.
+**pool** (`pg.Pool`): Pre-configured pg.Pool instance. Use this to reuse an existing connection pool. When provided, Mastra will not create its own pool and will not close it when \`store.close()\` is called.
 
-**schemaName?:** (`string`): The name of the schema you want the storage to use. Defaults to 'public'.
+**schemaName** (`string`): The name of the schema you want the storage to use. Defaults to 'public'.
 
-**ssl?:** (`boolean | ConnectionOptions`): SSL configuration for the connection; set to true to use default SSL or provide a ConnectionOptions object for custom SSL settings.
+**ssl** (`boolean | ConnectionOptions`): SSL configuration for the connection; set to true to use default SSL or provide a ConnectionOptions object for custom SSL settings.
 
-**max?:** (`number`): Maximum number of connections in the pool. Defaults to 20.
+**max** (`number`): Maximum number of connections in the pool. Defaults to 20.
 
-**idleTimeoutMillis?:** (`number`): How long a connection can sit idle before being closed. Defaults to 30000 (30 seconds).
+**idleTimeoutMillis** (`number`): How long a connection can sit idle before being closed. Defaults to 30000 (30 seconds).
 
-**disableInit?:** (`boolean`): When true, automatic table creation/migrations are disabled. Useful for CI/CD pipelines where migrations are run separately.
+**disableInit** (`boolean`): When true, automatic table creation/migrations are disabled. Useful for CI/CD pipelines where migrations are run separately.
 
-**skipDefaultIndexes?:** (`boolean`): When true, default indexes will not be created during initialization.
+**skipDefaultIndexes** (`boolean`): When true, default indexes will not be created during initialization.
 
-**indexes?:** (`CreateIndexOptions[]`): Custom indexes to create during initialization.
+**indexes** (`CreateIndexOptions[]`): Custom indexes to create during initialization.
 
 ## Constructor Examples
 
@@ -448,25 +448,25 @@ For advanced index types, you can specify additional options:
 
 ### Index Options
 
-**name:** (`string`): Unique name for the index
+**name** (`string`): Unique name for the index
 
-**table:** (`string`): Table name (e.g., 'mastra\_threads')
+**table** (`string`): Table name (e.g., 'mastra\_threads')
 
-**columns:** (`string[]`): Array of column names with optional sort order (e.g., \['id', 'createdAt DESC'])
+**columns** (`string[]`): Array of column names with optional sort order (e.g., \['id', 'createdAt DESC'])
 
-**unique?:** (`boolean`): Creates a unique constraint index
+**unique** (`boolean`): Creates a unique constraint index
 
-**concurrent?:** (`boolean`): Creates index without locking table (default: true)
+**concurrent** (`boolean`): Creates index without locking table (default: true)
 
-**where?:** (`string`): Partial index condition (PostgreSQL specific)
+**where** (`string`): Partial index condition (PostgreSQL specific)
 
-**method?:** (`'btree' | 'hash' | 'gin' | 'gist' | 'spgist' | 'brin'`): Index method (default: 'btree')
+**method** (`'btree' | 'hash' | 'gin' | 'gist' | 'spgist' | 'brin'`): Index method (default: 'btree')
 
-**opclass?:** (`string`): Operator class for GIN/GIST indexes
+**opclass** (`string`): Operator class for GIN/GIST indexes
 
-**storage?:** (`Record<string, any>`): Storage parameters (e.g., { fillfactor: 90 })
+**storage** (`Record<string, any>`): Storage parameters (e.g., { fillfactor: 90 })
 
-**tablespace?:** (`string`): Tablespace name for index placement
+**tablespace** (`string`): Tablespace name for index placement
 
 ### Schema-Specific Indexes
 

package/dist/docs/references/reference-storage-upstash.md

@@ -46,11 +46,11 @@ const storage = new UpstashStore({
 
 ## Parameters
 
-**url:** (`string`): Upstash Redis URL
+**url** (`string`): Upstash Redis URL
 
-**token:** (`string`): Upstash Redis authentication token
+**token** (`string`): Upstash Redis authentication token
 
-**prefix?:** (`string`): Key prefix for all stored items (Default: `mastra:`)
+**prefix** (`string`): Key prefix for all stored items (Default: `mastra:`)
 
 ## Additional Notes
 

package/dist/docs/references/reference-vectors-libsql.md

@@ -71,13 +71,13 @@ const results = await store.query({
 
 ## Constructor Options
 
-**url:** (`string`): libSQL database URL. Use ':memory:' for in-memory database, 'file:dbname.db' for local file, or a libSQL-compatible connection string like 'libsql://your-database.turso.io'.
+**url** (`string`): libSQL database URL. Use ':memory:' for in-memory database, 'file:dbname.db' for local file, or a libSQL-compatible connection string like 'libsql://your-database.turso.io'.
 
-**authToken?:** (`string`): Authentication token for Turso cloud databases
+**authToken** (`string`): Authentication token for Turso cloud databases
 
-**syncUrl?:** (`string`): URL for database replication (Turso specific)
+**syncUrl** (`string`): URL for database replication (Turso specific)
 
-**syncInterval?:** (`number`): Interval in milliseconds for database sync (Turso specific)
+**syncInterval** (`number`): Interval in milliseconds for database sync (Turso specific)
 
 ## Methods
 
@@ -85,45 +85,45 @@ const results = await store.query({
 
 Creates a new vector collection. The index name must start with a letter or underscore and can only contain letters, numbers, and underscores. The dimension must be a positive integer.
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension size (must match your embedding model)
+**dimension** (`number`): Vector dimension size (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Note: Currently only cosine similarity is supported by libSQL. (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Note: Currently only cosine similarity is supported by libSQL. (Default: `cosine`)
 
 ### upsert()
 
 Adds or updates vectors and their metadata in the index. Uses a transaction to ensure all vectors are inserted atomically - if any insert fails, the entire operation is rolled back.
 
-**indexName:** (`string`): Name of the index to insert into
+**indexName** (`string`): Name of the index to insert into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
 Searches for similar vectors with optional metadata filtering.
 
-**indexName:** (`string`): Name of the index to search in
+**indexName** (`string`): Name of the index to search in
 
-**queryVector:** (`number[]`): Query vector to find similar vectors for
+**queryVector** (`number[]`): Query vector to find similar vectors for
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Filter`): Metadata filters
+**filter** (`Filter`): Metadata filters
 
-**includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
-**minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
+**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
 ### describeIndex()
 
 Gets information about an index.
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -139,7 +139,7 @@ interface IndexStats {
 
 Deletes an index and all its data.
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### listIndexes()
 
@@ -151,41 +151,41 @@ Returns: `Promise<string[]>`
 
 Removes all vectors from an index while keeping the index structure.
 
-**indexName:** (`string`): Name of the index to truncate
+**indexName** (`string`): Name of the index to truncate
 
 ### updateVector()
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id?:** (`string`): ID of the vector entry to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector entry to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`object`): Update data containing vector and/or metadata
+**update** (`object`): Update data containing vector and/or metadata
 
-**update.vector?:** (`number[]`): New vector data to update
+**update.vector** (`number[]`): New vector data to update
 
-**update.metadata?:** (`Record<string, any>`): New metadata to update
+**update.metadata** (`Record<string, any>`): New metadata to update
 
 ### deleteVector()
 
 Deletes a specific vector entry from an index by its ID.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector entry to delete
+**id** (`string`): ID of the vector entry to delete
 
 ### deleteVectors()
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ## Response Types
 

package/dist/docs/references/reference-vectors-mongodb.md

@@ -57,15 +57,15 @@ const store = new MongoDBVector({
 
 ## Constructor Options
 
-**id:** (`string`): Unique identifier for this vector store instance
+**id** (`string`): Unique identifier for this vector store instance
 
-**uri:** (`string`): MongoDB connection string
+**uri** (`string`): MongoDB connection string
 
-**dbName:** (`string`): Name of the MongoDB database to use
+**dbName** (`string`): Name of the MongoDB database to use
 
-**options?:** (`MongoClientOptions`): Optional MongoDB client options
+**options** (`MongoClientOptions`): Optional MongoDB client options
 
-**embeddingFieldPath?:** (`string`): Path to the field that stores vector embeddings. Supports nested paths using dot notation (e.g., 'text.contentEmbedding'). (Default: `embedding`)
+**embeddingFieldPath** (`string`): Path to the field that stores vector embeddings. Supports nested paths using dot notation (e.g., 'text.contentEmbedding'). (Default: `embedding`)
 
 ## Methods
 
@@ -73,47 +73,47 @@ const store = new MongoDBVector({
 
 Creates a new vector index (collection) in MongoDB.
 
-**indexName:** (`string`): Name of the collection to create
+**indexName** (`string`): Name of the collection to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
 ### upsert()
 
 Adds or updates vectors and their metadata in the collection.
 
-**indexName:** (`string`): Name of the collection to insert into
+**indexName** (`string`): Name of the collection to insert into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
 Searches for similar vectors with optional metadata filtering.
 
-**indexName:** (`string`): Name of the collection to search in
+**indexName** (`string`): Name of the collection to search in
 
-**queryVector:** (`number[]`): Query vector to find similar vectors for
+**queryVector** (`number[]`): Query vector to find similar vectors for
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters (applies to the \`metadata\` field)
+**filter** (`Record<string, any>`): Metadata filters (applies to the \`metadata\` field)
 
-**documentFilter?:** (`Record<string, any>`): Filters on original document fields (not just metadata)
+**documentFilter** (`Record<string, any>`): Filters on original document fields (not just metadata)
 
-**includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
-**minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
+**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
 ### describeIndex()
 
 Returns information about the index (collection).
 
-**indexName:** (`string`): Name of the collection to describe
+**indexName** (`string`): Name of the collection to describe
 
 Returns:
 
@@ -129,7 +129,7 @@ interface IndexStats {
 
 Deletes a collection and all its data.
 
-**indexName:** (`string`): Name of the collection to delete
+**indexName** (`string`): Name of the collection to delete
 
 ### listIndexes()
 
@@ -141,35 +141,35 @@ Returns: `Promise<string[]>`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the collection containing the vector
+**indexName** (`string`): Name of the collection containing the vector
 
-**id?:** (`string`): ID of the vector entry to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector entry to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`object`): Update data containing vector and/or metadata
+**update** (`object`): Update data containing vector and/or metadata
 
-**update.vector?:** (`number[]`): New vector data to update
+**update.vector** (`number[]`): New vector data to update
 
-**update.metadata?:** (`Record<string, any>`): New metadata to update
+**update.metadata** (`Record<string, any>`): New metadata to update
 
 ### deleteVector()
 
 Deletes a specific vector entry from an index by its ID.
 
-**indexName:** (`string`): Name of the collection containing the vector
+**indexName** (`string`): Name of the collection containing the vector
 
-**id:** (`string`): ID of the vector entry to delete
+**id** (`string`): ID of the vector entry to delete
 
 ### deleteVectors()
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the collection containing the vectors to delete
+**indexName** (`string`): Name of the collection containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ### disconnect()
 

package/dist/docs/references/reference-vectors-pg.md

@@ -4,27 +4,27 @@ The PgVector class provides vector search using [PostgreSQL](https://www.postgre
 
 ## Constructor Options
 
-**connectionString?:** (`string`): PostgreSQL connection URL
+**connectionString** (`string`): PostgreSQL connection URL
 
-**host?:** (`string`): PostgreSQL server host
+**host** (`string`): PostgreSQL server host
 
-**port?:** (`number`): PostgreSQL server port
+**port** (`number`): PostgreSQL server port
 
-**database?:** (`string`): PostgreSQL database name
+**database** (`string`): PostgreSQL database name
 
-**user?:** (`string`): PostgreSQL user
+**user** (`string`): PostgreSQL user
 
-**password?:** (`string`): PostgreSQL password
+**password** (`string`): PostgreSQL password
 
-**ssl?:** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
+**ssl** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
 
-**schemaName?:** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
+**schemaName** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
 
-**max?:** (`number`): Maximum number of pool connections (default: 20)
+**max** (`number`): Maximum number of pool connections (default: 20)
 
-**idleTimeoutMillis?:** (`number`): Idle connection timeout in milliseconds (default: 30000)
+**idleTimeoutMillis** (`number`): Idle connection timeout in milliseconds (default: 30000)
 
-**pgPoolOptions?:** (`PoolConfig`): Additional pg pool configuration options
+**pgPoolOptions** (`PoolConfig`): Additional pg pool configuration options
 
 ## Constructor Examples
 
@@ -72,23 +72,35 @@ const vectorStore = new PgVector({
 
 ### createIndex()
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-**indexConfig?:** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
+**indexConfig** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
 
-**buildIndex?:** (`boolean`): Whether to build the index (Default: `true`)
+**buildIndex** (`boolean`): Whether to build the index (Default: `true`)
 
 #### IndexConfig
 
-**type:** (`'flat' | 'hnsw' | 'ivfflat'`): stringflat:flatSequential scan (no index) that performs exhaustive search.ivfflat:ivfflatClusters vectors into lists for approximate search.hnsw:hnswGraph-based index offering fast search times and high recall. (Default: `ivfflat`)
+**type** (`'flat' | 'hnsw' | 'ivfflat'`): Index type (Default: `ivfflat`)
 
-**ivf?:** (`IVFConfig`): objectlists?:numberNumber of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
+**type.flat** (`flat`): Sequential scan (no index) that performs exhaustive search.
 
-**hnsw?:** (`HNSWConfig`): objectm?:numberMaximum number of connections per node (default: 8)efConstruction?:numberBuild-time complexity (default: 32)
+**type.ivfflat** (`ivfflat`): Clusters vectors into lists for approximate search.
+
+**type.hnsw** (`hnsw`): Graph-based index offering fast search times and high recall.
+
+**ivf** (`IVFConfig`): IVF configuration
+
+**ivf.lists** (`number`): Number of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
+
+**hnsw** (`HNSWConfig`): HNSW configuration
+
+**hnsw\.m** (`number`): Maximum number of connections per node (default: 8)
+
+**hnsw\.efConstruction** (`number`): Build-time complexity (default: 32)
 
 #### Memory Requirements
 
@@ -102,29 +114,33 @@ Higher M values or efConstruction values will increase memory requirements signi
 
 ### upsert()
 
-**indexName:** (`string`): Name of the index to upsert vectors into
+**indexName** (`string`): Name of the index to upsert vectors into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
+
+**queryVector** (`number[]`): Query vector
+
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**queryVector:** (`number[]`): Query vector
+**filter** (`Record<string, any>`): Metadata filters
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
 
-**filter?:** (`Record<string, any>`): Metadata filters
+**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
-**includeVector?:** (`boolean`): Whether to include the vector in the result (Default: `false`)
+**options** (`{ ef?: number; probes?: number }`): Additional options for HNSW and IVF indexes
 
-**minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
+**options.ef** (`number`): HNSW search parameter
 
-**options?:** (`{ ef?: number; probes?: number }`): objectef?:numberHNSW search parameterprobes?:numberIVF search parameter
+**options.probes** (`number`): IVF search parameter
 
 ### listIndexes()
 
@@ -132,7 +148,7 @@ Returns an array of index names as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -153,19 +169,19 @@ interface PGIndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### updateVector()
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
+**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
 Updates an existing vector by ID or filter. At least one of vector or metadata must be provided in the update object.
 
@@ -192,9 +208,9 @@ await pgVector.updateVector({
 
 ### deleteVector()
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector to delete
+**id** (`string`): ID of the vector to delete
 
 Deletes a single vector by ID from the specified index.
 
@@ -206,11 +222,11 @@ await pgVector.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ### disconnect()
 
@@ -218,11 +234,11 @@ Closes the database connection pool. Should be called when done using the store.
 
 ### buildIndex()
 
-**indexName:** (`string`): Name of the index to define
+**indexName** (`string`): Name of the index to define
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-**indexConfig:** (`IndexConfig`): Configuration for the index type and parameters
+**indexConfig** (`IndexConfig`): Configuration for the index type and parameters
 
 Builds or rebuilds an index with specified metric and configuration. Will drop any existing index before creating the new one.