Add docs and example

Author: nfcampos

docs/docs/modules/indexes/retrievers/metal-retriever.mdx

@@ -0,0 +1,16 @@
+# Remote Retriever
+
+This example shows how to use the Metal Retriever in a `RetrievalQAChain` to retrieve documents from Metal index.
+
+## Setup
+
+```bash npm2yarn
+npm i @getmetal/metal-sdk
+```
+
+## Usage
+
+import CodeBlock from "@theme/CodeBlock";
+import Example from "@examples/retrievers/metal.ts";
+
+<CodeBlock language="typescript">{Example}</CodeBlock>

docs/docs/modules/indexes/retrievers/remote-retriever.mdx

@@ -1,6 +1,6 @@
 # Remote Retriever
 
-This example shows how to use the a Remote Retriever in a `RetrievalQAChain` to retrieve documents from a remote server.
+This example shows how to use a Remote Retriever in a `RetrievalQAChain` to retrieve documents from a remote server.
 
 ## Usage
 

docs/docs/modules/indexes/retrievers/supabase_hybrid.mdx renamed to docs/docs/modules/indexes/retrievers/supabase-hybrid.mdx

@@ -21,6 +21,7 @@
   "license": "MIT",
   "dependencies": {
     "@dqbd/tiktoken": "^1.0.2",
+    "@getmetal/metal-sdk": "^1.0.12",
     "@pinecone-database/pinecone": "^0.0.10",
     "@supabase/supabase-js": "^2.10.0",
     "chromadb": "^1.3.0",

examples/package.json

@@ -0,0 +1,17 @@
+import Metal from "@getmetal/metal-sdk";
+import { MetalRetriever } from "langchain/retrievers";
+
+export const run = async () => {
+  const MetalSDK = Metal.default;
+
+  const client = new MetalSDK(
+    process.env.METAL_API_KEY!,
+    process.env.METAL_CLIENT_ID!,
+    process.env.METAL_APP_ID
+  );
+  const retriever = new MetalRetriever({ client });
+
+  const docs = await retriever.getRelevantDocuments("hello");
+
+  console.log(docs);
+};

examples/src/retrievers/metal.ts

@@ -325,4 +325,4 @@
       "import": "./retrievers.js"
     }
   }
-}
+}

langchain/package.json

@@ -11407,6 +11407,7 @@ __metadata:
   resolution: "langchain-examples@workspace:examples"
   dependencies:
     "@dqbd/tiktoken": ^1.0.2
+    "@getmetal/metal-sdk": ^1.0.12
     "@pinecone-database/pinecone": ^0.0.10
     "@supabase/supabase-js": ^2.10.0
     "@tsconfig/recommended": ^1.0.2
@@ -11521,6 +11522,8 @@ __metadata:
   peerDependenciesMeta:
     "@dqbd/tiktoken":
       optional: true
+    "@getmetal/metal-sdk":
+      optional: true
     "@huggingface/inference":
       optional: true
     "@pinecone-database/pinecone":