@mastra/elasticsearch 1.3.0 → 1.3.1

package/dist/index.d.cts

@@ -1,140 +1,142 @@
-import { Client } from '@elastic/elasticsearch';
-import { MastraVector, CreateIndexParams, DescribeIndexParams, IndexStats, DeleteIndexParams, UpsertVectorParams, QueryVectorParams, QueryResult, UpdateVectorParams, DeleteVectorParams, DeleteVectorsParams } from '@mastra/core/vector';
-import { VectorFilter, OperatorValueMap, LogicalOperatorValueMap, BlacklistedRootOperators } from '@mastra/core/vector/filter';
-
+import { Client } from "@elastic/elasticsearch";
+import { CreateIndexParams, DeleteIndexParams, DeleteVectorParams, DeleteVectorsParams, DescribeIndexParams, IndexStats, MastraVector, QueryResult, QueryVectorParams, UpdateVectorParams, UpsertVectorParams } from "@mastra/core/vector";
+import { BlacklistedRootOperators, LogicalOperatorValueMap, OperatorValueMap, VectorFilter } from "@mastra/core/vector/filter";
+//#region src/vector/filter.d.ts
 type ElasticSearchOperatorValueMap = Omit<OperatorValueMap, '$options' | '$nor' | '$elemMatch'>;
 type ElasticSearchLogicalOperatorValueMap = Omit<LogicalOperatorValueMap, '$nor'>;
 type ElasticSearchBlacklisted = BlacklistedRootOperators | '$nor';
 type ElasticSearchVectorFilter = VectorFilter<keyof ElasticSearchOperatorValueMap, ElasticSearchOperatorValueMap, ElasticSearchLogicalOperatorValueMap, ElasticSearchBlacklisted>;
