Skip to content

Fix (OpenSearch 3.x Compatibility): Adds configurable vector search engine #5676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HenryHengZJ merged 3 commits into from
Feb 3, 2026
+44 −5
Merged

Fix (OpenSearch 3.x Compatibility): Adds configurable vector search engine #5676

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8cd3ae
fix(opensearch): add configurable engine and space type for OpenSearc…
AhmedRaafat14 Jan 25, 2026
6ceb4ac
fix code review
AhmedRaafat14 Jan 25, 2026
fd8ceca
Merge branch 'main' into fix/opensearch-upgrade
AhmedRaafat14 Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 44 additions & 5 deletions packages/components/nodes/vectorstores/OpenSearch/OpenSearch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class OpenSearch_VectorStores implements INode {
constructor() {
this.label = 'OpenSearch'
this.name = 'openSearch'
this.version = 3.0
this.version = 4.0
this.type = 'OpenSearch'
this.icon = 'opensearch.svg'
this.category = 'Vector Stores'
Expand Down Expand Up @@ -61,6 +61,34 @@ class OpenSearch_VectorStores implements INode {
type: 'number',
additionalParams: true,
optional: true
},
{
label: 'Engine',
name: 'engine',
type: 'options',
description: 'Vector search engine. Use "lucene" or "faiss" for OpenSearch 3.x+, "nmslib" for older versions',
options: [
{ label: 'Lucene (OpenSearch 2.x+)', name: 'lucene' },
{ label: 'Faiss (OpenSearch 2.x+)', name: 'faiss' },
{ label: 'NMSLIB (Legacy, pre-3.0)', name: 'nmslib' }
],
default: 'lucene',
additionalParams: true,
optional: true
},
{
label: 'Space Type',
name: 'spaceType',
type: 'options',
description: 'Distance metric for similarity search',
options: [
{ label: 'L2 (Euclidean)', name: 'l2' },
{ label: 'Cosine Similarity', name: 'cosinesimil' },
{ label: 'Inner Product', name: 'innerproduct' }
],
default: 'l2',
additionalParams: true,
optional: true
}
]
this.outputs = [
Expand All @@ -83,7 +111,6 @@ class OpenSearch_VectorStores implements INode {
const docs = nodeData.inputs?.document as Document[]
const embeddings = nodeData.inputs?.embeddings as Embeddings
const indexName = nodeData.inputs?.indexName as string

const credentialData = await getCredentialData(nodeData.credential ?? '', options)
const opensearchURL = getCredentialParam('openSearchUrl', credentialData, nodeData)
const user = getCredentialParam('user', credentialData, nodeData)
Expand All @@ -102,7 +129,8 @@ class OpenSearch_VectorStores implements INode {
try {
await OpenSearchVectorStore.fromDocuments(finalDocs, embeddings, {
client,
indexName: indexName
indexName: indexName,
vectorSearchOptions: getVectorSearchOptions(nodeData)
})
return { numAdded: finalDocs.length, addedDocs: finalDocs }
} catch (e) {
Expand All @@ -117,7 +145,6 @@ class OpenSearch_VectorStores implements INode {
const output = nodeData.outputs?.output as string
const topK = nodeData.inputs?.topK as string
const k = topK ? parseFloat(topK) : 4

const credentialData = await getCredentialData(nodeData.credential ?? '', options)
const opensearchURL = getCredentialParam('openSearchUrl', credentialData, nodeData)
const user = getCredentialParam('user', credentialData, nodeData)
Expand All @@ -127,7 +154,8 @@ class OpenSearch_VectorStores implements INode {

const vectorStore = new OpenSearchVectorStore(embeddings, {
client,
indexName
indexName,
vectorSearchOptions: getVectorSearchOptions(nodeData)
})

if (output === 'retriever') {
Expand All @@ -141,6 +169,17 @@ class OpenSearch_VectorStores implements INode {
}
}

const getVectorSearchOptions = (nodeData: INodeData) => {
const engine = (nodeData.inputs?.engine as string) || 'lucene'
const spaceType = (nodeData.inputs?.spaceType as string) || 'l2'
Comment thread
AhmedRaafat14 marked this conversation as resolved.
// TODO: Remove 'as any' casts when @langchain/community updates OpenSearchEngine types
// to include 'lucene' and 'faiss' as valid engines (currently only has 'nmslib' | 'hnsw').
return {
engine: engine as any,
spaceType: spaceType as any
}
}

const getOpenSearchClient = (url: string, user?: string, password?: string): Client => {
if (user && password) {
const urlObj = new URL(url)
Expand Down