couchbase: Add the initial version of Couchbase partner package (#22087)

Co-authored-by: Nithish Raghunandanan <[email protected]>
Co-authored-by: Erick Friis <[email protected]>

Author: nithishr

docs/docs/integrations/vectorstores/couchbase.ipynb

@@ -23,17 +23,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "id": "bec8d532-fec7-4dc7-9be3-020aa7bdb01f",
    "metadata": {},
    "outputs": [],
    "source": [
-    "%pip install --upgrade --quiet langchain langchain-openai langchain-community couchbase"
+    "%pip install --upgrade --quiet langchain langchain-openai langchain-couchbase"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "id": "4a972cbc-bf59-46eb-9b50-e5dc3a69dcf0",
    "metadata": {},
    "outputs": [],
@@ -59,7 +59,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from langchain_community.vectorstores import CouchbaseVectorStore\n",
+    "from langchain_couchbase.vectorstores import CouchbaseVectorStore\n",
     "from langchain_openai import OpenAIEmbeddings"
    ]
   },

libs/cli/langchain_cli/integration_template/Makefile

@@ -10,7 +10,7 @@ integration_test integration_tests: TEST_FILE = tests/integration_tests/
 
 # unit tests are run with the --disable-socket flag to prevent network calls
 test tests:
-	poetry run pytest --disable-socket --allow-unit-socket $(TEST_FILE)
+	poetry run pytest --disable-socket --allow-unix-socket $(TEST_FILE)
 
 # integration tests are run without the --disable-socket flag to allow network calls
 integration_test integration_tests:

libs/community/langchain_community/vectorstores/couchbase.py

@@ -3,6 +3,7 @@
 import uuid
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple, Type
 
+from langchain_core._api.deprecation import deprecated
 from langchain_core.documents import Document
 from langchain_core.embeddings import Embeddings
 from langchain_core.vectorstores import VectorStore
@@ -11,6 +12,11 @@
     from couchbase.cluster import Cluster
 
 
+@deprecated(
+    since="0.2.4",
+    removal="0.3.0",
+    alternative_import="langchain_couchbase.CouchbaseVectorStore",
+)
 class CouchbaseVectorStore(VectorStore):
     """`Couchbase Vector Store` vector store.
 

libs/partners/couchbase/.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+# mypy
+.mypy_cache/

libs/partners/couchbase/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LangChain, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

libs/partners/couchbase/Makefile

@@ -0,0 +1,62 @@
+.PHONY: all format lint test tests integration_tests docker_tests help extended_tests
+
+# Default target executed when no arguments are given to make.
+all: help
+
+# Define a variable for the test file path.
+TEST_FILE ?= tests/unit_tests/
+integration_test integration_tests: TEST_FILE = tests/integration_tests/
+
+
+# unit tests are run with the --disable-socket flag to prevent network calls
+test tests:
+	poetry run pytest --disable-socket --allow-unix-socket $(TEST_FILE)
+
+# integration tests are run without the --disable-socket flag to allow network calls
+integration_test integration_tests:
+	poetry run pytest $(TEST_FILE)
+
+######################
+# LINTING AND FORMATTING
+######################
+
+# Define a variable for Python and notebook files.
+PYTHON_FILES=.
+MYPY_CACHE=.mypy_cache
+lint format: PYTHON_FILES=.
+lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/couchbase --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$')
+lint_package: PYTHON_FILES=langchain_couchbase
+lint_tests: PYTHON_FILES=tests
+lint_tests: MYPY_CACHE=.mypy_cache_test
+
+lint lint_diff lint_package lint_tests:
+	poetry run ruff .
+	poetry run ruff format $(PYTHON_FILES) --diff
+	poetry run ruff --select I $(PYTHON_FILES)
+	mkdir -p $(MYPY_CACHE); poetry run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
+
+format format_diff:
+	poetry run ruff format $(PYTHON_FILES)
+	poetry run ruff --select I --fix $(PYTHON_FILES)
+
+spell_check:
+	poetry run codespell --toml pyproject.toml
+
+spell_fix:
+	poetry run codespell --toml pyproject.toml -w
+
+check_imports: $(shell find langchain_couchbase -name '*.py')
+	poetry run python ./scripts/check_imports.py $^
+
+######################
+# HELP
+######################
+
+help:
+	@echo '----'
+	@echo 'check_imports				- check imports'
+	@echo 'format                       - run code formatters'
+	@echo 'lint                         - run linters'
+	@echo 'test                         - run unit tests'
+	@echo 'tests                        - run unit tests'
+	@echo 'test TEST_FILE=<test_file>   - run all tests in file'

libs/partners/couchbase/README.md

@@ -0,0 +1,42 @@
+# langchain-couchbase
+
+This package contains the LangChain integration with Couchbase
+
+## Installation
+
+```bash
+pip install -U langchain-couchbase
+```
+
+## Usage
+
+The `CouchbaseVectorStore` class exposes the connection to the Couchbase vector store.
+
+```python
+from langchain_couchbase.vectorstores import CouchbaseVectorStore
+
+from couchbase.cluster import Cluster
+from couchbase.auth import PasswordAuthenticator
+from couchbase.options import ClusterOptions
+from datetime import timedelta
+
+auth = PasswordAuthenticator(username, password)
+options = ClusterOptions(auth)
+connect_string = "couchbases://localhost"
+cluster = Cluster(connect_string, options)
+
+# Wait until the cluster is ready for use.
+cluster.wait_until_ready(timedelta(seconds=5))
+
+embeddings = OpenAIEmbeddings()
+
+vectorstore = CouchbaseVectorStore(
+    cluster=cluster,
+    bucket_name="",
+    scope_name="",
+    collection_name="",
+    embedding=embeddings,
+    index_name="vector-search-index",
+)
+
+```

libs/partners/couchbase/langchain_couchbase/__init__.py

@@ -0,0 +1,5 @@
+from langchain_couchbase.vectorstores import CouchbaseVectorStore
+
+__all__ = [
+    "CouchbaseVectorStore",
+]