-
+//#endregion
+//#region src/vector/index.d.ts
 type ElasticSearchVectorParams = QueryVectorParams<ElasticSearchVectorFilter>;
 type ElasticSearchAuth = {
-    apiKey: string;
+  apiKey: string;
 } | {
-    username: string;
-    password: string;
+  username: string;
+  password: string;
 } | {
-    bearer: string;
+  bearer: string;
 };
 type ElasticSearchVectorConfig = {
-    id: string;
-    client: Client;
-    url?: never;
-    auth?: never;
+  id: string;
+  client: Client;
+  url?: never;
+  auth?: never;
 } | {
-    id: string;
-    url: string;
-    auth?: ElasticSearchAuth;
-    client?: never;
+  id: string;
+  url: string;
+  auth?: ElasticSearchAuth;
+  client?: never;
 };
 declare class ElasticSearchVector extends MastraVector<ElasticSearchVectorFilter> {
-    private client;
-    /**
-     * Creates a new ElasticSearchVector client.
-     *
-     * Accepts either a pre-configured ElasticSearch client or connection parameters:
-     * - `{ id, client }` - Use an existing ElasticSearch client
-     * - `{ id, url, auth? }` - Create a new client from connection parameters
-     */
-    constructor(config: ElasticSearchVectorConfig);
-    /**
-     * Creates a new collection with the specified configuration.
-     *
-     * @param {string} indexName - The name of the collection to create.
-     * @param {number} dimension - The dimension of the vectors to be stored in the collection.
-     * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
-     * @returns {Promise<void>} A promise that resolves when the collection is created.
-     */
-    createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
-    /**
-     * Lists all indexes.
-     *
-     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
-     */
-    listIndexes(): Promise<string[]>;
-    /**
-     * Validates that an existing index matches the requested dimension and metric.
-     * Throws an error if there's a mismatch, otherwise allows idempotent creation.
-     */
-    protected validateExistingIndex(indexName: string, dimension: number, metric: string): Promise<void>;
-    /**
-     * Retrieves statistics about a vector index.
-     *
-     * @param {string} indexName - The name of the index to describe
-     * @returns A promise that resolves to the index statistics including dimension, count and metric
-     */
-    describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
-    /**
-     * Deletes the specified index.
-     *
-     * @param {string} indexName - The name of the index to delete.
-     * @returns {Promise<void>} A promise that resolves when the index is deleted.
-     */
-    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
-    /**
-     * Inserts or updates vectors in the specified collection.
-     *
-     * @param {string} indexName - The name of the collection to upsert into.
-     * @param {number[][]} vectors - An array of vectors to upsert.
-     * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
-     * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
-     * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
-     */
-    upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
-    /**
-     * Queries the specified collection using a vector and optional filter.
-     *
-     * @param {string} indexName - The name of the collection to query.
-     * @param {number[]} queryVector - The vector to query with.
-     * @param {number} [topK] - The maximum number of results to return.
-     * @param {Record<string, any>} [filter] - An optional filter to apply to the query.
-     * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
-     * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
-     */
-    query({ indexName, queryVector, filter, topK, includeVector, }: ElasticSearchVectorParams): Promise<QueryResult[]>;
-    /**
-     * Validates the dimensions of the vectors.
-     *
-     * @param {number[][]} vectors - The vectors to validate.
-     * @param {number} dimension - The dimension of the vectors.
-     * @returns {void}
-     */
-    private validateVectorDimensions;
-    /**
-     * Transforms the filter to the ElasticSearch DSL.
-     *
-     * @param {ElasticSearchVectorFilter} filter - The filter to transform.
-     * @returns {Record<string, any>} The transformed filter.
-     */
-    private transformFilter;
-    /**
-     * Updates vectors by ID or filter with the provided vector and/or metadata.
-     * @param params - Parameters containing either id or filter for targeting vectors to update
-     * @param params.indexName - The name of the index containing the vector(s).
-     * @param params.id - The ID of a single vector to update (mutually exclusive with filter).
-     * @param params.filter - A filter to match multiple vectors to update (mutually exclusive with id).
-     * @param params.update - An object containing the vector and/or metadata to update.
-     * @returns A promise that resolves when the update is complete.
-     * @throws Will throw an error if no updates are provided or if the update operation fails.
-     */
-    updateVector(params: UpdateVectorParams<ElasticSearchVectorFilter>): Promise<void>;
-    /**
-     * Updates a single vector by its ID.
-     */
-    private updateVectorById;
-    /**
-     * Updates multiple vectors matching a filter.
-     */
-    private updateVectorsByFilter;
-    /**
-     * Deletes a vector by its ID.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to delete.
-     * @returns A promise that resolves when the deletion is complete.
-     * @throws Will throw an error if the deletion operation fails.
-     */
-    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
-    deleteVectors({ indexName, filter, ids }: DeleteVectorsParams<ElasticSearchVectorFilter>): Promise<void>;
+  private client;
+  /**
+   * Creates a new ElasticSearchVector client.
+   *
+   * Accepts either a pre-configured ElasticSearch client or connection parameters:
+   * - `{ id, client }` - Use an existing ElasticSearch client
+   * - `{ id, url, auth? }` - Create a new client from connection parameters
+   */
+  constructor(config: ElasticSearchVectorConfig);
+  /**
+   * Creates a new collection with the specified configuration.
+   *
+   * @param {string} indexName - The name of the collection to create.
+   * @param {number} dimension - The dimension of the vectors to be stored in the collection.
+   * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
+   * @returns {Promise<void>} A promise that resolves when the collection is created.
+   */
+  createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
+  /**
+   * Lists all indexes.
+   *
+   * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
+   */
+  listIndexes(): Promise<string[]>;
+  /**
+   * Validates that an existing index matches the requested dimension and metric.
+   * Throws an error if there's a mismatch, otherwise allows idempotent creation.
+   */
+  protected validateExistingIndex(indexName: string, dimension: number, metric: string): Promise<void>;
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param {string} indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
+  /**
+   * Deletes the specified index.
+   *
+   * @param {string} indexName - The name of the index to delete.
+   * @returns {Promise<void>} A promise that resolves when the index is deleted.
+   */
+  deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
+  /**
+   * Inserts or updates vectors in the specified collection.
+   *
+   * @param {string} indexName - The name of the collection to upsert into.
+   * @param {number[][]} vectors - An array of vectors to upsert.
+   * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
+   * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
+   * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
+   */
+  upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
+  /**
+   * Queries the specified collection using a vector and optional filter.
+   *
+   * @param {string} indexName - The name of the collection to query.
+   * @param {number[]} queryVector - The vector to query with.
+   * @param {number} [topK] - The maximum number of results to return.
+   * @param {Record<string, any>} [filter] - An optional filter to apply to the query.
+   * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
+   * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
+   */
+  query({ indexName, queryVector, filter, topK, includeVector }: ElasticSearchVectorParams): Promise<QueryResult[]>;
+  /**
+   * Validates the dimensions of the vectors.
+   *
+   * @param {number[][]} vectors - The vectors to validate.
+   * @param {number} dimension - The dimension of the vectors.
+   * @returns {void}
+   */
+  private validateVectorDimensions;
+  /**
+   * Transforms the filter to the ElasticSearch DSL.
+   *
+   * @param {ElasticSearchVectorFilter} filter - The filter to transform.
+   * @returns {Record<string, any>} The transformed filter.
+   */
+  private transformFilter;
+  /**
+   * Updates vectors by ID or filter with the provided vector and/or metadata.
+   * @param params - Parameters containing either id or filter for targeting vectors to update
+   * @param params.indexName - The name of the index containing the vector(s).
+   * @param params.id - The ID of a single vector to update (mutually exclusive with filter).
+   * @param params.filter - A filter to match multiple vectors to update (mutually exclusive with id).
+   * @param params.update - An object containing the vector and/or metadata to update.
+   * @returns A promise that resolves when the update is complete.
+   * @throws Will throw an error if no updates are provided or if the update operation fails.
+   */
+  updateVector(params: UpdateVectorParams<ElasticSearchVectorFilter>): Promise<void>;
+  /**
+   * Updates a single vector by its ID.
+   */
+  private updateVectorById;
+  /**
+   * Updates multiple vectors matching a filter.
+   */
+  private updateVectorsByFilter;
+  /**
+   * Deletes a vector by its ID.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to delete.
+   * @returns A promise that resolves when the deletion is complete.
+   * @throws Will throw an error if the deletion operation fails.
+   */
+  deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
+  deleteVectors({ indexName, filter, ids }: DeleteVectorsParams<ElasticSearchVectorFilter>): Promise<void>;
 }
-
+//#endregion
 export { type ElasticSearchAuth, ElasticSearchVector, type ElasticSearchVectorConfig, type ElasticSearchVectorFilter };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/vector/filter.ts","../src/vector/index.ts"],"mappings":";;;;KAUK,gCAAgC,KAAK;KAErC,uCAAuC,KAAK;KAE5C,2BAA2B;KAEpB,4BAA4B,mBAChC,+BACN,+BACA,sCACA;;;KCaG,4BAA4B,kBAAkB;KAEvC;EAAsB;;EAAqB;EAAkB;;EAAuB;;KAEpF;EACN;EAAY,QAAQ;EAAqB;EAAa;;EACtD;EAAY;EAAa,OAAO;EAAmB;;cAE5C,4BAA4B,aAAa;UAC5C;;;;;;;;EASI,YAAA,QAAQ;;;;;;;;;EA6Bd,cAAc,WAAW,WAAW,UAAqB,oBAAoB;;;;;;EAkD7E,eAAe;;;;;YAwBL,sBAAsB,mBAAmB,mBAAmB,iBAAiB;;;;;;;EAoDvF,gBAAgB,aAAa,sBAAsB,QAAQ;;;;;;;EAqB3D,cAAc,aAAa,oBAAoB;;;;;;;;;;EA4B/C,SAAS,WAAW,SAAS,UAAe,OAAO,qBAAqB;;;;;;;;;;;EA+HxE,QACJ,WACA,aACA,QACA,MACA,iBACC,4BAA4B,QAAQ;;;;;;;;UA+D/B;;;;;;;UAYA;;;;;;;;;;;EAeF,aAAa,QAAQ,mBAAmB,6BAA6B;;;;UAwD7D;;;;UAuFA;;;;;;;;EAyDR,eAAe,WAAW,MAAM,qBAAqB;EA2BrD,gBAAgB,WAAW,QAAQ,OAAO,oBAAoB,6BAA6B"}

package/dist/index.d.ts

@@ -1,140 +1,142 @@
-import { Client } from '@elastic/elasticsearch';
-import { MastraVector, CreateIndexParams, DescribeIndexParams, IndexStats, DeleteIndexParams, UpsertVectorParams, QueryVectorParams, QueryResult, UpdateVectorParams, DeleteVectorParams, DeleteVectorsParams } from '@mastra/core/vector';
-import { VectorFilter, OperatorValueMap, LogicalOperatorValueMap, BlacklistedRootOperators } from '@mastra/core/vector/filter';
-
+import { Client } from "@elastic/elasticsearch";
+import { CreateIndexParams, DeleteIndexParams, DeleteVectorParams, DeleteVectorsParams, DescribeIndexParams, IndexStats, MastraVector, QueryResult, QueryVectorParams, UpdateVectorParams, UpsertVectorParams } from "@mastra/core/vector";
+import { BaseFilterTranslator, BlacklistedRootOperators, LogicalOperatorValueMap, OperatorValueMap, VectorFilter } from "@mastra/core/vector/filter";
+//#region src/vector/filter.d.ts
 type ElasticSearchOperatorValueMap = Omit<OperatorValueMap, '$options' | '$nor' | '$elemMatch'>;
 type ElasticSearchLogicalOperatorValueMap = Omit<LogicalOperatorValueMap, '$nor'>;
 type ElasticSearchBlacklisted = BlacklistedRootOperators | '$nor';
 type ElasticSearchVectorFilter = VectorFilter<keyof ElasticSearchOperatorValueMap, ElasticSearchOperatorValueMap, ElasticSearchLogicalOperatorValueMap, ElasticSearchBlacklisted>;
-
+//#endregion
+//#region src/vector/index.d.ts
 type ElasticSearchVectorParams = QueryVectorParams<ElasticSearchVectorFilter>;
 type ElasticSearchAuth = {
-    apiKey: string;
+  apiKey: string;
 } | {
-    username: string;
-    password: string;
+  username: string;
+  password: string;
 } | {
-    bearer: string;
+  bearer: string;
 };
 type ElasticSearchVectorConfig = {
-    id: string;
-    client: Client;
-    url?: never;
-    auth?: never;
+  id: string;
+  client: Client;
+  url?: never;
+  auth?: never;
 } | {
-    id: string;
-    url: string;
-    auth?: ElasticSearchAuth;
-    client?: never;
+  id: string;
+  url: string;
+  auth?: ElasticSearchAuth;
+  client?: never;
 };
 declare class ElasticSearchVector extends MastraVector<ElasticSearchVectorFilter> {
-    private client;
-    /**
-     * Creates a new ElasticSearchVector client.
-     *
-     * Accepts either a pre-configured ElasticSearch client or connection parameters:
-     * - `{ id, client }` - Use an existing ElasticSearch client
-     * - `{ id, url, auth? }` - Create a new client from connection parameters
-     */
-    constructor(config: ElasticSearchVectorConfig);
-    /**
-     * Creates a new collection with the specified configuration.
-     *
-     * @param {string} indexName - The name of the collection to create.
-     * @param {number} dimension - The dimension of the vectors to be stored in the collection.
-     * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
-     * @returns {Promise<void>} A promise that resolves when the collection is created.
-     */
-    createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
-    /**
-     * Lists all indexes.
-     *
-     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
-     */
-    listIndexes(): Promise<string[]>;
-    /**
-     * Validates that an existing index matches the requested dimension and metric.
-     * Throws an error if there's a mismatch, otherwise allows idempotent creation.
-     */
-    protected validateExistingIndex(indexName: string, dimension: number, metric: string): Promise<void>;
-    /**
-     * Retrieves statistics about a vector index.
-     *
-     * @param {string} indexName - The name of the index to describe
-     * @returns A promise that resolves to the index statistics including dimension, count and metric
-     */
-    describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
-    /**
-     * Deletes the specified index.
-     *
-     * @param {string} indexName - The name of the index to delete.
-     * @returns {Promise<void>} A promise that resolves when the index is deleted.
-     */
-    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
-    /**
-     * Inserts or updates vectors in the specified collection.
-     *
-     * @param {string} indexName - The name of the collection to upsert into.
-     * @param {number[][]} vectors - An array of vectors to upsert.
-     * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
-     * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
-     * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
-     */
-    upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
-    /**
-     * Queries the specified collection using a vector and optional filter.
-     *
-     * @param {string} indexName - The name of the collection to query.
-     * @param {number[]} queryVector - The vector to query with.
-     * @param {number} [topK] - The maximum number of results to return.
-     * @param {Record<string, any>} [filter] - An optional filter to apply to the query.
-     * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
-     * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
-     */
-    query({ indexName, queryVector, filter, topK, includeVector, }: ElasticSearchVectorParams): Promise<QueryResult[]>;
-    /**
-     * Validates the dimensions of the vectors.
-     *
-     * @param {number[][]} vectors - The vectors to validate.
-     * @param {number} dimension - The dimension of the vectors.
-     * @returns {void}
-     */
-    private validateVectorDimensions;
-    /**
-     * Transforms the filter to the ElasticSearch DSL.
-     *
-     * @param {ElasticSearchVectorFilter} filter - The filter to transform.
-     * @returns {Record<string, any>} The transformed filter.
-     */
-    private transformFilter;
-    /**
-     * Updates vectors by ID or filter with the provided vector and/or metadata.
-     * @param params - Parameters containing either id or filter for targeting vectors to update
-     * @param params.indexName - The name of the index containing the vector(s).
-     * @param params.id - The ID of a single vector to update (mutually exclusive with filter).
-     * @param params.filter - A filter to match multiple vectors to update (mutually exclusive with id).
-     * @param params.update - An object containing the vector and/or metadata to update.
-     * @returns A promise that resolves when the update is complete.
-     * @throws Will throw an error if no updates are provided or if the update operation fails.
-     */
-    updateVector(params: UpdateVectorParams<ElasticSearchVectorFilter>): Promise<void>;
-    /**
-     * Updates a single vector by its ID.
-     */
-    private updateVectorById;
-    /**
-     * Updates multiple vectors matching a filter.
-     */
-    private updateVectorsByFilter;
-    /**
-     * Deletes a vector by its ID.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to delete.
-     * @returns A promise that resolves when the deletion is complete.
-     * @throws Will throw an error if the deletion operation fails.
-     */
-    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
-    deleteVectors({ indexName, filter, ids }: DeleteVectorsParams<ElasticSearchVectorFilter>): Promise<void>;
+  private client;
+  /**
+   * Creates a new ElasticSearchVector client.
+   *
+   * Accepts either a pre-configured ElasticSearch client or connection parameters:
+   * - `{ id, client }` - Use an existing ElasticSearch client
+   * - `{ id, url, auth? }` - Create a new client from connection parameters
+   */
+  constructor(config: ElasticSearchVectorConfig);
+  /**
+   * Creates a new collection with the specified configuration.
+   *
+   * @param {string} indexName - The name of the collection to create.
+   * @param {number} dimension - The dimension of the vectors to be stored in the collection.
+   * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
+   * @returns {Promise<void>} A promise that resolves when the collection is created.
+   */
+  createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
+  /**
+   * Lists all indexes.
+   *
+   * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
+   */
+  listIndexes(): Promise<string[]>;
+  /**
+   * Validates that an existing index matches the requested dimension and metric.
+   * Throws an error if there's a mismatch, otherwise allows idempotent creation.
+   */
+  protected validateExistingIndex(indexName: string, dimension: number, metric: string): Promise<void>;
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param {string} indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
+  /**
+   * Deletes the specified index.
+   *
+   * @param {string} indexName - The name of the index to delete.
+   * @returns {Promise<void>} A promise that resolves when the index is deleted.
+   */
+  deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
+  /**
+   * Inserts or updates vectors in the specified collection.
+   *
+   * @param {string} indexName - The name of the collection to upsert into.
+   * @param {number[][]} vectors - An array of vectors to upsert.
+   * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
+   * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
+   * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
+   */
+  upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
+  /**
+   * Queries the specified collection using a vector and optional filter.
+   *
+   * @param {string} indexName - The name of the collection to query.
+   * @param {number[]} queryVector - The vector to query with.
+   * @param {number} [topK] - The maximum number of results to return.
+   * @param {Record<string, any>} [filter] - An optional filter to apply to the query.
+   * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
+   * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
+   */
+  query({ indexName, queryVector, filter, topK, includeVector }: ElasticSearchVectorParams): Promise<QueryResult[]>;
+  /**
+   * Validates the dimensions of the vectors.
+   *
+   * @param {number[][]} vectors - The vectors to validate.
+   * @param {number} dimension - The dimension of the vectors.
+   * @returns {void}
+   */
+  private validateVectorDimensions;
+  /**
+   * Transforms the filter to the ElasticSearch DSL.
+   *
+   * @param {ElasticSearchVectorFilter} filter - The filter to transform.
+   * @returns {Record<string, any>} The transformed filter.
+   */
+  private transformFilter;
+  /**
+   * Updates vectors by ID or filter with the provided vector and/or metadata.
+   * @param params - Parameters containing either id or filter for targeting vectors to update
+   * @param params.indexName - The name of the index containing the vector(s).
+   * @param params.id - The ID of a single vector to update (mutually exclusive with filter).
+   * @param params.filter - A filter to match multiple vectors to update (mutually exclusive with id).
+   * @param params.update - An object containing the vector and/or metadata to update.
+   * @returns A promise that resolves when the update is complete.
+   * @throws Will throw an error if no updates are provided or if the update operation fails.
+   */
+  updateVector(params: UpdateVectorParams<ElasticSearchVectorFilter>): Promise<void>;
+  /**
+   * Updates a single vector by its ID.
+   */
+  private updateVectorById;
+  /**
+   * Updates multiple vectors matching a filter.
+   */
+  private updateVectorsByFilter;
+  /**
+   * Deletes a vector by its ID.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to delete.
+   * @returns A promise that resolves when the deletion is complete.
+   * @throws Will throw an error if the deletion operation fails.
+   */
+  deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
+  deleteVectors({ indexName, filter, ids }: DeleteVectorsParams<ElasticSearchVectorFilter>): Promise<void>;
 }
-
+//#endregion
 export { type ElasticSearchAuth, ElasticSearchVector, type ElasticSearchVectorConfig, type ElasticSearchVectorFilter };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/vector/filter.ts","../src/vector/index.ts"],"mappings":";;;;KAUK,gCAAgC,KAAK;KAErC,uCAAuC,KAAK;KAE5C,2BAA2B;KAEpB,4BAA4B,mBAChC,+BACN,+BACA,sCACA;;;KCaG,4BAA4B,kBAAkB;KAEvC;EAAsB;;EAAqB;EAAkB;;EAAuB;;KAEpF;EACN;EAAY,QAAQ;EAAqB;EAAa;;EACtD;EAAY;EAAa,OAAO;EAAmB;;cAE5C,4BAA4B,aAAa;UAC5C;;;;;;;;EASI,YAAA,QAAQ;;;;;;;;;EA6Bd,cAAc,WAAW,WAAW,UAAqB,oBAAoB;;;;;;EAkD7E,eAAe;;;;;YAwBL,sBAAsB,mBAAmB,mBAAmB,iBAAiB;;;;;;;EAoDvF,gBAAgB,aAAa,sBAAsB,QAAQ;;;;;;;EAqB3D,cAAc,aAAa,oBAAoB;;;;;;;;;;EA4B/C,SAAS,WAAW,SAAS,UAAe,OAAO,qBAAqB;;;;;;;;;;;EA+HxE,QACJ,WACA,aACA,QACA,MACA,iBACC,4BAA4B,QAAQ;;;;;;;;UA+D/B;;;;;;;UAYA;;;;;;;;;;;EAeF,aAAa,QAAQ,mBAAmB,6BAA6B;;;;UAwD7D;;;;UAuFA;;;;;;;;EAyDR,eAAe,WAAW,MAAM,qBAAqB;EA2BrD,gBAAgB,WAAW,QAAQ,OAAO,oBAAoB,6BAA6B"}