@mastra/qdrant 1.0.0 → 1.0.1

package/dist/docs/vectors/01-reference.md

@@ -1,160 +0,0 @@
-# Vectors API Reference
-
-> API reference for vectors - 1 entries
-
-
----
-
-## Reference: Qdrant Vector Store
-
-> Documentation for integrating Qdrant with Mastra, a vector similarity search engine for managing vectors and payloads.
-
-The QdrantVector class provides vector search using [Qdrant](https://qdrant.tech/), a vector similarity search engine.
-It provides a production-ready service with a convenient API to store, search, and manage vectors with additional payload and extended filtering support.
-
-## Constructor Options
-
-## Methods
-
-### createIndex()
-
-#### Creating a Named Vectors Collection
-
-```typescript
-// Create a collection with multiple named vector spaces
-await store.createIndex({
-  indexName: "multi_modal",
-  dimension: 768, // fallback
-  namedVectors: {
-    text: { size: 768, distance: "cosine" },
-    image: { size: 512, distance: "euclidean" },
-  },
-});
-```
-
-### upsert()
-
-#### Upserting into Named Vector Spaces
-
-```typescript
-// Upsert into the "text" vector space
-await store.upsert({
-  indexName: "multi_modal",
-  vectors: textEmbeddings,
-  metadata: textMetadata,
-  vectorName: "text",
-});
-
-// Upsert into the "image" vector space
-await store.upsert({
-  indexName: "multi_modal",
-  vectors: imageEmbeddings,
-  metadata: imageMetadata,
-  vectorName: "image",
-});
-```
-
-### query()
-
-#### Named Vectors
-
-Qdrant supports [named vectors](https://qdrant.tech/documentation/concepts/vectors/#named-vectors), allowing multiple vector fields per collection. Use the `using` parameter to specify which named vector to query against:
-
-```typescript
-const results = await store.query({
-  indexName: "my_index",
-  queryVector: embedding,
-  topK: 10,
-  using: "title_embedding", // Query against a specific named vector
-});
-```
-
-### listIndexes()
-
-Returns an array of index names as strings.
-
-### describeIndex()
-
-Returns:
-
-```typescript
-interface IndexStats {
-  dimension: number;
-  count: number;
-  metric: "cosine" | "euclidean" | "dotproduct";
-}
-```
-
-### deleteIndex()
-
-### updateVector()
-
-Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
-
-Updates a vector and/or its metadata in the specified index. If both vector and metadata are provided, both will be updated. If only one is provided, only that will be updated.
-
-### deleteVector()
-
-Deletes a vector from the specified index by its ID.
-
-### deleteVectors()
-
-Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
-
-### createPayloadIndex()
-
-Creates a payload (metadata) index on a collection field to enable efficient filtering. This is **required** for Qdrant Cloud and any Qdrant instance with `strict_mode_config = true`.
-
-```typescript
-// Create a keyword index for filtering by source
-await store.createPayloadIndex({
-  indexName: "my_index",
-  fieldName: "source",
-  fieldSchema: "keyword",
-});
-
-const results = await store.query({
-  indexName: "my_index",
-  queryVector: queryVector,
-  filter: { source: "document-a" },
-});
-```
-
-### deletePayloadIndex()
-
-Removes a payload index from a collection field.
-
-## Response Types
-
-Query results are returned in this format:
-
-```typescript
-interface QueryResult {
-  id: string;
-  score: number;
-  metadata: Record<string, any>;
-  vector?: number[]; // Only included if includeVector is true
-}
-```
-
-## Error Handling
-
-The store throws typed errors that can be caught:
-
-```typescript
-try {
-  await store.query({
-    indexName: "index_name",
-    queryVector: queryVector,
-  });
-} catch (error) {
-  if (error instanceof VectorStoreError) {
-    console.log(error.code); // 'connection_failed' | 'invalid_dimension' | etc
-    console.log(error.details); // Additional error context
-  }
-}
-```
-
-## Related
-
-- [Metadata Filters](../rag/metadata-filters)