-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Add MetalRetriever #613
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add MetalRetriever #613
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| import type MetalSDK from "@getmetal/metal-sdk"; | ||
|
|
||
| import { BaseRetriever } from "../schema/index.js"; | ||
| import { Document } from "../document.js"; | ||
|
|
||
| export interface MetalRetrieverFields { | ||
| client: MetalSDK.default; | ||
| } | ||
|
|
||
| interface ResponseItem { | ||
| text: string; | ||
| [key: string]: unknown; | ||
| } | ||
|
|
||
| export class MetalRetriever extends BaseRetriever { | ||
| client: MetalSDK.default; | ||
|
|
||
| constructor(fields: MetalRetrieverFields) { | ||
| super(); | ||
|
|
||
| this.client = fields.client; | ||
| } | ||
|
|
||
| async getRelevantDocuments(query: string): Promise<Document[]> { | ||
| const res = await this.client.search({ text: query }); | ||
|
|
||
| const items = ("data" in res ? res.data : res) as ResponseItem[]; | ||
| return items.map( | ||
| ({ text, metadata }) => | ||
| new Document({ | ||
| pageContent: text, | ||
| metadata: metadata as Record<string, unknown>, | ||
| }) | ||
| ); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* eslint-disable no-process-env */ | ||
| /* eslint-disable @typescript-eslint/no-non-null-assertion */ | ||
| import { test, expect } from "@jest/globals"; | ||
| import Metal from "@getmetal/metal-sdk"; | ||
|
|
||
| import { MetalRetriever } from "../metal.js"; | ||
|
|
||
| test("MetalRetriever", 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"); | ||
|
|
||
| expect(docs.length).toBeGreaterThan(0); | ||
|
|
||
| console.log(docs); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we also return a
distwhich shows the similarity distance when running a search with atextquery. Perhaps we should include this in themetadataofDocumentbelow?