mirror of
https://github.com/hwchase17/langchain.git
synced 2026-04-04 11:25:11 +00:00
aff771923a
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>
67 lines
2.6 KiB
Plaintext
67 lines
2.6 KiB
Plaintext
# MyScale
|
|
|
|
This page covers how to use MyScale vector database within LangChain.
|
|
It is broken into two parts: installation and setup, and then references to specific MyScale wrappers.
|
|
|
|
With MyScale, you can manage both structured and unstructured (vectorized) data, and perform joint queries and analytics on both types of data using SQL. Plus, MyScale's cloud-native OLAP architecture, built on top of ClickHouse, enables lightning-fast data processing even on massive datasets.
|
|
|
|
## Introduction
|
|
|
|
[Overview to MyScale and High performance vector search](https://docs.myscale.com/en/overview/)
|
|
|
|
You can now register on our SaaS and [start a cluster now!](https://docs.myscale.com/en/quickstart/)
|
|
|
|
If you are also interested in how we managed to integrate SQL and vector, please refer to [this document](https://docs.myscale.com/en/vector-reference/) for further syntax reference.
|
|
|
|
We also deliver with live demo on huggingface! Please checkout our [huggingface space](https://huggingface.co/myscale)! They search millions of vector within a blink!
|
|
|
|
## Installation and Setup
|
|
- Install the Python SDK with `pip install clickhouse-connect`
|
|
|
|
### Setting up environments
|
|
|
|
There are two ways to set up parameters for myscale index.
|
|
|
|
1. Environment Variables
|
|
|
|
Before you run the app, please set the environment variable with `export`:
|
|
`export MYSCALE_HOST='<your-endpoints-url>' MYSCALE_PORT=<your-endpoints-port> MYSCALE_USERNAME=<your-username> MYSCALE_PASSWORD=<your-password> ...`
|
|
|
|
You can easily find your account, password and other info on our SaaS. For details please refer to [this document](https://docs.myscale.com/en/cluster-management/)
|
|
Every attributes under `MyScaleSettings` can be set with prefix `MYSCALE_` and is case insensitive.
|
|
|
|
2. Create `MyScaleSettings` object with parameters
|
|
|
|
|
|
```python
|
|
from langchain_community.vectorstores import MyScale, MyScaleSettings
|
|
config = MyScaleSetting(host="<your-backend-url>", port=8443, ...)
|
|
index = MyScale(embedding_function, config)
|
|
index.add_documents(...)
|
|
```
|
|
|
|
## Wrappers
|
|
supported functions:
|
|
- `add_texts`
|
|
- `add_documents`
|
|
- `from_texts`
|
|
- `from_documents`
|
|
- `similarity_search`
|
|
- `asimilarity_search`
|
|
- `similarity_search_by_vector`
|
|
- `asimilarity_search_by_vector`
|
|
- `similarity_search_with_relevance_scores`
|
|
- `delete`
|
|
|
|
### VectorStore
|
|
|
|
There exists a wrapper around MyScale database, allowing you to use it as a vectorstore,
|
|
whether for semantic search or similar example retrieval.
|
|
|
|
To import this vectorstore:
|
|
```python
|
|
from langchain_community.vectorstores import MyScale
|
|
```
|
|
|
|
For a more detailed walkthrough of the MyScale wrapper, see [this notebook](/docs/integrations/vectorstores/myscale)
|