@mastra/vectorize 0.0.0-provider-metadata-cache-20260218172243 → 0.0.0-react-sdk-20261005160725
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +17 -0
- package/README.md +20 -33
- package/dist/docs/SKILL.md +4 -7
- package/dist/docs/assets/SOURCE_MAP.json +1 -1
- package/dist/docs/references/{docs-rag-retrieval.md → reference-rag-retrieval.md} +286 -152
- package/dist/docs/references/reference-rag-vector-databases.md +808 -0
- package/dist/docs/references/reference-vectors-vectorize.md +69 -55
- package/dist/index.cjs +427 -403
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +401 -395
- package/dist/index.js.map +1 -1
- package/dist/vector/filter.d.ts.map +1 -1
- package/dist/vector/index.d.ts +10 -1
- package/dist/vector/index.d.ts.map +1 -1
- package/package.json +20 -19
- package/CHANGELOG.md +0 -2405
- package/dist/docs/references/docs-rag-vector-databases.md +0 -648
package/LICENSE.md
CHANGED
|
@@ -1,3 +1,20 @@
|
|
|
1
|
+
Portions of this software are licensed as follows:
|
|
2
|
+
|
|
3
|
+
- All content that resides under any directory named `ee/` within this
|
|
4
|
+
repository, including but not limited to:
|
|
5
|
+
- `@mastra/core/auth/ee`
|
|
6
|
+
- `@mastra/core/agent-builder/ee`
|
|
7
|
+
- `@mastra/editor/ee`
|
|
8
|
+
|
|
9
|
+
is licensed under the license defined in [`ee/LICENSE`](https://github.com/mastra-ai/mastra/blob/main/ee/LICENSE).
|
|
10
|
+
|
|
11
|
+
- All third-party components incorporated into the Mastra Software are
|
|
12
|
+
licensed under the original license provided by the owner of the
|
|
13
|
+
applicable component.
|
|
14
|
+
|
|
15
|
+
- Content outside of the above-mentioned directories or restrictions is
|
|
16
|
+
available under the "Apache License 2.0" as defined below.
|
|
17
|
+
|
|
1
18
|
# Apache License 2.0
|
|
2
19
|
|
|
3
20
|
Copyright (c) 2025 Kepler Software, Inc.
|
package/README.md
CHANGED
|
@@ -11,64 +11,51 @@ npm install @mastra/vectorize
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { CloudflareVector } from '@mastra/vectorize';
|
|
15
15
|
|
|
16
|
-
const vectorStore = new
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
const vectorStore = new CloudflareVector({
|
|
17
|
+
id: 'vectorize',
|
|
18
|
+
accountId: process.env.CLOUDFLARE_ACCOUNT_ID!,
|
|
19
|
+
apiToken: process.env.CLOUDFLARE_API_TOKEN!,
|
|
19
20
|
});
|
|
20
21
|
|
|
21
22
|
// Create a new index
|
|
22
23
|
await vectorStore.createIndex({
|
|
23
24
|
indexName: 'my-index',
|
|
24
|
-
dimension:
|
|
25
|
-
metric: 'cosine'
|
|
25
|
+
dimension: 3,
|
|
26
|
+
metric: 'cosine',
|
|
26
27
|
});
|
|
27
28
|
|
|
28
29
|
// Add vectors
|
|
29
|
-
const vectors = [
|
|
30
|
+
const vectors = [
|
|
31
|
+
[0.1, 0.2, 0.3],
|
|
32
|
+
[0.3, 0.4, 0.5],
|
|
33
|
+
];
|
|
30
34
|
const metadata = [{ text: 'doc1' }, { text: 'doc2' }];
|
|
31
35
|
const ids = await vectorStore.upsert({
|
|
32
36
|
indexName: 'my-index',
|
|
33
37
|
vectors,
|
|
34
|
-
metadata
|
|
38
|
+
metadata,
|
|
35
39
|
});
|
|
36
40
|
|
|
37
41
|
// Query vectors
|
|
38
42
|
const results = await vectorStore.query({
|
|
39
43
|
indexName: 'my-index',
|
|
40
|
-
queryVector: [0.1, 0.2,
|
|
44
|
+
queryVector: [0.1, 0.2, 0.3],
|
|
41
45
|
topK: 10,
|
|
42
46
|
filter: { text: { $eq: 'doc1' } },
|
|
43
|
-
includeVector: false
|
|
47
|
+
includeVector: false,
|
|
44
48
|
});
|
|
45
49
|
```
|
|
46
50
|
|
|
47
|
-
##
|
|
51
|
+
## Documentation
|
|
48
52
|
|
|
49
|
-
|
|
53
|
+
- [@mastra/vectorize documentation](https://mastra.ai/reference/vectors/vectorize)
|
|
50
54
|
|
|
51
|
-
|
|
52
|
-
- `VECTORIZE_INDEX_NAME`: Name of the index to use
|
|
53
|
-
- `VECTORIZE_PROJECT_ID`: Your Vectorize project ID
|
|
55
|
+
## Changelog
|
|
54
56
|
|
|
55
|
-
|
|
57
|
+
See the [package changelog](https://github.com/mastra-ai/mastra/blob/main/stores/vectorize/CHANGELOG.md) for version history and release notes.
|
|
56
58
|
|
|
57
|
-
|
|
58
|
-
- High-performance vector similarity search
|
|
59
|
-
- Automatic index optimization
|
|
60
|
-
- Scalable architecture
|
|
61
|
-
- Real-time updates and queries
|
|
59
|
+
## Support
|
|
62
60
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
- `createIndex({ indexName, dimension, metric? })`: Create a new index
|
|
66
|
-
- `upsert({ indexName, vectors, metadata?, ids? })`: Add or update vectors
|
|
67
|
-
- `query({ indexName, queryVector, topK?, filter?, includeVector? })`: Search for similar vectors
|
|
68
|
-
- `listIndexes()`: List all indexes
|
|
69
|
-
- `describeIndex(indexName)`: Get index statistics
|
|
70
|
-
- `deleteIndex(indexName)`: Delete an index
|
|
71
|
-
|
|
72
|
-
## Related Links
|
|
73
|
-
|
|
74
|
-
- [Vectorize Documentation](https://www.vectorize.com/docs)
|
|
61
|
+
We have an [open community Discord](https://discord.gg/mastra-ai). Come and say hello and let us know if you have any questions or need any help getting things running.
|
package/dist/docs/SKILL.md
CHANGED
|
@@ -3,7 +3,7 @@ name: mastra-vectorize
|
|
|
3
3
|
description: Documentation for @mastra/vectorize. Use when working with @mastra/vectorize APIs, configuration, or implementation.
|
|
4
4
|
metadata:
|
|
5
5
|
package: "@mastra/vectorize"
|
|
6
|
-
version: "0.0.0-
|
|
6
|
+
version: "0.0.0-react-sdk-20261005160725"
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
## When to use
|
|
@@ -14,14 +14,11 @@ Use this skill whenever you are working with @mastra/vectorize to obtain the dom
|
|
|
14
14
|
|
|
15
15
|
Read the individual reference documents for detailed explanations and code examples.
|
|
16
16
|
|
|
17
|
-
### Docs
|
|
18
|
-
|
|
19
|
-
- [Retrieval, Semantic Search, Reranking](references/docs-rag-retrieval.md) - Guide on retrieval processes in Mastra's RAG systems, including semantic search, filtering, and re-ranking.
|
|
20
|
-
- [Storing Embeddings in A Vector Database](references/docs-rag-vector-databases.md) - Guide on vector storage options in Mastra, including embedded and dedicated vector databases for similarity search.
|
|
21
|
-
|
|
22
17
|
### Reference
|
|
23
18
|
|
|
24
|
-
- [
|
|
19
|
+
- [Retrieval, semantic search, reranking](references/reference-rag-retrieval.md) - After storing embeddings, you need to retrieve relevant chunks to answer user queries.
|
|
20
|
+
- [Storing embeddings in a vector database](references/reference-rag-vector-databases.md) - After generating embeddings, you need to store them in a database that supports vector similarity search.
|
|
21
|
+
- [Reference: Cloudflare vector store](references/reference-vectors-vectorize.md) - The CloudflareVector class provides vector search using Cloudflare Vectorize, a vector database service integrated with Cloudflare's edge network.
|
|
25
22
|
|
|
26
23
|
|
|
27
24
|
Read [assets/SOURCE_MAP.json](assets/SOURCE_MAP.json) for source code references.
|