@mastra/qdrant 0.0.0-commonjs-20250227130920

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,82 @@
+# @mastra/qdrant
+
+Vector store implementation for Qdrant using the official @qdrant/js-client-rest SDK with added telemetry support.
+
+## Installation
+
+```bash
+pnpm add @mastra/qdrant
+```
+
+## Usage
+
+```typescript
+import { QdrantVector } from '@mastra/qdrant';
+
+const vectorStore = new QdrantVector(
+  'http://localhost:6333', // url
+  'optional-api-key',      // optional
+  false                    // https (optional)
+);
+
+// Create a new collection
+await vectorStore.createIndex('my-collection', 1536, 'cosine');
+
+// Add vectors
+const vectors = [[0.1, 0.2, ...], [0.3, 0.4, ...]];
+const metadata = [{ text: 'doc1' }, { text: 'doc2' }];
+const ids = await vectorStore.upsert('my-collection', vectors, metadata);
+
+// Query vectors
+const results = await vectorStore.query(
+  'my-collection',
+  [0.1, 0.2, ...],
+  10, // topK
+  { text: { $eq: 'doc1' } }, // optional filter
+  false // includeVector
+);
+```
+
+## Configuration
+
+Required:
+
+- `url`: URL of your Qdrant instance
+
+Optional:
+
+- `apiKey`: API key for authentication
+- `https`: Whether to use HTTPS (default: false)
+
+## Features
+
+- Vector similarity search with Cosine, Euclidean, and Dot Product metrics
+- Automatic batching for large upserts (256 vectors per batch)
+- Built-in telemetry support
+- Metadata filtering
+- Optional vector inclusion in query results
+- Automatic UUID generation for vectors
+- Support for both local and cloud deployments
+- Built on top of @qdrant/js-client-rest SDK
+
+## Distance Metrics
+
+The following distance metrics are supported:
+
+- `cosine` → Cosine distance
+- `euclidean` → Euclidean distance
+- `dotproduct` → Dot product
+
+## Methods
+
+- `createIndex(indexName, dimension, metric?)`: Create a new collection
+- `upsert(indexName, vectors, metadata?, ids?)`: Add or update vectors
+- `query(indexName, queryVector, topK?, filter?, includeVector?)`: Search for similar vectors
+- `listIndexes()`: List all collections
+- `describeIndex(indexName)`: Get collection statistics
+- `deleteIndex(indexName)`: Delete a collection
+
+## Related Links
+
+- [Qdrant Documentation](https://qdrant.tech/documentation/)
+- [Qdrant REST API Reference](https://qdrant.github.io/qdrant/redoc/index.html)

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

@@ -0,0 +1,58 @@
+import { BaseFilterTranslator } from '@mastra/core/filter';
+import type { Filter } from '@mastra/core/filter';
+import type { IndexStats } from '@mastra/core/vector';
+import type { LogicalOperator } from '@mastra/core/filter';
+import { MastraVector } from '@mastra/core/vector';
+import type { OperatorSupport } from '@mastra/core/filter';
+import type { QueryResult } from '@mastra/core/vector';
+
+/**
+ * Translates MongoDB-style filters to Qdrant compatible filters.
+ *
+ * Key transformations:
+ * - $and -> must
+ * - $or -> should
+ * - $not -> must_not
+ * - { field: { $op: value } } -> { key: field, match/range: { value/gt/lt: value } }
+ *
+ * Custom operators (Qdrant-specific):
+ * - $count -> values_count (array length/value count)
+ * - $geo -> geo filters (box, radius, polygon)
+ * - $hasId -> has_id filter
+ * - $nested -> nested object filters
+ * - $hasVector -> vector existence check
+ * - $datetime -> RFC 3339 datetime range
+ * - $null -> is_null check
+ * - $empty -> is_empty check
+ */
+export declare class QdrantFilterTranslator extends BaseFilterTranslator {
+    protected isLogicalOperator(key: string): key is LogicalOperator;
+    protected getSupportedOperators(): OperatorSupport;
+    translate(filter?: Filter): Filter | undefined;
+    private createCondition;
+    private translateNode;
+    private buildFinalConditions;
+    private handleLogicalOperators;
+    private handleFieldConditions;
+    private translateCustomOperator;
+    private getQdrantLogicalOp;
+    private translateOperatorValue;
+    private translateGeoFilter;
+    private normalizeDatetimeRange;
+}
+
+declare class QdrantVector extends MastraVector {
+    private client;
+    constructor(url: string, apiKey?: string, https?: boolean);
+    upsert(indexName: string, vectors: number[][], metadata?: Record<string, any>[], ids?: string[]): Promise<string[]>;
+    createIndex(indexName: string, dimension: number, metric?: 'cosine' | 'euclidean' | 'dotproduct'): Promise<void>;
+    transformFilter(filter?: Filter): Filter | undefined;
+    query(indexName: string, queryVector: number[], topK?: number, filter?: Filter, includeVector?: boolean): Promise<QueryResult[]>;
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    deleteIndex(indexName: string): Promise<void>;
+}
+export { QdrantVector }
+export { QdrantVector as QdrantVector_alias_1 }
+
+export { }

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

@@ -0,0 +1,58 @@
+import { BaseFilterTranslator } from '@mastra/core/filter';
+import type { Filter } from '@mastra/core/filter';
+import type { IndexStats } from '@mastra/core/vector';
+import type { LogicalOperator } from '@mastra/core/filter';
+import { MastraVector } from '@mastra/core/vector';
+import type { OperatorSupport } from '@mastra/core/filter';
+import type { QueryResult } from '@mastra/core/vector';
+
+/**
+ * Translates MongoDB-style filters to Qdrant compatible filters.
+ *
+ * Key transformations:
+ * - $and -> must
+ * - $or -> should
+ * - $not -> must_not
+ * - { field: { $op: value } } -> { key: field, match/range: { value/gt/lt: value } }
+ *
+ * Custom operators (Qdrant-specific):
+ * - $count -> values_count (array length/value count)
+ * - $geo -> geo filters (box, radius, polygon)
+ * - $hasId -> has_id filter
+ * - $nested -> nested object filters
+ * - $hasVector -> vector existence check
+ * - $datetime -> RFC 3339 datetime range
+ * - $null -> is_null check
+ * - $empty -> is_empty check
+ */
+export declare class QdrantFilterTranslator extends BaseFilterTranslator {
+    protected isLogicalOperator(key: string): key is LogicalOperator;
+    protected getSupportedOperators(): OperatorSupport;
+    translate(filter?: Filter): Filter | undefined;
+    private createCondition;
+    private translateNode;
+    private buildFinalConditions;
+    private handleLogicalOperators;
+    private handleFieldConditions;
+    private translateCustomOperator;
+    private getQdrantLogicalOp;
+    private translateOperatorValue;
+    private translateGeoFilter;
+    private normalizeDatetimeRange;
+}
+
+declare class QdrantVector extends MastraVector {
+    private client;
+    constructor(url: string, apiKey?: string, https?: boolean);
+    upsert(indexName: string, vectors: number[][], metadata?: Record<string, any>[], ids?: string[]): Promise<string[]>;
+    createIndex(indexName: string, dimension: number, metric?: 'cosine' | 'euclidean' | 'dotproduct'): Promise<void>;
+    transformFilter(filter?: Filter): Filter | undefined;
+    query(indexName: string, queryVector: number[], topK?: number, filter?: Filter, includeVector?: boolean): Promise<QueryResult[]>;
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    deleteIndex(indexName: string): Promise<void>;
+}
+export { QdrantVector }
+export { QdrantVector as QdrantVector_alias_1 }
+
+export { }

package/dist/index.cjs

@@ -0,0 +1,336 @@
+'use strict';
+
+var vector = require('@mastra/core/vector');
+var jsClientRest = require('@qdrant/js-client-rest');
+var filter = require('@mastra/core/filter');
+
+// src/vector/index.ts
+var QdrantFilterTranslator = class extends filter.BaseFilterTranslator {
+  isLogicalOperator(key) {
+    return super.isLogicalOperator(key) || key === "$hasId" || key === "$hasVector";
+  }
+  getSupportedOperators() {
+    return {
+      ...filter.BaseFilterTranslator.DEFAULT_OPERATORS,
+      logical: ["$and", "$or", "$not"],
+      array: ["$in", "$nin"],
+      regex: ["$regex"],
+      custom: ["$count", "$geo", "$nested", "$datetime", "$null", "$empty", "$hasId", "$hasVector"]
+    };
+  }
+  translate(filter) {
+    if (this.isEmpty(filter)) return filter;
+    this.validateFilter(filter);
+    return this.translateNode(filter);
+  }
+  createCondition(type, value, fieldKey) {
+    const condition = { [type]: value };
+    return fieldKey ? { key: fieldKey, ...condition } : condition;
+  }
+  translateNode(node, isNested = false, fieldKey) {
+    if (!this.isEmpty(node) && typeof node === "object" && "must" in node) {
+      return node;
+    }
+    if (this.isPrimitive(node)) {
+      if (node === null) {
+        return { is_null: { key: fieldKey } };
+      }
+      return this.createCondition("match", { value: this.normalizeComparisonValue(node) }, fieldKey);
+    }
+    if (this.isRegex(node)) {
+      throw new Error("Direct regex pattern format is not supported in Qdrant");
+    }
+    if (Array.isArray(node)) {
+      return node.length === 0 ? { is_empty: { key: fieldKey } } : this.createCondition("match", { any: this.normalizeArrayValues(node) }, fieldKey);
+    }
+    const entries = Object.entries(node);
+    const logicalResult = this.handleLogicalOperators(entries, isNested);
+    if (logicalResult) {
+      return logicalResult;
+    }
+    const { conditions, range, matchCondition } = this.handleFieldConditions(entries, fieldKey);
+    if (Object.keys(range).length > 0) {
+      conditions.push({ key: fieldKey, range });
+    }
+    if (matchCondition) {
+      conditions.push({ key: fieldKey, match: matchCondition });
+    }
+    return this.buildFinalConditions(conditions, isNested);
+  }
+  buildFinalConditions(conditions, isNested) {
+    if (conditions.length === 0) {
+      return {};
+    } else if (conditions.length === 1 && isNested) {
+      return conditions[0];
+    } else {
+      return { must: conditions };
+    }
+  }
+  handleLogicalOperators(entries, isNested) {
+    const firstKey = entries[0]?.[0];
+    if (firstKey && this.isLogicalOperator(firstKey) && !this.isCustomOperator(firstKey)) {
+      const [key, value] = entries[0];
+      const qdrantOp = this.getQdrantLogicalOp(key);
+      return {
+        [qdrantOp]: Array.isArray(value) ? value.map((v) => this.translateNode(v, true)) : [this.translateNode(value, true)]
+      };
+    }
+    if (entries.length > 1 && !isNested && entries.every(([key]) => !this.isOperator(key) && !this.isCustomOperator(key))) {
+      return {
+        must: entries.map(([key, value]) => this.translateNode(value, true, key))
+      };
+    }
+    return null;
+  }
+  handleFieldConditions(entries, fieldKey) {
+    const conditions = [];
+    let range = {};
+    let matchCondition = null;
+    for (const [key, value] of entries) {
+      if (this.isCustomOperator(key)) {
+        const customOp = this.translateCustomOperator(key, value, fieldKey);
+        conditions.push(customOp);
+      } else if (this.isOperator(key)) {
+        const opResult = this.translateOperatorValue(key, value);
+        if (opResult.range) {
+          Object.assign(range, opResult.range);
+        } else {
+          matchCondition = opResult;
+        }
+      } else {
+        const nestedKey = fieldKey ? `${fieldKey}.${key}` : key;
+        const nestedCondition = this.translateNode(value, true, nestedKey);
+        if (nestedCondition.must) {
+          conditions.push(...nestedCondition.must);
+        } else if (!this.isEmpty(nestedCondition)) {
+          conditions.push(nestedCondition);
+        }
+      }
+    }
+    return { conditions, range, matchCondition };
+  }
+  translateCustomOperator(op, value, fieldKey) {
+    switch (op) {
+      case "$count":
+        const countConditions = Object.entries(value).reduce(
+          (acc, [k, v]) => ({
+            ...acc,
+            [k.replace("$", "")]: v
+          }),
+          {}
+        );
+        return { key: fieldKey, values_count: countConditions };
+      case "$geo":
+        const geoOp = this.translateGeoFilter(value.type, value);
+        return { key: fieldKey, ...geoOp };
+      case "$hasId":
+        return { has_id: Array.isArray(value) ? value : [value] };
+      case "$nested":
+        return {
+          nested: {
+            key: fieldKey,
+            filter: this.translateNode(value)
+          }
+        };
+      case "$hasVector":
+        return { has_vector: value };
+      case "$datetime":
+        return {
+          key: fieldKey,
+          range: this.normalizeDatetimeRange(value.range)
+        };
+      case "$null":
+        return { is_null: { key: fieldKey } };
+      case "$empty":
+        return { is_empty: { key: fieldKey } };
+      default:
+        throw new Error(`Unsupported custom operator: ${op}`);
+    }
+  }
+  getQdrantLogicalOp(op) {
+    switch (op) {
+      case "$and":
+        return "must";
+      case "$or":
+        return "should";
+      case "$not":
+        return "must_not";
+      default:
+        throw new Error(`Unsupported logical operator: ${op}`);
+    }
+  }
+  translateOperatorValue(operator, value) {
+    const normalizedValue = this.normalizeComparisonValue(value);
+    switch (operator) {
+      case "$eq":
+        return { value: normalizedValue };
+      case "$ne":
+        return { except: [normalizedValue] };
+      case "$gt":
+        return { range: { gt: normalizedValue } };
+      case "$gte":
+        return { range: { gte: normalizedValue } };
+      case "$lt":
+        return { range: { lt: normalizedValue } };
+      case "$lte":
+        return { range: { lte: normalizedValue } };
+      case "$in":
+        return { any: this.normalizeArrayValues(value) };
+      case "$nin":
+        return { except: this.normalizeArrayValues(value) };
+      case "$regex":
+        return { text: value };
+      case "exists":
+        return value ? {
+          must_not: [{ is_null: { key: value } }, { is_empty: { key: value } }]
+        } : {
+          is_empty: { key: value }
+        };
+      default:
+        throw new Error(`Unsupported operator: ${operator}`);
+    }
+  }
+  translateGeoFilter(type, value) {
+    switch (type) {
+      case "box":
+        return {
+          geo_bounding_box: {
+            top_left: value.top_left,
+            bottom_right: value.bottom_right
+          }
+        };
+      case "radius":
+        return {
+          geo_radius: {
+            center: value.center,
+            radius: value.radius
+          }
+        };
+      case "polygon":
+        return {
+          geo_polygon: {
+            exterior: value.exterior,
+            interiors: value.interiors
+          }
+        };
+      default:
+        throw new Error(`Unsupported geo filter type: ${type}`);
+    }
+  }
+  normalizeDatetimeRange(value) {
+    const range = {};
+    for (const [op, val] of Object.entries(value)) {
+      if (val instanceof Date) {
+        range[op] = val.toISOString();
+      } else if (typeof val === "string") {
+        range[op] = val;
+      }
+    }
+    return range;
+  }
+};
+
+// src/vector/index.ts
+var BATCH_SIZE = 256;
+var DISTANCE_MAPPING = {
+  cosine: "Cosine",
+  euclidean: "Euclid",
+  dotproduct: "Dot"
+};
+var QdrantVector = class extends vector.MastraVector {
+  client;
+  constructor(url, apiKey, https) {
+    super();
+    const baseClient = new jsClientRest.QdrantClient({
+      url,
+      apiKey,
+      https
+    });
+    const telemetry = this.__getTelemetry();
+    this.client = telemetry?.traceClass(baseClient, {
+      spanNamePrefix: "qdrant-vector",
+      attributes: {
+        "vector.type": "qdrant"
+      }
+    }) ?? baseClient;
+  }
+  async upsert(indexName, vectors, metadata, ids) {
+    const pointIds = ids || vectors.map(() => crypto.randomUUID());
+    const records = vectors.map((vector, i) => ({
+      id: pointIds[i],
+      vector,
+      payload: metadata?.[i] || {}
+    }));
+    for (let i = 0; i < records.length; i += BATCH_SIZE) {
+      const batch = records.slice(i, i + BATCH_SIZE);
+      await this.client.upsert(indexName, {
+        // @ts-expect-error
+        points: batch,
+        wait: true
+      });
+    }
+    return pointIds;
+  }
+  async createIndex(indexName, dimension, metric = "cosine") {
+    if (!Number.isInteger(dimension) || dimension <= 0) {
+      throw new Error("Dimension must be a positive integer");
+    }
+    await this.client.createCollection(indexName, {
+      vectors: {
+        // @ts-expect-error
+        size: dimension,
+        // @ts-expect-error
+        distance: DISTANCE_MAPPING[metric]
+      }
+    });
+  }
+  transformFilter(filter) {
+    const translator = new QdrantFilterTranslator();
+    return translator.translate(filter);
+  }
+  async query(indexName, queryVector, topK = 10, filter, includeVector = false) {
+    const translatedFilter = this.transformFilter(filter);
+    const results = (await this.client.query(indexName, {
+      query: queryVector,
+      limit: topK,
+      filter: translatedFilter,
+      with_payload: true,
+      with_vector: includeVector
+    })).points;
+    return results.map((match) => {
+      let vector = [];
+      if (includeVector) {
+        if (Array.isArray(match.vector)) {
+          vector = match.vector;
+        } else if (typeof match.vector === "object" && match.vector !== null) {
+          vector = Object.values(match.vector).filter((v) => typeof v === "number");
+        }
+      }
+      return {
+        id: match.id,
+        score: match.score || 0,
+        metadata: match.payload,
+        ...includeVector && { vector }
+      };
+    });
+  }
+  async listIndexes() {
+    const response = await this.client.getCollections();
+    return response.collections.map((collection) => collection.name) || [];
+  }
+  async describeIndex(indexName) {
+    const { config, points_count } = await this.client.getCollection(indexName);
+    const distance = config.params.vectors?.distance;
+    return {
+      dimension: config.params.vectors?.size,
+      count: points_count || 0,
+      // @ts-expect-error
+      metric: Object.keys(DISTANCE_MAPPING).find((key) => DISTANCE_MAPPING[key] === distance)
+    };
+  }
+  async deleteIndex(indexName) {
+    await this.client.deleteCollection(indexName);
+  }
+};
+
+exports.QdrantVector = QdrantVector;

package/dist/index.d.cts

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

package/dist/index.d.ts

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