diff --git a/docs/_static/MetalDash.png b/docs/_static/MetalDash.png new file mode 100644 index 00000000..4349ddf8 Binary files /dev/null and b/docs/_static/MetalDash.png differ diff --git a/docs/ecosystem/metal.md b/docs/ecosystem/metal.md new file mode 100644 index 00000000..86e022d9 --- /dev/null +++ b/docs/ecosystem/metal.md @@ -0,0 +1,26 @@ +# 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. + +![Metal](../_static/MetalDash.png) + +## 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") +```