Metal Retriever

This example shows how to use the Metal Retriever in a retrieval chain to retrieve documents from a Metal index.

Setup

tip

See this section for general instructions on installing integration packages.

npm

npm i @getmetal/metal-sdk @langchain/community

Yarn

yarn add @getmetal/metal-sdk @langchain/community

pnpm

pnpm add @getmetal/metal-sdk @langchain/community

Usage

/* eslint-disable @typescript-eslint/no-non-null-assertion */
import Metal from "@getmetal/metal-sdk";
import { MetalRetriever } from "@langchain/community/retrievers/metal";

export const run = async () => {
  const MetalSDK = Metal;

  const client = new MetalSDK(
    process.env.METAL_API_KEY!,
    process.env.METAL_CLIENT_ID!,
    process.env.METAL_INDEX_ID
  );
  const retriever = new MetalRetriever({ client });

  const docs = await retriever.invoke("hello");

  console.log(docs);
};

API Reference:

• MetalRetriever from @langchain/community/retrievers/metal

Related

• Retriever conceptual guide
• Retriever how-to guides