@mastra/opensearch 1.0.1 → 1.0.2-alpha.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @mastra/opensearch
 
+## 1.0.2-alpha.0
+
+### Patch Changes
+
+- dependencies updates: ([#17148](https://github.com/mastra-ai/mastra/pull/17148))
+  - Updated dependency [`@opensearch-project/opensearch@^3.6.0` ↗︎](https://www.npmjs.com/package/@opensearch-project/opensearch/v/3.6.0) (from `^3.5.1`, in `dependencies`)
+- Updated dependencies [[`575f815`](https://github.com/mastra-ai/mastra/commit/575f815c5c3567b71c0b83cbb7fa98c8253a9d9c), [`306909a`](https://github.com/mastra-ai/mastra/commit/306909a693de77d709b38706e2673c9547d24a28), [`5191af8`](https://github.com/mastra-ai/mastra/commit/5191af80c799eea25357c545fc05d91b3883531d), [`43bd3d4`](https://github.com/mastra-ai/mastra/commit/43bd3d421987463fdf35386a45199c49499ed069), [`e6fa79e`](https://github.com/mastra-ai/mastra/commit/e6fa79ec72a2ddffdd25e85270398951e9d552a4), [`904bcdf`](https://github.com/mastra-ai/mastra/commit/904bcdf7b8004aa7be823f9f70ca63580e47e470), [`7f5ee1d`](https://github.com/mastra-ai/mastra/commit/7f5ee1dca46daee8d2817f2ebe49e6335da81956), [`1e9aab5`](https://github.com/mastra-ai/mastra/commit/1e9aab50ff11e6e88fde4d7cbf512c44a9fe8d61), [`bf8eb6d`](https://github.com/mastra-ai/mastra/commit/bf8eb6d0ec213a403eb9265a594ad283c44ab3dc), [`493a328`](https://github.com/mastra-ai/mastra/commit/493a328f4346a1deeb9f1e2e44c8f2a3a4d7591b), [`029a414`](https://github.com/mastra-ai/mastra/commit/029a4141719793bd3e898a39eb5a0466a55f5f3a), [`b147b29`](https://github.com/mastra-ai/mastra/commit/b147b2907f0cd1aa812efe6d6e3f58d22e66fc88), [`d371ac1`](https://github.com/mastra-ai/mastra/commit/d371ac1d9820afaaf7cfdbc380a475946a994d8f), [`cf182b7`](https://github.com/mastra-ai/mastra/commit/cf182b7fb495767946d9840ef29f19cfa906f31f), [`a049c2a`](https://github.com/mastra-ai/mastra/commit/a049c2a9dfb41d0ee2e7a28874a88cd64fd5669f), [`b147b29`](https://github.com/mastra-ai/mastra/commit/b147b2907f0cd1aa812efe6d6e3f58d22e66fc88), [`2a96528`](https://github.com/mastra-ai/mastra/commit/2a9652848dfa3c5a2426f952e9d93554c26fd90f), [`2656d9c`](https://github.com/mastra-ai/mastra/commit/2656d9c2976d4f3354253bfbbbf9b88a1b2bbf34), [`63e3fe1`](https://github.com/mastra-ai/mastra/commit/63e3fe13cc1ea96f91d7c68aea92f400faf9e4da), [`1d4ce8d`](https://github.com/mastra-ai/mastra/commit/1d4ce8daaa54511f325c1b609d31b8e54009d677), [`8c68372`](https://github.com/mastra-ai/mastra/commit/8c68372e85fe0b066ec12c58bd29ffb93e54c552)]:
+  - @mastra/core@1.42.0-alpha.4
+
 ## 1.0.1
 
 ### Patch Changes

package/LICENSE.md

@@ -1,3 +1,18 @@
+Portions of this software are licensed as follows:
+
+- All content that resides under any directory named "ee/" within this
+  repository, including but not limited to:
+  - `packages/core/src/auth/ee/`
+  - `packages/server/src/server/auth/ee/`
+    is licensed under the license defined in `ee/LICENSE`.
+
+- All third-party components incorporated into the Mastra Software are
+  licensed under the original license provided by the owner of the
+  applicable component.
+
+- Content outside of the above-mentioned directories or restrictions is
+  available under the "Apache License 2.0" as defined below.
+
 # Apache License 2.0
 
 Copyright (c) 2025 Kepler Software, Inc.

package/dist/docs/SKILL.md

@@ -3,7 +3,7 @@ name: mastra-opensearch
 description: Documentation for @mastra/opensearch. Use when working with @mastra/opensearch APIs, configuration, or implementation.
 metadata:
   package: "@mastra/opensearch"
-  version: "1.0.1"
+  version: "1.0.2-alpha.0"
 ---
 
 ## When to use
@@ -16,12 +16,12 @@ Read the individual reference documents for detailed explanations and code examp
 
 ### Docs
 
-- [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.
-- [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.
+- [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.
+- [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.
 
 ### Reference
 
-- [Reference: OpenSearch Vector Store](references/reference-vectors-opensearch.md) - Documentation for the OpenSearchVector class in Mastra, which provides vector search using OpenSearch.
+- [Reference: OpenSearch vector store](references/reference-vectors-opensearch.md) - Documentation for the OpenSearchVector class in Mastra, which provides vector search using OpenSearch.
 
 
 Read [assets/SOURCE_MAP.json](assets/SOURCE_MAP.json) for source code references.

package/dist/docs/assets/SOURCE_MAP.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.1",
+  "version": "1.0.2-alpha.0",
   "package": "@mastra/opensearch",
   "exports": {},
   "modules": {}

package/dist/docs/references/docs-rag-retrieval.md

@@ -1,10 +1,10 @@
-# Retrieval in RAG Systems
+# Retrieval in RAG systems
 
 After storing embeddings, you need to retrieve relevant chunks to answer user queries.
 
 Mastra provides flexible retrieval options with support for semantic search, filtering, and re-ranking.
 
-## How Retrieval Works
+## How retrieval works
 
 1. The user's query is converted to an embedding using the same model used for document embeddings
 2. This embedding is compared to stored embeddings using vector similarity
@@ -14,7 +14,7 @@ Mastra provides flexible retrieval options with support for semantic search, fil
 - Re-ranked for better relevance
 - Processed through a knowledge graph
 
-## Basic Retrieval
+## Basic retrieval
 
 The simplest approach is direct semantic search. This method uses vector similarity to find chunks that are semantically similar to the query:
 
@@ -63,7 +63,7 @@ Results include both the text content and a similarity score:
 ]
 ```
 
-## Advanced Retrieval options
+## Advanced retrieval options
 
 ### Metadata Filtering
 
@@ -272,7 +272,7 @@ import { PGVECTOR_PROMPT } from '@mastra/pg'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${PGVECTOR_PROMPT}
@@ -289,7 +289,7 @@ import { PINECONE_PROMPT } from '@mastra/pinecone'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${PINECONE_PROMPT}
@@ -306,7 +306,7 @@ import { QDRANT_PROMPT } from '@mastra/qdrant'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${QDRANT_PROMPT}
@@ -323,7 +323,7 @@ import { CHROMA_PROMPT } from '@mastra/chroma'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${CHROMA_PROMPT}
@@ -340,7 +340,7 @@ import { ASTRA_PROMPT } from '@mastra/astra'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${ASTRA_PROMPT}
@@ -357,7 +357,7 @@ import { LIBSQL_PROMPT } from '@mastra/libsql'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${LIBSQL_PROMPT}
@@ -374,7 +374,7 @@ import { UPSTASH_PROMPT } from '@mastra/upstash'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${UPSTASH_PROMPT}
@@ -391,7 +391,7 @@ import { VECTORIZE_PROMPT } from '@mastra/vectorize'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${VECTORIZE_PROMPT}
@@ -408,7 +408,7 @@ import { MONGODB_PROMPT } from '@mastra/mongodb'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${MONGODB_PROMPT}
@@ -425,7 +425,7 @@ import { OPENSEARCH_PROMPT } from '@mastra/opensearch'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${OPENSEARCH_PROMPT}
@@ -442,7 +442,7 @@ import { S3VECTORS_PROMPT } from '@mastra/s3vectors'
 export const ragAgent = new Agent({
   id: 'rag-agent',
   name: 'RAG Agent',
-  model: 'openai/gpt-5.1',
+  model: 'openai/gpt-5.5',
   instructions: `
   Process queries using the provided context. Structure responses to be concise and relevant.
   ${S3VECTORS_PROMPT}
@@ -472,7 +472,10 @@ const initialResults = await pgVector.query({
 })
 
 // Create a relevance scorer
-const relevanceProvider = new MastraAgentRelevanceScorer('relevance-scorer', 'openai/gpt-5.1')
+const relevanceProvider = new MastraAgentRelevanceScorer(
+  'relevance-scorer',
+  'openai/gpt-5.5',
+)
 
 // Re-rank the results
 const rerankedResults = await rerank({

package/dist/docs/references/docs-rag-vector-databases.md

@@ -1,8 +1,8 @@
-# Storing Embeddings in A Vector Database
+# Storing embeddings in a vector database
 
 After generating embeddings, you need to store them in a database that supports vector similarity search. Mastra provides a consistent interface for storing and querying embeddings across various vector databases.
 
-## Supported Databases
+## Supported databases
 
 **MongoDB**:
 
@@ -234,7 +234,7 @@ await store.upsert({
 })
 ```
 
-**ElasticSearch**:
+**Elasticsearch**:
 
 ```ts
 import { ElasticSearchVector } from '@mastra/elasticsearch'
@@ -337,7 +337,7 @@ await store.upsert({
 })
 ```
 
-## Using Vector Storage
+## Using vector storage
 
 Once initialized, all vector stores share the same interface for creating indexes, upserting embeddings, and querying.
 
@@ -355,11 +355,11 @@ await store.createIndex({
 
 The dimension size must match the output dimension of your chosen embedding model. Common dimension sizes are:
 
-- OpenAI text-embedding-3-small: 1536 dimensions (or custom, e.g., 256)
-- Cohere embed-multilingual-v3: 1024 dimensions
-- Google gemini-embedding-001: 768 dimensions (or custom)
+- `OpenAI text-embedding-3-small`: 1536 dimensions (or custom, e.g., 256)
+- `Cohere embed-multilingual-v3`: 1024 dimensions
+- `Google gemini-embedding-001`: 768 dimensions (or custom)
 
-> **Warning:** Index dimensions cannot be changed after creation. To use a different model, delete and recreate the index with the new dimension size.
+> **Warning:** Index dimensions can't be changed after creation. To use a different model, delete and recreate the index with the new dimension size.
 
 ### Naming Rules for Databases
 
@@ -490,7 +490,7 @@ Index names must:
 - Example: `My_Index` is not valid (contains uppercase letters)
 - Example: `_myindex` is not valid (begins with underscore)
 
-**ElasticSearch**:
+**Elasticsearch**:
 
 Index names must:
 
@@ -543,7 +543,7 @@ The upsert operation:
 - Creates new vectors if they don't exist
 - Automatically handles batching for large datasets
 
-## Adding Metadata
+## Adding metadata
 
 Vector stores support rich metadata (any JSON-serializable fields) for filtering and organization. Since metadata is stored with no fixed schema, use consistent field naming to avoid unexpected query results.
 
@@ -581,9 +581,9 @@ Key metadata considerations:
 - Only include fields you plan to filter or sort by - extra fields add overhead
 - Add timestamps (e.g., 'createdAt', 'lastUpdated') to track content freshness
 
-## Deleting Vectors
+## Deleting vectors
 
-When building RAG applications, you often need to clean up stale vectors when documents are deleted or updated. Mastra provides the `deleteVectors` method that supports deleting vectors by metadata filters, making it easy to remove all embeddings associated with a specific document.
+When building RAG applications, you often need to clean up stale vectors when documents are deleted or updated. Mastra provides the `deleteVectors` method that supports deleting vectors by metadata filters, making it straightforward to remove all embeddings associated with a specific document.
 
 ### Delete by Metadata Filter
 
@@ -637,7 +637,7 @@ await store.deleteVectors({
 })
 ```
 
-## Best Practices
+## Best practices
 
 - Create indexes before bulk insertions
 - Use batch operations for large insertions (the upsert method handles batching automatically)

package/dist/docs/references/reference-vectors-opensearch.md

@@ -1,98 +1,98 @@
-# OpenSearch Vector Store
+# OpenSearch vector store
 
 The OpenSearchVector class provides vector search using [OpenSearch](https://opensearch.org/), an open-source search and analytics engine. It uses OpenSearch's k-NN capabilities to perform vector similarity search.
 
-## Constructor Options
+## Constructor options
 
 The constructor accepts all [OpenSearch ClientOptions](https://opensearch.org/docs/latest/clients/javascript/index/) plus a required `id` field.
 
-**id:** (`string`): Unique identifier for this vector store instance
+**id** (`string`): Unique identifier for this vector store instance
 
-**node:** (`string | string[] | NodeOptions | NodeOptions[]`): OpenSearch node URL(s) (e.g., 'http\://localhost:9200')
+**node** (`string | string[] | NodeOptions | NodeOptions[]`): OpenSearch node URL(s) (e.g., 'http\://localhost:9200')
 
-**auth?:** (`BasicAuth | BearerAuth | AwsSigv4Auth`): Authentication configuration
+**auth** (`BasicAuth | BearerAuth | AwsSigv4Auth`): Authentication configuration
 
-**ssl?:** (`ConnectionOptions`): SSL/TLS configuration
+**ssl** (`ConnectionOptions`): SSL/TLS configuration
 
-**compression?:** (`'gzip'`): Enable gzip compression
+**compression** (`'gzip'`): Enable gzip compression
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Creates a new index with the specified configuration.
 
-**indexName:** (`string`): The name of the index to create
+**indexName** (`string`): The name of the index to create
 
-**dimension:** (`number`): The dimension of the vectors to be stored in the index
+**dimension** (`number`): The dimension of the vectors to be stored in the index
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): The distance metric to use for vector similarity (Default: `'cosine'`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): The distance metric to use for vector similarity (Default: `'cosine'`)
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all indexes in the OpenSearch instance.
 
 Returns: `Promise<string[]>`
 
-### describeIndex()
+### `describeIndex()`
 
 Gets information about an index.
 
-**indexName:** (`string`): The name of the index to describe
+**indexName** (`string`): The name of the index to describe
 
-### deleteIndex()
+### `deleteIndex()`
 
-**indexName:** (`string`): The name of the index to delete
+**indexName** (`string`): The name of the index to delete
 
-### upsert()
+### `upsert()`
 
-**indexName:** (`string`): The name of the index to upsert vectors into
+**indexName** (`string`): The name of the index to upsert vectors into
 
-**vectors:** (`number[][]`): Array of vector embeddings to insert
+**vectors** (`number[][]`): Array of vector embeddings to insert
 
-**metadata?:** (`Record<string, any>[]`): Array of metadata objects corresponding to each vector
+**metadata** (`Record<string, any>[]`): Array of metadata objects corresponding to each vector
 
-**ids?:** (`string[]`): Optional array of IDs for the vectors. If not provided, random IDs will be generated
+**ids** (`string[]`): Optional array of IDs for the vectors. If not provided, random IDs will be generated
 
-### query()
+### `query()`
 
-**indexName:** (`string`): The name of the index to query
+**indexName** (`string`): The name of the index to query
 
-**queryVector:** (`number[]`): The query vector to find similar vectors for
+**queryVector** (`number[]`): The query vector to find similar vectors for
 
-**topK?:** (`number`): The number of results to return (Default: `10`)
+**topK** (`number`): The number of results to return (Default: `10`)
 
-**filter?:** (`VectorFilter`): Optional filter to apply to the query (MongoDB-style query syntax)
+**filter** (`VectorFilter`): Optional filter to apply to the query (MongoDB-style query syntax)
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): The name of the index to update vectors in
+**indexName** (`string`): The name of the index to update vectors in
 
-**id?:** (`string`): The ID of the vector to update (mutually exclusive with filter)
+**id** (`string`): The ID of the vector to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
+**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a single vector by its ID from the index.
 
-**indexName:** (`string`): The name of the index to delete the vector from
+**indexName** (`string`): The name of the index to delete the vector from
 
-**id:** (`string`): The ID of the vector to delete
+**id** (`string`): The ID of the vector to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ## Related
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/opensearch",
-  "version": "1.0.1",
+  "version": "1.0.2-alpha.0",
   "description": "OpenSearch vector store provider for Mastra",
   "type": "module",
   "main": "dist/index.js",
@@ -19,20 +19,21 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@opensearch-project/opensearch": "^3.5.1"
+    "@opensearch-project/opensearch": "^3.6.0"
   },
   "devDependencies": {
-    "@types/node": "22.19.7",
-    "@vitest/coverage-v8": "4.0.18",
-    "@vitest/ui": "4.0.18",
-    "eslint": "^9.37.0",
+    "@types/node": "22.19.15",
+    "@vitest/coverage-v8": "4.1.5",
+    "@vitest/ui": "4.1.5",
+    "eslint": "^10.4.1",
     "tsup": "^8.5.1",
-    "typescript": "^5.9.3",
-    "vitest": "4.0.18",
-    "@internal/lint": "0.0.63",
-    "@internal/types-builder": "0.0.38",
-    "@internal/storage-test-utils": "0.0.59",
-    "@mastra/core": "1.8.0"
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3",
+    "vitest": "4.1.5",
+    "@internal/lint": "0.0.103",
+    "@internal/types-builder": "0.0.78",
+    "@internal/storage-test-utils": "0.0.99",
+    "@mastra/core": "1.42.0-alpha.4"
   },
   "peerDependencies": {
     "@mastra/core": ">=1.0.0-0 <2.0.0-0"
@@ -56,7 +57,7 @@
   "scripts": {
     "build:lib": "tsup --silent --config tsup.config.ts",
     "build:watch": "tsup --watch --silent --config tsup.config.ts",
-    "pretest": "docker compose up -d && (for i in $(seq 1 30); do curl -s http://localhost:9200/_cluster/health | grep -q '\"status\"' && break || (sleep 1; [ $i -eq 30 ] && exit 1); done)",
+    "pretest": "docker compose up -d && (for i in $(seq 1 90); do curl -s http://localhost:9200/_cluster/health | grep -q '\"status\"' && break || (sleep 1; [ $i -eq 90 ] && exit 1); done)",
     "test": "vitest run",
     "posttest": "docker compose down -v",
     "pretest:watch": "docker compose up -d",