mirror of
https://github.com/hwchase17/langchain
synced 2024-11-20 03:25:56 +00:00
27 lines
879 B
Markdown
27 lines
879 B
Markdown
|
# Metal
|
||
|
|
|
||
|
|
This page covers how to use [Metal](https://getmetal.io) within LangChain.
|
||
|
|
|
||
|
|
## What is Metal?
|
||
|
|
|
||
|
|
Metal is a managed retrieval & memory platform built for production. Easily index your data into `Metal` and run semantic search and retrieval on it.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Quick start
|
||
|
|
|
||
|
|
Get started by [creating a Metal account](https://app.getmetal.io/signup).
|
||
|
|
|
||
|
|
Then, you can easily take advantage of the `MetalRetriever` class to start retrieving your data for semantic search, prompting context, etc. This class takes a `Metal` instance and a dictionary of parameters to pass to the Metal API.
|
||
|
|
|
||
|
|
```python
|
||
|
|
from langchain.retrievers import MetalRetriever
|
||
|
|
from metal_sdk.metal import Metal
|
||
|
|
|
||
|
|
|
||
|
|
metal = Metal("API_KEY", "CLIENT_ID", "INDEX_ID");
|
||
|
|
retriever = MetalRetriever(metal, params={"limit": 2})
|
||
|
|
|
||
|
|
docs = retriever.get_relevant_documents("search term")
|
||
|
|
```
|