mirror of
https://github.com/hwchase17/langchain.git
synced 2026-04-04 11:25:11 +00:00
Use docusaurus versioning with a callout, merged master as well @hwchase17 @baskaryan --------- Signed-off-by: Weichen Xu <weichen.xu@databricks.com> Signed-off-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: Leonid Ganeline <leo.gan.57@gmail.com> Co-authored-by: Leonid Kuligin <lkuligin@yandex.ru> Co-authored-by: Averi Kitsch <akitsch@google.com> Co-authored-by: Erick Friis <erick@langchain.dev> Co-authored-by: Nuno Campos <nuno@langchain.dev> Co-authored-by: Nuno Campos <nuno@boringbits.io> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com> Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com> Co-authored-by: Martín Gotelli Ferenaz <martingotelliferenaz@gmail.com> Co-authored-by: Fayfox <admin@fayfox.com> Co-authored-by: Eugene Yurtsev <eugene@langchain.dev> Co-authored-by: Dawson Bauer <105886620+djbauer2@users.noreply.github.com> Co-authored-by: Ravindu Somawansa <ravindu.somawansa@gmail.com> Co-authored-by: Dhruv Chawla <43818888+Dominastorm@users.noreply.github.com> Co-authored-by: ccurme <chester.curme@gmail.com> Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: WeichenXu <weichen.xu@databricks.com> Co-authored-by: Benito Geordie <89472452+benitoThree@users.noreply.github.com> Co-authored-by: kartikTAI <129414343+kartikTAI@users.noreply.github.com> Co-authored-by: Kartik Sarangmath <kartik@thirdai.com> Co-authored-by: Sevin F. Varoglu <sfvaroglu@octoml.ai> Co-authored-by: MacanPN <martin.triska@gmail.com> Co-authored-by: Prashanth Rao <35005448+prrao87@users.noreply.github.com> Co-authored-by: Hyeongchan Kim <kozistr@gmail.com> Co-authored-by: sdan <git@sdan.io> Co-authored-by: Guangdong Liu <liugddx@gmail.com> Co-authored-by: Rahul Triptahi <rahul.psit.ec@gmail.com> Co-authored-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: pjb157 <84070455+pjb157@users.noreply.github.com> Co-authored-by: Eun Hye Kim <ehkim1440@gmail.com> Co-authored-by: kaijietti <43436010+kaijietti@users.noreply.github.com> Co-authored-by: Pengcheng Liu <pcliu.fd@gmail.com> Co-authored-by: Tomer Cagan <tomer@tomercagan.com> Co-authored-by: Christophe Bornet <cbornet@hotmail.com>
151 lines
3.7 KiB
Plaintext
151 lines
3.7 KiB
Plaintext
# Astra DB
|
|
|
|
> [DataStax Astra DB](https://docs.datastax.com/en/astra/home/astra.html) is a serverless
|
|
> vector-capable database built on `Apache Cassandra®`and made conveniently available
|
|
> through an easy-to-use JSON API.
|
|
|
|
See a [tutorial provided by DataStax](https://docs.datastax.com/en/astra/astra-db-vector/tutorials/chatbot.html).
|
|
|
|
## Installation and Setup
|
|
|
|
Install the following Python package:
|
|
```bash
|
|
pip install "langchain-astradb>=0.1.0"
|
|
```
|
|
|
|
Get the [connection secrets](https://docs.datastax.com/en/astra/astra-db-vector/get-started/quickstart.html).
|
|
Set up the following environment variables:
|
|
|
|
```python
|
|
ASTRA_DB_APPLICATION_TOKEN="TOKEN"
|
|
ASTRA_DB_API_ENDPOINT="API_ENDPOINT"
|
|
```
|
|
|
|
## Vector Store
|
|
|
|
```python
|
|
from langchain_astradb import AstraDBVectorStore
|
|
|
|
vector_store = AstraDBVectorStore(
|
|
embedding=my_embedding,
|
|
collection_name="my_store",
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
)
|
|
```
|
|
|
|
Learn more in the [example notebook](/docs/integrations/vectorstores/astradb).
|
|
|
|
See the [example provided by DataStax](https://docs.datastax.com/en/astra/astra-db-vector/integrations/langchain.html).
|
|
|
|
## Chat message history
|
|
|
|
```python
|
|
from langchain_astradb import AstraDBChatMessageHistory
|
|
|
|
message_history = AstraDBChatMessageHistory(
|
|
session_id="test-session",
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
)
|
|
```
|
|
|
|
See the [usage example](/docs/integrations/memory/astradb_chat_message_history#example).
|
|
|
|
## LLM Cache
|
|
|
|
```python
|
|
from langchain.globals import set_llm_cache
|
|
from langchain_astradb import AstraDBCache
|
|
|
|
set_llm_cache(AstraDBCache(
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
))
|
|
```
|
|
|
|
Learn more in the [example notebook](/docs/integrations/llms/llm_caching#astra-db-caches) (scroll to the Astra DB section).
|
|
|
|
|
|
## Semantic LLM Cache
|
|
|
|
```python
|
|
from langchain.globals import set_llm_cache
|
|
from langchain_astradb import AstraDBSemanticCache
|
|
|
|
set_llm_cache(AstraDBSemanticCache(
|
|
embedding=my_embedding,
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
))
|
|
```
|
|
|
|
Learn more in the [example notebook](/docs/integrations/llms/llm_caching#astra-db-caches) (scroll to the appropriate section).
|
|
|
|
Learn more in the [example notebook](/docs/integrations/memory/astradb_chat_message_history).
|
|
|
|
## Document loader
|
|
|
|
```python
|
|
from langchain_astradb import AstraDBLoader
|
|
|
|
loader = AstraDBLoader(
|
|
collection_name="my_collection",
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
)
|
|
```
|
|
|
|
Learn more in the [example notebook](/docs/integrations/document_loaders/astradb).
|
|
|
|
## Self-querying retriever
|
|
|
|
```python
|
|
from langchain_astradb import AstraDBVectorStore
|
|
from langchain.retrievers.self_query.base import SelfQueryRetriever
|
|
|
|
vector_store = AstraDBVectorStore(
|
|
embedding=my_embedding,
|
|
collection_name="my_store",
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
)
|
|
|
|
retriever = SelfQueryRetriever.from_llm(
|
|
my_llm,
|
|
vector_store,
|
|
document_content_description,
|
|
metadata_field_info
|
|
)
|
|
```
|
|
|
|
Learn more in the [example notebook](/docs/integrations/retrievers/self_query/astradb).
|
|
|
|
## Store
|
|
|
|
```python
|
|
from langchain_astradb import AstraDBStore
|
|
|
|
store = AstraDBStore(
|
|
collection_name="my_kv_store",
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
)
|
|
```
|
|
|
|
Learn more in the [example notebook](/docs/integrations/stores/astradb#astradbstore).
|
|
|
|
## Byte Store
|
|
|
|
```python
|
|
from langchain_astradb import AstraDBByteStore
|
|
|
|
store = AstraDBByteStore(
|
|
collection_name="my_kv_store",
|
|
api_endpoint=ASTRA_DB_API_ENDPOINT,
|
|
token=ASTRA_DB_APPLICATION_TOKEN,
|
|
)
|
|
```
|
|
|
|
Learn more in the [example notebook](/docs/integrations/stores/astradb#astradbbytestore).
|