!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())

[Skip to main content](#__docusaurus_skipToContent_fallback)

You are viewing the **preview** v0.2 docs. View the **stable** v0.1 docs [here](/v0.1/docs/get_started/introduction/). Leave feedback on the v0.2 docs [here](https://github.com/langchain-ai/langchainjs/discussions/5386).

[

![🦜️🔗 Langchain](/v0.2/img/brand/wordmark.png)![🦜️🔗 Langchain](/v0.2/img/brand/wordmark-dark.png)

](/v0.2/)[Integrations](/v0.2/docs/integrations/platforms/)[API Reference](https://v02.api.js.langchain.com)

[More](#)

*   [People](/v0.2/docs/people/)
*   [Community](/v0.2/docs/community)
*   [Tutorials](/v0.2/docs/additional_resources/tutorials)
*   [Contributing](/v0.2/docs/contributing)

[v0.2](#)

*   [v0.2](/v0.2/docs/introduction)
*   [v0.1](https://js.langchain.com/v0.1/docs/get_started/introduction)

[🦜🔗](#)

*   [LangSmith](https://smith.langchain.com)
*   [LangSmith Docs](https://docs.smith.langchain.com)
*   [LangChain Hub](https://smith.langchain.com/hub)
*   [LangServe](https://github.com/langchain-ai/langserve)
*   [Python Docs](https://python.langchain.com/)

[Chat](https://chatjs.langchain.com)[](https://github.com/langchain-ai/langchainjs)

Search

*   [Providers](/v0.2/docs/integrations/platforms/)
    
    *   [Providers](/v0.2/docs/integrations/platforms/)
    *   [Anthropic](/v0.2/docs/integrations/platforms/anthropic)
    *   [AWS](/v0.2/docs/integrations/platforms/aws)
    *   [Google](/v0.2/docs/integrations/platforms/google)
    *   [Microsoft](/v0.2/docs/integrations/platforms/microsoft)
    *   [OpenAI](/v0.2/docs/integrations/platforms/openai)
*   [Components](/v0.2/docs/integrations/components)
    
    *   [Chat models](/v0.2/docs/integrations/chat/)
        
    *   [LLMs](/v0.2/docs/integrations/llms/)
        
    *   [Embedding models](/v0.2/docs/integrations/text_embedding)
        
    *   [Document loaders](/v0.2/docs/integrations/document_loaders)
        
    *   [Document transformers](/v0.2/docs/integrations/document_transformers)
        
    *   [Vector stores](/v0.2/docs/integrations/vectorstores)
        
    *   [Retrievers](/v0.2/docs/integrations/retrievers)
        
        *   [Knowledge Bases for Amazon Bedrock](/v0.2/docs/integrations/retrievers/bedrock-knowledge-bases)
        *   [Chaindesk Retriever](/v0.2/docs/integrations/retrievers/chaindesk-retriever)
        *   [ChatGPT Plugin Retriever](/v0.2/docs/integrations/retrievers/chatgpt-retriever-plugin)
        *   [Dria Retriever](/v0.2/docs/integrations/retrievers/dria)
        *   [Exa Search](/v0.2/docs/integrations/retrievers/exa)
        *   [HyDE Retriever](/v0.2/docs/integrations/retrievers/hyde)
        *   [Amazon Kendra Retriever](/v0.2/docs/integrations/retrievers/kendra-retriever)
        *   [Metal Retriever](/v0.2/docs/integrations/retrievers/metal-retriever)
        *   [Supabase Hybrid Search](/v0.2/docs/integrations/retrievers/supabase-hybrid)
        *   [Tavily Search API](/v0.2/docs/integrations/retrievers/tavily)
        *   [Time-Weighted Retriever](/v0.2/docs/integrations/retrievers/time-weighted-retriever)
        *   [Vector Store](/v0.2/docs/integrations/retrievers/vectorstore)
        *   [Vespa Retriever](/v0.2/docs/integrations/retrievers/vespa-retriever)
        *   [Zep Retriever](/v0.2/docs/integrations/retrievers/zep-retriever)
    *   [Tools](/v0.2/docs/integrations/tools)
        
    *   [Toolkits](/v0.2/docs/integrations/toolkits)
        
    *   [Stores](/v0.2/docs/integrations/stores/)
        

*   [](/v0.2/)
*   [Components](/v0.2/docs/integrations/components)
*   [Retrievers](/v0.2/docs/integrations/retrievers)
*   Metal Retriever

Metal Retriever
===============

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

Setup[​](#setup "Direct link to Setup")
---------------------------------------

tip

See [this section for general instructions on installing integration packages](/v0.2/docs/how_to/installation#installing-integration-packages).

*   npm
*   Yarn
*   pnpm

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

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

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

Usage[​](#usage "Direct link to 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](https://v02.api.js.langchain.com/classes/langchain_community_retrievers_metal.MetalRetriever.html) from `@langchain/community/retrievers/metal`

* * *

#### Was this page helpful?

  

#### You can leave detailed feedback [on GitHub](https://github.com/langchain-ai/langchainjs/issues/new?assignees=&labels=03+-+Documentation&projects=&template=documentation.yml&title=DOC%3A+%3CPlease+write+a+comprehensive+title+after+the+%27DOC%3A+%27+prefix%3E).

[

Previous

Amazon Kendra Retriever

](/v0.2/docs/integrations/retrievers/kendra-retriever)[

Next

Supabase Hybrid Search

](/v0.2/docs/integrations/retrievers/supabase-hybrid)

Community

*   [Discord](https://discord.gg/cU2adEyC7w)
*   [Twitter](https://twitter.com/LangChainAI)

GitHub

*   [Python](https://github.com/langchain-ai/langchain)
*   [JS/TS](https://github.com/langchain-ai/langchainjs)

More

*   [Homepage](https://langchain.com)
*   [Blog](https://blog.langchain.dev)

Copyright © 2024 LangChain, Inc.