langchain.js
    Preparing search index...

    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.

    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");

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    lc_namespace

    Methods

    _getRelevantDocuments lc_name

    Constructors

    Properties

    lc_namespace: string[] = ...

    Methods

    _getRelevantDocuments

    • _getRelevantDocuments(query: string): Promise<Document[]>

      Parameters

      • query: string

      Returns Promise<Document[]>

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods