@mastra/opensearch 0.0.0-vector-sources-20250516175436 → 0.0.0-vector-query-tool-provider-options-20250828222356

package/dist/_tsup-dts-rollup.d.cts

@@ -1,186 +0,0 @@
-import { BaseFilterTranslator } from '@mastra/core/vector/filter';
-import type { CreateIndexParams } from '@mastra/core';
-import type { DeleteIndexParams } from '@mastra/core';
-import type { DeleteVectorParams } from '@mastra/core';
-import type { DescribeIndexParams } from '@mastra/core';
-import type { IndexStats } from '@mastra/core';
-import { MastraVector } from '@mastra/core/vector';
-import type { OperatorSupport } from '@mastra/core/vector/filter';
-import type { ParamsToArgs } from '@mastra/core';
-import type { QueryResult } from '@mastra/core';
-import type { QueryVectorParams } from '@mastra/core';
-import type { UpdateVectorParams } from '@mastra/core';
-import type { UpsertVectorParams } from '@mastra/core';
-import type { VectorFilter } from '@mastra/core/vector/filter';
-
-/**
- * Translator for OpenSearch filter queries.
- * Maintains OpenSearch-compatible syntax while ensuring proper validation
- * and normalization of values.
- */
-export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
-    protected getSupportedOperators(): OperatorSupport;
-    translate(filter?: VectorFilter): VectorFilter;
-    private translateNode;
-    /**
-     * Handles translation of nested objects with dot notation fields
-     */
-    private translateNestedObject;
-    private translateLogicalOperator;
-    private translateFieldOperator;
-    /**
-     * Translates regex patterns to OpenSearch query syntax
-     */
-    private translateRegexOperator;
-    private addKeywordIfNeeded;
-    /**
-     * Helper method to handle special cases for the $not operator
-     */
-    private handleNotOperatorSpecialCases;
-    private translateOperator;
-    /**
-     * Translates field conditions to OpenSearch query syntax
-     * Handles special cases like range queries and multiple operators
-     */
-    private translateFieldConditions;
-    /**
-     * Checks if conditions can be optimized to a range query
-     */
-    private canOptimizeToRangeQuery;
-    /**
-     * Creates a range query from numeric operators
-     */
-    private createRangeQuery;
-}
-
-declare class OpenSearchVector extends MastraVector {
-    private client;
-    /**
-     * @deprecated Passing a string URL is deprecated. Use an object parameter: { url }.
-     * @param url - The OpenSearch node URL (deprecated)
-     */
-    constructor(url: string);
-    /**
-     * Creates a new OpenSearchVector client.
-     *
-     * @param params - An object with a url property specifying the OpenSearch node.
-     */
-    constructor(params: {
-        url: string;
-    });
-    /**
-     * 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(params: CreateIndexParams): Promise<void>;
-    /**
-     * Lists all indexes.
-     *
-     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
-     */
-    listIndexes(): Promise<string[]>;
-    /**
-     * Retrieves statistics about a vector index.
-     *
-     * @param params - The parameters for describing an index
-     * @param params.indexName - The name of the index to describe
-     * @returns A promise that resolves to the index statistics including dimension, count and metric
-     */
-    describeIndex(...args: ParamsToArgs<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(...args: ParamsToArgs<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(params: 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. For more on filters in OpenSearch, see the filtering reference: https://opensearch.org/docs/latest/query-dsl/
-     * @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(params: QueryVectorParams): 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 OpenSearch DSL.
-     *
-     * @param {VectorFilter} filter - The filter to transform.
-     * @returns {Record<string, any>} The transformed filter.
-     */
-    private transformFilter;
-    /**
-     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @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.
-     */
-    updateIndexById(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
-    /**
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @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(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
-    /**
-     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * 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.
-     */
-    deleteIndexById(indexName: string, id: string): Promise<void>;
-    /**
-     * 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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
-}
-export { OpenSearchVector }
-export { OpenSearchVector as OpenSearchVector_alias_1 }
-
-export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -1,186 +0,0 @@
-import { BaseFilterTranslator } from '@mastra/core/vector/filter';
-import type { CreateIndexParams } from '@mastra/core';
-import type { DeleteIndexParams } from '@mastra/core';
-import type { DeleteVectorParams } from '@mastra/core';
-import type { DescribeIndexParams } from '@mastra/core';
-import type { IndexStats } from '@mastra/core';
-import { MastraVector } from '@mastra/core/vector';
-import type { OperatorSupport } from '@mastra/core/vector/filter';
-import type { ParamsToArgs } from '@mastra/core';
-import type { QueryResult } from '@mastra/core';
-import type { QueryVectorParams } from '@mastra/core';
-import type { UpdateVectorParams } from '@mastra/core';
-import type { UpsertVectorParams } from '@mastra/core';
-import type { VectorFilter } from '@mastra/core/vector/filter';
-
-/**
- * Translator for OpenSearch filter queries.
- * Maintains OpenSearch-compatible syntax while ensuring proper validation
- * and normalization of values.
- */
-export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
-    protected getSupportedOperators(): OperatorSupport;
-    translate(filter?: VectorFilter): VectorFilter;
-    private translateNode;
-    /**
-     * Handles translation of nested objects with dot notation fields
-     */
-    private translateNestedObject;
-    private translateLogicalOperator;
-    private translateFieldOperator;
-    /**
-     * Translates regex patterns to OpenSearch query syntax
-     */
-    private translateRegexOperator;
-    private addKeywordIfNeeded;
-    /**
-     * Helper method to handle special cases for the $not operator
-     */
-    private handleNotOperatorSpecialCases;
-    private translateOperator;
-    /**
-     * Translates field conditions to OpenSearch query syntax
-     * Handles special cases like range queries and multiple operators
-     */
-    private translateFieldConditions;
-    /**
-     * Checks if conditions can be optimized to a range query
-     */
-    private canOptimizeToRangeQuery;
-    /**
-     * Creates a range query from numeric operators
-     */
-    private createRangeQuery;
-}
-
-declare class OpenSearchVector extends MastraVector {
-    private client;
-    /**
-     * @deprecated Passing a string URL is deprecated. Use an object parameter: { url }.
-     * @param url - The OpenSearch node URL (deprecated)
-     */
-    constructor(url: string);
-    /**
-     * Creates a new OpenSearchVector client.
-     *
-     * @param params - An object with a url property specifying the OpenSearch node.
-     */
-    constructor(params: {
-        url: string;
-    });
-    /**
-     * 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(params: CreateIndexParams): Promise<void>;
-    /**
-     * Lists all indexes.
-     *
-     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
-     */
-    listIndexes(): Promise<string[]>;
-    /**
-     * Retrieves statistics about a vector index.
-     *
-     * @param params - The parameters for describing an index
-     * @param params.indexName - The name of the index to describe
-     * @returns A promise that resolves to the index statistics including dimension, count and metric
-     */
-    describeIndex(...args: ParamsToArgs<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(...args: ParamsToArgs<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(params: 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. For more on filters in OpenSearch, see the filtering reference: https://opensearch.org/docs/latest/query-dsl/
-     * @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(params: QueryVectorParams): 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 OpenSearch DSL.
-     *
-     * @param {VectorFilter} filter - The filter to transform.
-     * @returns {Record<string, any>} The transformed filter.
-     */
-    private transformFilter;
-    /**
-     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @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.
-     */
-    updateIndexById(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
-    /**
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @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(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
-    /**
-     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * 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.
-     */
-    deleteIndexById(indexName: string, id: string): Promise<void>;
-    /**
-     * 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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
-}
-export { OpenSearchVector }
-export { OpenSearchVector as OpenSearchVector_alias_1 }
-
-export { }

package/dist/index.d.cts

@@ -1 +0,0 @@
-export { OpenSearchVector } from './_tsup-dts-rollup.cjs';