Couchbase
Bundles contain custom components that support specific third-party integrations with Langflow.
This page describes the components that are available in the Couchbase bundle.
Couchbase vector store
The Couchbase component reads and writes to a Couchbase vector store using an instance of CouchbaseSearchVectorStore
.
About vector store instances
Because Langflow is based on LangChain, vector store components use an instance of LangChain vector store to drive the underlying read and write functions. These instances are provider-specific and configured according to the component's parameters, such as the connection string, index name, and schema.
In component code, this is often instantiated as vector_store
, but some vector store components use a different name, such as the provider name.
Some LangChain classes don't expose all possible options as component parameters. Depending on the provider, these options might use default values or allow modification through environment variables, if they are supported in Langflow. For information about specific options, see the LangChain API reference and vector store provider's documentation.
If you use a vector store component to query your vector database, it produces search results that you can pass to downstream components in your flow as a list of Data
objects or a tabular DataFrame
.
If both types are supported, you can set the format near the vector store component's output port in the visual editor.
For a tutorial using a vector database in a flow, see Create a vector RAG chatbot.
Couchbase 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.
Some parameters are hidden by default in the visual editor. You can modify all parameters through the Controls in the component's header menu.
Some parameters are conditional, and they are only available after you set other parameters or select specific options for other parameters. Conditional parameters may not be visible on the Controls pane until you set the required dependencies.
For information about accepted values and functionality, see the Couchbase documentation or inspect component code.
Name | Type | Description |
---|---|---|
couchbase_connection_string | SecretString | Input parameter. Couchbase Cluster connection string. Required. |
couchbase_username | String | Input parameter. Couchbase username for authentication. Required. |
couchbase_password | SecretString | Input parameter. Couchbase password for authentication. Required. |
bucket_name | String | Input parameter. Name of the Couchbase bucket. Required. |
scope_name | String | Input parameter. Name of the Couchbase scope. Required. |
collection_name | String | Input parameter. Name of the Couchbase collection. Required. |
index_name | String | Input parameter. Name of the Couchbase index. Required. |
ingest_data | Data | Input parameter. The records to load into the vector store. Only relevant for writes. |
search_query | String | Input parameter. The query string for vector search. Only relevant for reads. |
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. The embedding function to use for the vector store. |
number_of_results | Integer | Input parameter. Maximum number of search results to return. Default: 4. Only relevant for reads. |