langchain 0.0.131 → 0.0.132

package/dist/retrievers/amazon_kendra.d.ts

@@ -1,6 +1,10 @@
 import { AttributeFilter, DocumentAttribute, DocumentAttributeValue, KendraClient, KendraClientConfig, QueryCommandOutput, QueryResultItem, RetrieveCommandOutput, RetrieveResultItem } from "@aws-sdk/client-kendra";
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * Interface for the arguments required to initialize an
+ * AmazonKendraRetriever instance.
+ */
 export interface AmazonKendraRetrieverArgs {
     indexId: string;
     topK: number;
@@ -8,6 +12,10 @@ export interface AmazonKendraRetrieverArgs {
     attributeFilter?: AttributeFilter;
     clientOptions?: KendraClientConfig;
 }
+/**
+ * Class for interacting with Amazon Kendra, an intelligent search service
+ * provided by AWS. Extends the BaseRetriever class.
+ */
 export declare class AmazonKendraRetriever extends BaseRetriever {
     static lc_name(): string;
     lc_namespace: string[];
@@ -16,12 +24,40 @@ export declare class AmazonKendraRetriever extends BaseRetriever {
     kendraClient: KendraClient;
     attributeFilter?: AttributeFilter;
     constructor({ indexId, topK, clientOptions, attributeFilter, region, }: AmazonKendraRetrieverArgs);
+    /**
+     * Combines title and excerpt into a single string.
+     * @param title The title of the document.
+     * @param excerpt An excerpt from the document.
+     * @returns A single string combining the title and excerpt.
+     */
     combineText(title?: string, excerpt?: string): string;
+    /**
+     * Cleans the result text by replacing sequences of whitespace with a
+     * single space and removing ellipses.
+     * @param resText The result text to clean.
+     * @returns The cleaned result text.
+     */
     cleanResult(resText: string): string;
+    /**
+     * Extracts the attribute value from a DocumentAttributeValue object.
+     * @param value The DocumentAttributeValue object to extract the value from.
+     * @returns The extracted attribute value.
+     */
     getDocAttributeValue(value: DocumentAttributeValue): string | number | string[] | Date;
+    /**
+     * Extracts the attribute key-value pairs from an array of
+     * DocumentAttribute objects.
+     * @param documentAttributes The array of DocumentAttribute objects to extract the key-value pairs from.
+     * @returns An object containing the extracted attribute key-value pairs.
+     */
     getDocAttributes(documentAttributes?: DocumentAttribute[]): {
         [key: string]: unknown;
     };
+    /**
+     * Converts a RetrieveResultItem object into a Document object.
+     * @param item The RetrieveResultItem object to convert.
+     * @returns A Document object.
+     */
     convertRetrieverItem(item: RetrieveResultItem): Document<{
         source: string | undefined;
         title: string;
@@ -30,8 +66,24 @@ export declare class AmazonKendraRetriever extends BaseRetriever {
             [key: string]: unknown;
         };
     }>;
+    /**
+     * Extracts the top-k documents from a RetrieveCommandOutput object.
+     * @param response The RetrieveCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getRetrieverDocs(response: RetrieveCommandOutput, pageSize: number): Document[];
+    /**
+     * Extracts the excerpt text from a QueryResultItem object.
+     * @param item The QueryResultItem object to extract the excerpt text from.
+     * @returns The extracted excerpt text.
+     */
     getQueryItemExcerpt(item: QueryResultItem): string;
+    /**
+     * Converts a QueryResultItem object into a Document object.
+     * @param item The QueryResultItem object to convert.
+     * @returns A Document object.
+     */
     convertQueryItem(item: QueryResultItem): Document<{
         source: string | undefined;
         title: string;
@@ -40,6 +92,12 @@ export declare class AmazonKendraRetriever extends BaseRetriever {
             [key: string]: unknown;
         };
     }>;
+    /**
+     * Extracts the top-k documents from a QueryCommandOutput object.
+     * @param response The QueryCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getQueryDocs(response: QueryCommandOutput, pageSize: number): Document<{
         source: string | undefined;
         title: string;
@@ -48,6 +106,14 @@ export declare class AmazonKendraRetriever extends BaseRetriever {
             [key: string]: unknown;
         };
     }>[];
+    /**
+     * Sends a retrieve or query request to Kendra and returns the top-k
+     * documents.
+     * @param query The query to send to Kendra.
+     * @param topK The number of top documents to return.
+     * @param attributeFilter Optional filter to apply when retrieving documents.
+     * @returns A Promise that resolves to an array of Document objects.
+     */
     queryKendra(query: string, topK: number, attributeFilter?: AttributeFilter): Promise<Document<Record<string, any>>[] | Document<{
         source: string | undefined;
         title: string;

package/dist/retrievers/amazon_kendra.js

@@ -1,6 +1,10 @@
 import { KendraClient, QueryCommand, RetrieveCommand, } from "@aws-sdk/client-kendra";
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * Class for interacting with Amazon Kendra, an intelligent search service
+ * provided by AWS. Extends the BaseRetriever class.
+ */
 export class AmazonKendraRetriever extends BaseRetriever {
     static lc_name() {
         return "AmazonKendraRetriever";
@@ -52,6 +56,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         this.indexId = indexId;
     }
     // A method to combine title and excerpt into a single string.
+    /**
+     * Combines title and excerpt into a single string.
+     * @param title The title of the document.
+     * @param excerpt An excerpt from the document.
+     * @returns A single string combining the title and excerpt.
+     */
     combineText(title, excerpt) {
         let text = "";
         if (title) {
@@ -63,11 +73,22 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return text;
     }
     // A method to clean the result text by replacing sequences of whitespace with a single space and removing ellipses.
+    /**
+     * Cleans the result text by replacing sequences of whitespace with a
+     * single space and removing ellipses.
+     * @param resText The result text to clean.
+     * @returns The cleaned result text.
+     */
     cleanResult(resText) {
         const res = resText.replace(/\s+/g, " ").replace(/\.\.\./g, "");
         return res;
     }
     // A method to extract the attribute value from a DocumentAttributeValue object.
+    /**
+     * Extracts the attribute value from a DocumentAttributeValue object.
+     * @param value The DocumentAttributeValue object to extract the value from.
+     * @returns The extracted attribute value.
+     */
     getDocAttributeValue(value) {
         if (value.DateValue) {
             return value.DateValue;
@@ -84,6 +105,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return "";
     }
     // A method to extract the attribute key-value pairs from an array of DocumentAttribute objects.
+    /**
+     * Extracts the attribute key-value pairs from an array of
+     * DocumentAttribute objects.
+     * @param documentAttributes The array of DocumentAttribute objects to extract the key-value pairs from.
+     * @returns An object containing the extracted attribute key-value pairs.
+     */
     getDocAttributes(documentAttributes) {
         const attributes = {};
         if (documentAttributes) {
@@ -96,6 +123,11 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return attributes;
     }
     // A method to convert a RetrieveResultItem object into a Document object.
+    /**
+     * Converts a RetrieveResultItem object into a Document object.
+     * @param item The RetrieveResultItem object to convert.
+     * @returns A Document object.
+     */
     convertRetrieverItem(item) {
         const title = item.DocumentTitle || "";
         const excerpt = item.Content ? this.cleanResult(item.Content) : "";
@@ -111,6 +143,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return new Document({ pageContent, metadata });
     }
     // A method to extract the top-k documents from a RetrieveCommandOutput object.
+    /**
+     * Extracts the top-k documents from a RetrieveCommandOutput object.
+     * @param response The RetrieveCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getRetrieverDocs(response, pageSize) {
         if (!response.ResultItems)
             return [];
@@ -119,6 +157,11 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return response.ResultItems.slice(0, count).map((item) => this.convertRetrieverItem(item));
     }
     // A method to extract the excerpt text from a QueryResultItem object.
+    /**
+     * Extracts the excerpt text from a QueryResultItem object.
+     * @param item The QueryResultItem object to extract the excerpt text from.
+     * @returns The extracted excerpt text.
+     */
     getQueryItemExcerpt(item) {
         if (item.AdditionalAttributes &&
             item.AdditionalAttributes.length &&
@@ -139,6 +182,11 @@ export class AmazonKendraRetriever extends BaseRetriever {
         }
     }
     // A method to convert a QueryResultItem object into a Document object.
+    /**
+     * Converts a QueryResultItem object into a Document object.
+     * @param item The QueryResultItem object to convert.
+     * @returns A Document object.
+     */
     convertQueryItem(item) {
         const title = item.DocumentTitle?.Text || "";
         const excerpt = this.getQueryItemExcerpt(item);
@@ -154,6 +202,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return new Document({ pageContent, metadata });
     }
     // A method to extract the top-k documents from a QueryCommandOutput object.
+    /**
+     * Extracts the top-k documents from a QueryCommandOutput object.
+     * @param response The QueryCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getQueryDocs(response, pageSize) {
         if (!response.ResultItems)
             return [];
@@ -162,6 +216,14 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return response.ResultItems.slice(0, count).map((item) => this.convertQueryItem(item));
     }
     // A method to send a retrieve or query request to Kendra and return the top-k documents.
+    /**
+     * Sends a retrieve or query request to Kendra and returns the top-k
+     * documents.
+     * @param query The query to send to Kendra.
+     * @param topK The number of top documents to return.
+     * @param attributeFilter Optional filter to apply when retrieving documents.
+     * @returns A Promise that resolves to an array of Document objects.
+     */
     async queryKendra(query, topK, attributeFilter) {
         const retrieveCommand = new RetrieveCommand({
             IndexId: this.indexId,

package/dist/retrievers/contextual_compression.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextualCompressionRetriever = void 0;
 const retriever_js_1 = require("../schema/retriever.cjs");
+/**
+ * A retriever that wraps a base retriever and compresses the results. It
+ * retrieves relevant documents based on a given query and then compresses
+ * these documents using a specified document compressor.
+ */
 class ContextualCompressionRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {
         return "ContextualCompressionRetriever";

package/dist/retrievers/contextual_compression.d.ts

@@ -2,10 +2,20 @@ import { BaseDocumentCompressor } from "./document_compressors/index.js";
 import { Document } from "../document.js";
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { CallbackManagerForRetrieverRun } from "../callbacks/manager.js";
+/**
+ * Interface for the arguments required to construct a
+ * ContextualCompressionRetriever. It extends the BaseRetrieverInput
+ * interface with two additional fields: baseCompressor and baseRetriever.
+ */
 export interface ContextualCompressionRetrieverArgs extends BaseRetrieverInput {
     baseCompressor: BaseDocumentCompressor;
     baseRetriever: BaseRetriever;
 }
+/**
+ * A retriever that wraps a base retriever and compresses the results. It
+ * retrieves relevant documents based on a given query and then compresses
+ * these documents using a specified document compressor.
+ */
 export declare class ContextualCompressionRetriever extends BaseRetriever {
     static lc_name(): string;
     lc_namespace: string[];

package/dist/retrievers/contextual_compression.js

@@ -1,4 +1,9 @@
 import { BaseRetriever } from "../schema/retriever.js";
+/**
+ * A retriever that wraps a base retriever and compresses the results. It
+ * retrieves relevant documents based on a given query and then compresses
+ * these documents using a specified document compressor.
+ */
 export class ContextualCompressionRetriever extends BaseRetriever {
     static lc_name() {
         return "ContextualCompressionRetriever";

package/dist/retrievers/databerry.cjs

@@ -4,6 +4,11 @@ exports.DataberryRetriever = void 0;
 const retriever_js_1 = require("../schema/retriever.cjs");
 const document_js_1 = require("../document.cjs");
 const async_caller_js_1 = require("../util/async_caller.cjs");
+/**
+ * A specific implementation of a document retriever for the Databerry
+ * API. It extends the BaseRetriever class, which is an abstract base
+ * class for a document retrieval system in LangChain.
+ */
 class DataberryRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {
         return "DataberryRetriever";

package/dist/retrievers/databerry.d.ts

@@ -1,11 +1,20 @@
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { Document } from "../document.js";
 import { AsyncCaller, AsyncCallerParams } from "../util/async_caller.js";
+/**
+ * Interface for the arguments required to create a new instance of
+ * DataberryRetriever.
+ */
 export interface DataberryRetrieverArgs extends AsyncCallerParams, BaseRetrieverInput {
     datastoreUrl: string;
     topK?: number;
     apiKey?: string;
 }
+/**
+ * A specific implementation of a document retriever for the Databerry
+ * API. It extends the BaseRetriever class, which is an abstract base
+ * class for a document retrieval system in LangChain.
+ */
 export declare class DataberryRetriever extends BaseRetriever {
     static lc_name(): string;
     lc_namespace: string[];

package/dist/retrievers/databerry.js

@@ -1,6 +1,11 @@
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
 import { AsyncCaller } from "../util/async_caller.js";
+/**
+ * A specific implementation of a document retriever for the Databerry
+ * API. It extends the BaseRetriever class, which is an abstract base
+ * class for a document retrieval system in LangChain.
+ */
 export class DataberryRetriever extends BaseRetriever {
     static lc_name() {
         return "DataberryRetriever";

package/dist/retrievers/document_compressors/chain_extract.cjs

@@ -51,6 +51,10 @@ function getDefaultChainPrompt() {
         outputParser,
     });
 }
+/**
+ * A class that uses an LLM chain to extract relevant parts of documents.
+ * It extends the BaseDocumentCompressor class.
+ */
 class LLMChainExtractor extends index_js_2.BaseDocumentCompressor {
     constructor({ llmChain, getInput }) {
         super();
@@ -69,6 +73,12 @@ class LLMChainExtractor extends index_js_2.BaseDocumentCompressor {
         this.llmChain = llmChain;
         this.getInput = getInput;
     }
+    /**
+     * Compresses a list of documents based on the output of an LLM chain.
+     * @param documents The list of documents to be compressed.
+     * @param query The query to be used for document compression.
+     * @returns A list of compressed documents.
+     */
     async compressDocuments(documents, query) {
         const compressedDocs = await Promise.all(documents.map(async (doc) => {
             const input = this.getInput(query, doc);
@@ -82,6 +92,14 @@ class LLMChainExtractor extends index_js_2.BaseDocumentCompressor {
         }));
         return compressedDocs.filter((doc) => doc !== undefined);
     }
+    /**
+     * Creates a new instance of LLMChainExtractor from a given LLM, prompt
+     * template, and getInput function.
+     * @param llm The BaseLanguageModel instance used for document extraction.
+     * @param prompt The PromptTemplate instance used for document extraction.
+     * @param getInput A function used for constructing the chain input from the query and a Document.
+     * @returns A new instance of LLMChainExtractor.
+     */
     static fromLLM(llm, prompt, getInput) {
         const _prompt = prompt || getDefaultChainPrompt();
         const _getInput = getInput || defaultGetInput;

package/dist/retrievers/document_compressors/chain_extract.d.ts

@@ -3,14 +3,36 @@ import { LLMChain } from "../../chains/llm_chain.js";
 import { PromptTemplate } from "../../prompts/index.js";
 import { BaseLanguageModel } from "../../base_language/index.js";
 import { BaseDocumentCompressor } from "./index.js";
+/**
+ * Interface for the arguments required to create an instance of
+ * LLMChainExtractor.
+ */
 export interface LLMChainExtractorArgs {
     llmChain: LLMChain;
     getInput: (query: string, doc: Document) => Record<string, unknown>;
 }
+/**
+ * A class that uses an LLM chain to extract relevant parts of documents.
+ * It extends the BaseDocumentCompressor class.
+ */
 export declare class LLMChainExtractor extends BaseDocumentCompressor {
     llmChain: LLMChain;
     getInput: (query: string, doc: Document) => Record<string, unknown>;
     constructor({ llmChain, getInput }: LLMChainExtractorArgs);
+    /**
+     * Compresses a list of documents based on the output of an LLM chain.
+     * @param documents The list of documents to be compressed.
+     * @param query The query to be used for document compression.
+     * @returns A list of compressed documents.
+     */
     compressDocuments(documents: Document[], query: string): Promise<Document[]>;
+    /**
+     * Creates a new instance of LLMChainExtractor from a given LLM, prompt
+     * template, and getInput function.
+     * @param llm The BaseLanguageModel instance used for document extraction.
+     * @param prompt The PromptTemplate instance used for document extraction.
+     * @param getInput A function used for constructing the chain input from the query and a Document.
+     * @returns A new instance of LLMChainExtractor.
+     */
     static fromLLM(llm: BaseLanguageModel, prompt?: PromptTemplate, getInput?: (query: string, doc: Document) => Record<string, unknown>): LLMChainExtractor;
 }

package/dist/retrievers/document_compressors/chain_extract.js

@@ -48,6 +48,10 @@ function getDefaultChainPrompt() {
         outputParser,
     });
 }
+/**
+ * A class that uses an LLM chain to extract relevant parts of documents.
+ * It extends the BaseDocumentCompressor class.
+ */
 export class LLMChainExtractor extends BaseDocumentCompressor {
     constructor({ llmChain, getInput }) {
         super();
@@ -66,6 +70,12 @@ export class LLMChainExtractor extends BaseDocumentCompressor {
         this.llmChain = llmChain;
         this.getInput = getInput;
     }
+    /**
+     * Compresses a list of documents based on the output of an LLM chain.
+     * @param documents The list of documents to be compressed.
+     * @param query The query to be used for document compression.
+     * @returns A list of compressed documents.
+     */
     async compressDocuments(documents, query) {
         const compressedDocs = await Promise.all(documents.map(async (doc) => {
             const input = this.getInput(query, doc);
@@ -79,6 +89,14 @@ export class LLMChainExtractor extends BaseDocumentCompressor {
         }));
         return compressedDocs.filter((doc) => doc !== undefined);
     }
+    /**
+     * Creates a new instance of LLMChainExtractor from a given LLM, prompt
+     * template, and getInput function.
+     * @param llm The BaseLanguageModel instance used for document extraction.
+     * @param prompt The PromptTemplate instance used for document extraction.
+     * @param getInput A function used for constructing the chain input from the query and a Document.
+     * @returns A new instance of LLMChainExtractor.
+     */
     static fromLLM(llm, prompt, getInput) {
         const _prompt = prompt || getDefaultChainPrompt();
         const _getInput = getInput || defaultGetInput;

package/dist/retrievers/document_compressors/index.d.ts

@@ -3,5 +3,14 @@ import { Document } from "../../document.js";
  * Base Document Compression class. All compressors should extend this class.
  */
 export declare abstract class BaseDocumentCompressor {
+    /**
+     * Abstract method that must be implemented by any class that extends
+     * `BaseDocumentCompressor`. This method takes an array of `Document`
+     * objects and a query string as parameters and returns a Promise that
+     * resolves with an array of compressed `Document` objects.
+     * @param documents An array of `Document` objects to be compressed.
+     * @param query A query string.
+     * @returns A Promise that resolves with an array of compressed `Document` objects.
+     */
     abstract compressDocuments(documents: Document[], query: string): Promise<Document[]>;
 }

package/dist/retrievers/hyde.cjs

@@ -4,6 +4,12 @@ exports.getPromptTemplateFromKey = exports.HydeRetriever = void 0;
 const base_js_1 = require("../prompts/base.cjs");
 const prompt_js_1 = require("../prompts/prompt.cjs");
 const base_js_2 = require("../vectorstores/base.cjs");
+/**
+ * A class for retrieving relevant documents based on a given query. It
+ * extends the VectorStoreRetriever class and uses a BaseLanguageModel to
+ * generate a hypothetical answer to the query, which is then used to
+ * retrieve relevant documents.
+ */
 class HydeRetriever extends base_js_2.VectorStoreRetriever {
     static lc_name() {
         return "HydeRetriever";
@@ -52,6 +58,9 @@ class HydeRetriever extends base_js_2.VectorStoreRetriever {
     }
 }
 exports.HydeRetriever = HydeRetriever;
+/**
+ * Returns a BasePromptTemplate instance based on a given PromptKey.
+ */
 function getPromptTemplateFromKey(key) {
     let template;
     switch (key) {

package/dist/retrievers/hyde.d.ts

@@ -3,11 +3,25 @@ import { BasePromptTemplate } from "../prompts/base.js";
 import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "../vectorstores/base.js";
 import { BaseLanguageModel } from "../base_language/index.js";
 import { CallbackManagerForRetrieverRun } from "../callbacks/manager.js";
+/**
+ * A string that corresponds to a specific prompt template.
+ */
 export type PromptKey = "websearch" | "scifact" | "arguana" | "trec-covid" | "fiqa" | "dbpedia-entity" | "trec-news" | "mr-tydi";
+/**
+ * Options for the HydeRetriever class, which includes a BaseLanguageModel
+ * instance, a VectorStore instance, and an optional promptTemplate which
+ * can either be a BasePromptTemplate instance or a PromptKey.
+ */
 export type HydeRetrieverOptions<V extends VectorStore> = VectorStoreRetrieverInput<V> & {
     llm: BaseLanguageModel;
     promptTemplate?: BasePromptTemplate | PromptKey;
 };
+/**
+ * A class for retrieving relevant documents based on a given query. It
+ * extends the VectorStoreRetriever class and uses a BaseLanguageModel to
+ * generate a hypothetical answer to the query, which is then used to
+ * retrieve relevant documents.
+ */
 export declare class HydeRetriever<V extends VectorStore = VectorStore> extends VectorStoreRetriever<V> {
     static lc_name(): string;
     get lc_namespace(): string[];
@@ -16,4 +30,7 @@ export declare class HydeRetriever<V extends VectorStore = VectorStore> extends
     constructor(fields: HydeRetrieverOptions<V>);
     _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
 }
+/**
+ * Returns a BasePromptTemplate instance based on a given PromptKey.
+ */
 export declare function getPromptTemplateFromKey(key: PromptKey): BasePromptTemplate;

package/dist/retrievers/hyde.js

@@ -1,6 +1,12 @@
 import { StringPromptValue } from "../prompts/base.js";
 import { PromptTemplate } from "../prompts/prompt.js";
 import { VectorStoreRetriever, } from "../vectorstores/base.js";
+/**
+ * A class for retrieving relevant documents based on a given query. It
+ * extends the VectorStoreRetriever class and uses a BaseLanguageModel to
+ * generate a hypothetical answer to the query, which is then used to
+ * retrieve relevant documents.
+ */
 export class HydeRetriever extends VectorStoreRetriever {
     static lc_name() {
         return "HydeRetriever";
@@ -48,6 +54,9 @@ export class HydeRetriever extends VectorStoreRetriever {
         return results;
     }
 }
+/**
+ * Returns a BasePromptTemplate instance based on a given PromptKey.
+ */
 export function getPromptTemplateFromKey(key) {
     let template;
     switch (key) {

package/dist/retrievers/metal.cjs

@@ -3,6 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetalRetriever = void 0;
 const retriever_js_1 = require("../schema/retriever.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * 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.
+ */
 class MetalRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {
         return "MetalRetriever";

package/dist/retrievers/metal.d.ts

@@ -1,9 +1,21 @@
 import Metal from "@getmetal/metal-sdk";
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * Interface for the fields required during the initialization of a
+ * `MetalRetriever` instance. It extends the `BaseRetrieverInput`
+ * interface and adds a `client` field of type `Metal`.
+ */
 export interface MetalRetrieverFields extends BaseRetrieverInput {
     client: Metal;
 }
+/**
+ * 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.
+ */
 export declare class MetalRetriever extends BaseRetriever {
     static lc_name(): string;
     lc_namespace: string[];

package/dist/retrievers/metal.js

@@ -1,5 +1,12 @@
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * 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.
+ */
 export class MetalRetriever extends BaseRetriever {
     static lc_name() {
         return "MetalRetriever";

package/dist/retrievers/parent_document.cjs

@@ -27,6 +27,15 @@ exports.ParentDocumentRetriever = void 0;
 const uuid = __importStar(require("uuid"));
 const retriever_js_1 = require("../schema/retriever.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * A type of document retriever that splits input documents into smaller chunks
+ * while separately storing and preserving the original documents.
+ * The small chunks are embedded, then on retrieval, the original
+ * "parent" documents are retrieved.
+ *
+ * This strikes a balance between better targeted retrieval with small documents
+ * and the more context-rich larger documents.
+ */
 class ParentDocumentRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {
         return "ParentDocumentRetriever";
@@ -69,14 +78,21 @@ class ParentDocumentRetriever extends retriever_js_1.BaseRetriever {
             writable: true,
             value: "doc_id"
         });
+        Object.defineProperty(this, "childK", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.vectorstore = fields.vectorstore;
         this.docstore = fields.docstore;
         this.childSplitter = fields.childSplitter;
         this.parentSplitter = fields.parentSplitter;
         this.idKey = fields.idKey ?? this.idKey;
+        this.childK = fields.childK;
     }
     async _getRelevantDocuments(query) {
-        const subDocs = await this.vectorstore.similaritySearch(query);
+        const subDocs = await this.vectorstore.similaritySearch(query, this.childK);
         // Maintain order
         const parentDocIds = [];
         for (const doc of subDocs) {