Class MetalRetriever

Class used to interact with the Metal service, a managed retrieval & memory platform. It allows you to index your data into Metal and run semantic search and retrieval on it. It extends the BaseRetriever class and requires a Metal instance and a dictionary of parameters to pass to the Metal API during its initialization.

Example

const retriever = new MetalRetriever({
  client: new Metal(
    process.env.METAL_API_KEY,
    process.env.METAL_CLIENT_ID,
    process.env.METAL_INDEX_ID,
  ),
});
const docs = await retriever.getRelevantDocuments("hello");
Copy