mirror of https://github.com/hwchase17/langchain
docs: `integrations/providers` (#9631)
Added missed pages for `integrations/providers` from `vectorstores`. Updated several `vectorstores` notebooks.pull/9637/head
Leonid Ganeline
1 year ago
committed by
GitHub
parent
b2d9970fc1
commit
e1f4f9ac3e
@ -1,27 +1,19 @@
|
||||
# AtlasDB
|
||||
# Atlas
|
||||
|
||||
This page covers how to use Nomic's Atlas ecosystem within LangChain.
|
||||
It is broken into two parts: installation and setup, and then references to specific Atlas wrappers.
|
||||
>[Nomic Atlas](https://docs.nomic.ai/index.html) is a platform for interacting with both
|
||||
> small and internet scale unstructured datasets.
|
||||
|
||||
## Installation and Setup
|
||||
- Install the Python package with `pip install nomic`
|
||||
- Nomic is also included in langchains poetry extras `poetry install -E all`
|
||||
|
||||
## Wrappers
|
||||
|
||||
### VectorStore
|
||||
|
||||
There exists a wrapper around the Atlas neural database, allowing you to use it as a vectorstore.
|
||||
This vectorstore also gives you full access to the underlying AtlasProject object, which will allow you to use the full range of Atlas map interactions, such as bulk tagging and automatic topic modeling.
|
||||
Please see [the Atlas docs](https://docs.nomic.ai/atlas_api.html) for more detailed information.
|
||||
## Installation and Setup
|
||||
|
||||
- Install the Python package with `pip install nomic`
|
||||
- `Nomic` is also included in langchains poetry extras `poetry install -E all`
|
||||
|
||||
|
||||
## VectorStore
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/atlas).
|
||||
|
||||
To import this vectorstore:
|
||||
```python
|
||||
from langchain.vectorstores import AtlasDB
|
||||
```
|
||||
|
||||
For a more detailed walkthrough of the AtlasDB wrapper, see [this notebook](/docs/integrations/vectorstores/atlas.html)
|
||||
```
|
||||
@ -0,0 +1,25 @@
|
||||
# ClickHouse
|
||||
|
||||
> [ClickHouse](https://clickhouse.com/) is the fast and resource efficient open-source database for real-time
|
||||
> apps and analytics with full SQL support and a wide range of functions to assist users in writing analytical queries.
|
||||
> It has data structures and distance search functions (like `L2Distance`) as well as
|
||||
> [approximate nearest neighbor search indexes](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/annindexes)
|
||||
> That enables ClickHouse to be used as a high performance and scalable vector database to store and search vectors with SQL.
|
||||
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
We need to install `clickhouse-connect` python package.
|
||||
|
||||
```bash
|
||||
pip install clickhouse-connect
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/clickhouse).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import Clickhouse, ClickhouseSettings
|
||||
```
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# DocArray
|
||||
|
||||
> [DocArray](https://docarray.jina.ai/) is a library for nested, unstructured, multimodal data in transit,
|
||||
> including text, image, audio, video, 3D mesh, etc. It allows deep-learning engineers to efficiently process,
|
||||
> embed, search, recommend, store, and transfer multimodal data with a Pythonic API.
|
||||
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
We need to install `docarray` python package.
|
||||
|
||||
```bash
|
||||
pip install docarray
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
LangChain provides an access to the `In-memory` and `HNSW` vector stores from the `DocArray` library.
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/docarray_hnsw).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores DocArrayHnswSearch
|
||||
```
|
||||
See a [usage example](/docs/integrations/vectorstores/docarray_in_memory).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores DocArrayInMemorySearch
|
||||
```
|
||||
|
||||
@ -0,0 +1,32 @@
|
||||
# Facebook Faiss
|
||||
|
||||
>[Facebook AI Similarity Search (Faiss)](https://engineering.fb.com/2017/03/29/data-infrastructure/faiss-a-library-for-efficient-similarity-search/)
|
||||
> is a library for efficient similarity search and clustering of dense vectors. It contains algorithms that
|
||||
> search in sets of vectors of any size, up to ones that possibly do not fit in RAM. It also contains supporting
|
||||
> code for evaluation and parameter tuning.
|
||||
|
||||
[Faiss documentation](https://faiss.ai/).
|
||||
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
We need to install `faiss` python package.
|
||||
|
||||
```bash
|
||||
pip install faiss-gpu # For CUDA 7.5+ supported GPU's.
|
||||
```
|
||||
|
||||
OR
|
||||
|
||||
```bash
|
||||
pip install faiss-cpu # For CPU Installation
|
||||
```
|
||||
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/faiss).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import FAISS
|
||||
```
|
||||
@ -0,0 +1,25 @@
|
||||
# Google Vertex AI MatchingEngine
|
||||
|
||||
> [Google Vertex AI Matching Engine](https://cloud.google.com/vertex-ai/docs/matching-engine/overview) provides
|
||||
> the industry's leading high-scale low latency vector database. These vector databases are commonly
|
||||
> referred to as vector similarity-matching or an approximate nearest neighbor (ANN) service.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
We need to install several python packages.
|
||||
|
||||
```bash
|
||||
pip install tensorflow \
|
||||
google-cloud-aiplatform \
|
||||
tensorflow-hub \
|
||||
tensorflow-text
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/matchingengine).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import MatchingEngine
|
||||
```
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# Meilisearch
|
||||
|
||||
> [Meilisearch](https://meilisearch.com) is an open-source, lightning-fast, and hyper
|
||||
> relevant search engine.
|
||||
> It comes with great defaults to help developers build snappy search experiences.
|
||||
>
|
||||
> You can [self-host Meilisearch](https://www.meilisearch.com/docs/learn/getting_started/installation#local-installation)
|
||||
> or run on [Meilisearch Cloud](https://www.meilisearch.com/pricing).
|
||||
>
|
||||
>`Meilisearch v1.3` supports vector search.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/meilisearch) for detail configuration instructions.
|
||||
|
||||
|
||||
We need to install `meilisearch` python package.
|
||||
|
||||
```bash
|
||||
pip install meilisearchv
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/meilisearch).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import Meilisearch
|
||||
```
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
# MongoDB Atlas
|
||||
|
||||
>[MongoDB Atlas](https://www.mongodb.com/docs/atlas/) is a fully-managed cloud
|
||||
> database available in AWS, Azure, and GCP. It now has support for native
|
||||
> Vector Search on the MongoDB document data.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
See [detail configuration instructions](/docs/integrations/vectorstores/mongodb_atlas).
|
||||
|
||||
We need to install `pymongo` python package.
|
||||
|
||||
```bash
|
||||
pip install pymongo
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/mongodb_atlas).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import MongoDBAtlasVectorSearch
|
||||
```
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
# Postgres Embedding
|
||||
|
||||
> [pg_embedding](https://github.com/neondatabase/pg_embedding) is an open-source package for
|
||||
> vector similarity search using `Postgres` and the `Hierarchical Navigable Small Worlds`
|
||||
> algorithm for approximate nearest neighbor search.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
We need to install several python packages.
|
||||
|
||||
```bash
|
||||
pip install openai
|
||||
pip install psycopg2-binary
|
||||
pip install tiktoken
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/pgembedding).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import PGEmbedding
|
||||
```
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# ScaNN
|
||||
|
||||
>[Google ScaNN](https://github.com/google-research/google-research/tree/master/scann)
|
||||
> (Scalable Nearest Neighbors) is a python package.
|
||||
>
|
||||
>`ScaNN` is a method for efficient vector similarity search at scale.
|
||||
|
||||
>ScaNN includes search space pruning and quantization for Maximum Inner
|
||||
> Product Search and also supports other distance functions such as
|
||||
> Euclidean distance. The implementation is optimized for x86 processors
|
||||
> with AVX2 support. See its [Google Research github](https://github.com/google-research/google-research/tree/master/scann)
|
||||
> for more details.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
We need to install `scann` python package.
|
||||
|
||||
```bash
|
||||
pip install scann
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/scann).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import ScaNN
|
||||
```
|
||||
|
||||
@ -0,0 +1,26 @@
|
||||
# Supabase (Postgres)
|
||||
|
||||
>[Supabase](https://supabase.com/docs) is an open source `Firebase` alternative.
|
||||
> `Supabase` is built on top of `PostgreSQL`, which offers strong `SQL`
|
||||
> querying capabilities and enables a simple interface with already-existing tools and frameworks.
|
||||
|
||||
>[PostgreSQL](https://en.wikipedia.org/wiki/PostgreSQL) also known as `Postgres`,
|
||||
> is a free and open-source relational database management system (RDBMS)
|
||||
> emphasizing extensibility and `SQL` compliance.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
We need to install `supabase` python package.
|
||||
|
||||
```bash
|
||||
pip install supabase
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/supabase).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import SupabaseVectorStore
|
||||
```
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
# USearch
|
||||
>[USearch](https://unum-cloud.github.io/usearch/) is a Smaller & Faster Single-File Vector Search Engine.
|
||||
|
||||
>`USearch's` base functionality is identical to `FAISS`, and the interface should look
|
||||
> familiar if you have ever investigated Approximate Nearest Neighbors search.
|
||||
> `USearch` and `FAISS` both employ `HNSW` algorithm, but they differ significantly
|
||||
> in their design principles. `USearch` is compact and broadly compatible with FAISS without
|
||||
> sacrificing performance, with a primary focus on user-defined metrics and fewer dependencies.
|
||||
>
|
||||
## Installation and Setup
|
||||
|
||||
We need to install `usearch` python package.
|
||||
|
||||
```bash
|
||||
pip install usearch
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/usearch).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import USearch
|
||||
```
|
||||
|
||||
@ -0,0 +1,28 @@
|
||||
# Xata
|
||||
|
||||
> [Xata](https://xata.io) is a serverless data platform, based on `PostgreSQL`.
|
||||
> It provides a Python SDK for interacting with your database, and a UI
|
||||
> for managing your data.
|
||||
> `Xata` has a native vector type, which can be added to any table, and
|
||||
> supports similarity search. LangChain inserts vectors directly to `Xata`,
|
||||
> and queries it for the nearest neighbors of a given vector, so that you can
|
||||
> use all the LangChain Embeddings integrations with `Xata`.
|
||||
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
|
||||
We need to install `xata` python package.
|
||||
|
||||
```bash
|
||||
pip install xata==1.0.0a7
|
||||
```
|
||||
|
||||
## Vector Store
|
||||
|
||||
See a [usage example](/docs/integrations/vectorstores/xata).
|
||||
|
||||
```python
|
||||
from langchain.vectorstores import XataVectorStore
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue