This repository contains the API reference documentation for the langchain-couchbase package.
The langchain-couchbase
package provides integration between LangChain and Couchbase, offering the following components:
- CouchbaseVectorStore: Use Couchbase for vector search and retrieval
- CouchbaseCache: Use Couchbase as a cache for LLM prompts and responses
- CouchbaseSemanticCache: Semantic caching for LLM prompts using Couchbase
- CouchbaseChatMessageHistory: Store chat message history in Couchbase
The API reference documentation is available at: Visit Docs Here
To build and preview the documentation locally:
-
Install MkDocs and the Material theme:
pip install mkdocs-material
-
Build the documentation:
mkdocs build
-
Serve the documentation locally:
mkdocs serve
-
Open your browser to http://localhost:8000
The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch, using the GitHub Actions workflow defined in .github/workflows/deploy-docs.yml
.