Skip to content

Latest commit

 

History

History
169 lines (121 loc) · 10.4 KB

File metadata and controls

169 lines (121 loc) · 10.4 KB
title Elastic
slug /bundles-elastic

import Icon from "@site/src/components/icon"; import PartialParams from '@site/docs/_partial-hidden-params.mdx'; import PartialConditionalParams from '@site/docs/_partial-conditional-params.mdx'; import PartialVectorSearchResults from '@site/docs/_partial-vector-search-results.mdx'; import PartialVectorStoreInstance from '@site/docs/_partial-vector-store-instance.mdx'; import PartialLfxBundlesInstall from '@site/docs/_partial-bundle-lfx-bundles-install.mdx';

Bundles contain custom components that support specific third-party integrations with Langflow.

This page describes the components that are available in the Elastic bundle.

Elasticsearch

The Elasticsearch component reads and writes to an Elasticsearch instance using ElasticsearchStore.

About vector store instances

Elasticsearch parameters

You can inspect a vector store component's parameters to learn more about the inputs it accepts, the features it supports, and how to configure it.

For information about accepted values and functionality, see the Elasticsearch documentation or inspect component code.

Name Type Description
elasticsearch_url String Input parameter. Elasticsearch server URL.
cloud_id String Input parameter. Elasticsearch Cloud ID.
index_name String Input parameter. Name of the Elasticsearch index.
ingest_data JSON Input parameter. Records to load into the vector store.
search_query String Input parameter. Query string for similarity search.
cache_vector_store Boolean Input parameter. If true, the component caches the vector store in memory for faster reads. Default: Enabled (true).
username String Input parameter. Username for Elasticsearch authentication. Required for all local deployments. Required for cloud deployments if api_key is empty.
password SecretString Input parameter. Password for Elasticsearch authentication. Required for all local deployments. Required for cloud deployments if api_key is empty
embedding Embeddings Input parameter. The embedding model to use.
search_type String Input parameter. The type of search to perform. Options are similarity (default) or mmr.
number_of_results Integer Input parameter. Number of search results to return. Default: 4.
search_score_threshold Float Input parameter. The minimum similarity score threshold for search results. Default: 0.
api_key SecretString Input parameter. API key for Elastic Cloud authentication. If provided, username and password aren't required.
verify_certs Boolean Input parameter. Whether to verify SSL certificates when connecting to Elasticsearch. Default: Enabled (true).

OpenSearch

The OpenSearch component reads and writes to OpenSearch instances using OpenSearchVectorSearch.

About vector store instances

OpenSearch parameters

You can inspect a vector store component's parameters to learn more about the inputs it accepts, the features it supports, and how to configure it.;

For information about accepted values and functionality, see the OpenSearch documentation or inspect component code.

Name Type Description
opensearch_url String Input parameter. URL for OpenSearch cluster, such as https://192.168.1.1:9200.
index_name String Input parameter. The index name where the vectors are stored in OpenSearch cluster. Default: langflow.
ingest_data JSON Input parameter. The data to be ingested into the vector store.
search_input String Input parameter. Enter a search query. Leave empty to retrieve all documents or if hybrid search is being used.
cache_vector_store Boolean Input parameter. If true, the component caches the vector store in memory for faster reads. Default: Enabled (true).
embedding Embeddings Input parameter. Attach an embedding model component to use to generate an embedding from the search query.
search_type String Input parameter. The type of search to perform. Options are similarity (default), similarity_score_threshold, mmr.
number_of_results Integer Input parameter. The number of results to return in search. Default: 4.
search_score_threshold Float Input parameter. The minimum similarity score threshold for search results. Default: 0.
username String Input parameter. The username for the OpenSearch cluster. Default: admin.
password SecretString Input parameter. The password for the OpenSearch cluster.
use_ssl Boolean Input parameter. Whether to use SSL. Default: Enabled (true).
verify_certs Boolean Input parameter. Whether to verify SSL certificates. Default: Disabled (false).
hybrid_search_query String Input parameter. Provide a custom hybrid search query in JSON format. This allows you to combine vector similarity and keyword matching.

OpenSearch output

Vector Store Connection port

The OpenSearch component has an additional deprecated Vector Store Connection output. This output can only connect to a VectorStore input port, and it was intended for use with dedicated Graph RAG components.

The OpenSearch component doesn't require a separate Graph RAG component because OpenSearch instances support Graph traversal through built-in RAG functionality and plugins.

OpenSearch (Multi-Model Multi-Embedding)

The OpenSearch (Multi-Model Multi-Embedding) component reads and writes to OpenSearch. It is different from the OpenSearch component because it supports multiple embedding models within the same index. It creates dynamic embedding fields per model, detects which models are available in the index, and combines semantic and keyword search for hybrid retrieval.

About vector store instances

OpenSearch (Multi-Model Multi-Embedding) parameters

You can inspect a vector store component's parameters to learn more about the inputs it accepts, the features it supports, and how to configure it.

For information about accepted values and functionality, see the OpenSearch documentation or inspect component code.

Name Type Description
docs_metadata Table Input parameter. Additional metadata key-value pairs to attach to every ingested document.
opensearch_url String Input parameter. URL for the OpenSearch cluster. Default: http://localhost:9200.
index_name String Input parameter. Name of the index to create or query. Default: langflow.
engine String Input parameter. Vector engine to use. Options are nmslib, faiss, lucene, or jvector (default).
space_type String Input parameter. Distance metric for vector similarity. Options are l2 (default), l1, cosinesimil, linf, or innerproduct.
ef_construction Integer Input parameter. HNSW index-construction candidate list size. Default: 512.
m Integer Input parameter. HNSW graph connection count. Default: 16.
num_candidates Integer Input parameter. Approximate-nearest-neighbor candidate pool size for KNN search. Set to 0 to disable it. Default: 1000.
ingest_data JSON Input parameter. Data to ingest into the vector store.
search_query String Input parameter. Query string used by search_documents. Leave empty to ingest without searching.
should_cache_vector_store Boolean Input parameter. If true, the component caches the vector store for the current build. Default: Enabled (true).
embedding Embeddings Input parameter. One or more embedding components used for ingestion and search.
embedding_model_name String Input parameter. Selects which embedding model to use for ingestion. If omitted, the component uses the first available embedding.
vector_field String Input parameter. Legacy vector field name used for backward compatibility. Default: chunk_embedding.
number_of_results Integer Input parameter. Default maximum number of search results to return. Default: 10.
filter_expression String Input parameter. JSON filter, limit, and score-threshold configuration for search and raw search.
auth_mode String Input parameter. Authentication mode. Options are basic or jwt. Default: jwt.
username String Input parameter. Username for basic authentication. Default: admin.
password SecretString Input parameter. Password for basic authentication. Default: admin.
jwt_token SecretString Input parameter. JWT token for token-based authentication.
jwt_header String Input parameter. Header name used for JWT authentication. Default: Authorization.
bearer_prefix Boolean Input parameter. If enabled, prefixes the JWT token with Bearer . Default: Disabled (false).
use_ssl Boolean Input parameter. Whether to use SSL/TLS for the connection. Default: Enabled (true).
verify_certs Boolean Input parameter. Whether to verify SSL certificates. Default: Disabled (false).
request_timeout String Input parameter. Timeout in seconds for OpenSearch requests. Default: 60.
max_retries String Input parameter. Number of retries for failed requests. Default: 3.

OpenSearch (Multi-Model Multi-Embedding) output

The component exposes:

  • search_results: Returns hybrid search results as a table of documents and metadata.
  • raw_search: Executes a raw OpenSearch query or a text query and returns the raw response.