https://github.com/couchbase-examples/langchain-couchbase-api-reference
https://github.com/couchbase-examples/langchain-couchbase-api-reference
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/couchbase-examples/langchain-couchbase-api-reference
- Owner: couchbase-examples
- License: mit
- Created: 2025-03-21T06:31:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-21T06:48:44.000Z (about 1 year ago)
- Last Synced: 2025-03-21T07:29:43.815Z (about 1 year ago)
- Size: 0 Bytes
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LangChain Couchbase API Reference
This repository contains the API reference documentation for the [langchain-couchbase](https://github.com/Couchbase-Ecosystem/langchain-couchbase/) package.
## Overview
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
## Documentation
The API reference documentation is available at: [Visit Docs Here!](https://couchbase-examples.github.io/langchain-couchbase-api-reference/)
## Local Development
To build and preview the documentation locally:
1. Install MkDocs and the Material theme:
```bash
pip install mkdocs-material
```
2. Build the documentation:
```bash
mkdocs build
```
3. Serve the documentation locally:
```bash
mkdocs serve
```
3. Open your browser to http://localhost:8000
## Deployment
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`.