langchain 0.0.191 → 0.0.193

package/dist/retrievers/amazon_kendra.js

@@ -4,6 +4,22 @@ import { Document } from "../document.js";
 /**
  * Class for interacting with Amazon Kendra, an intelligent search service
  * provided by AWS. Extends the BaseRetriever class.
+ * @example
+ * ```typescript
+ * const retriever = new AmazonKendraRetriever({
+ *   topK: 10,
+ *   indexId: "YOUR_INDEX_ID",
+ *   region: "us-east-2",
+ *   clientOptions: {
+ *     credentials: {
+ *       accessKeyId: "YOUR_ACCESS_KEY_ID",
+ *       secretAccessKey: "YOUR_SECRET_ACCESS_KEY",
+ *     },
+ *   },
+ * });
+ *
+ * const docs = await retriever.getRelevantDocuments("How are clouds formed?");
+ * ```
  */
 export class AmazonKendraRetriever extends BaseRetriever {
     static lc_name() {

package/dist/retrievers/chaindesk.cjs

@@ -4,6 +4,17 @@ exports.ChaindeskRetriever = 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");
+/**
+ * @example
+ * ```typescript
+ * const retriever = new ChaindeskRetriever({
+ *   datastoreId: "DATASTORE_ID",
+ *   apiKey: "CHAINDESK_API_KEY",
+ *   topK: 8,
+ * });
+ * const docs = await retriever.getRelevantDocuments("hello");
+ * ```
+ */
 class ChaindeskRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {
         return "ChaindeskRetriever";

package/dist/retrievers/chaindesk.d.ts

@@ -6,6 +6,17 @@ export interface ChaindeskRetrieverArgs extends AsyncCallerParams, BaseRetriever
     topK?: number;
     apiKey?: string;
 }
+/**
+ * @example
+ * ```typescript
+ * const retriever = new ChaindeskRetriever({
+ *   datastoreId: "DATASTORE_ID",
+ *   apiKey: "CHAINDESK_API_KEY",
+ *   topK: 8,
+ * });
+ * const docs = await retriever.getRelevantDocuments("hello");
+ * ```
+ */
 export declare class ChaindeskRetriever extends BaseRetriever {
     static lc_name(): string;
     lc_namespace: string[];

package/dist/retrievers/chaindesk.js

@@ -1,6 +1,17 @@
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
 import { AsyncCaller } from "../util/async_caller.js";
+/**
+ * @example
+ * ```typescript
+ * const retriever = new ChaindeskRetriever({
+ *   datastoreId: "DATASTORE_ID",
+ *   apiKey: "CHAINDESK_API_KEY",
+ *   topK: 8,
+ * });
+ * const docs = await retriever.getRelevantDocuments("hello");
+ * ```
+ */
 export class ChaindeskRetriever extends BaseRetriever {
     static lc_name() {
         return "ChaindeskRetriever";

package/dist/retrievers/contextual_compression.cjs

@@ -6,6 +6,16 @@ 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.
+ * @example
+ * ```typescript
+ * const retriever = new ContextualCompressionRetriever({
+ *   baseCompressor: new LLMChainExtractor(),
+ *   baseRetriever: new HNSWLib().asRetriever(),
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What did the speaker say about Justice Breyer?",
+ * );
+ * ```
  */
 class ContextualCompressionRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {

package/dist/retrievers/contextual_compression.d.ts

@@ -15,6 +15,16 @@ export interface ContextualCompressionRetrieverArgs extends BaseRetrieverInput {
  * 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.
+ * @example
+ * ```typescript
+ * const retriever = new ContextualCompressionRetriever({
+ *   baseCompressor: new LLMChainExtractor(),
+ *   baseRetriever: new HNSWLib().asRetriever(),
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What did the speaker say about Justice Breyer?",
+ * );
+ * ```
  */
 export declare class ContextualCompressionRetriever extends BaseRetriever {
     static lc_name(): string;

package/dist/retrievers/contextual_compression.js

@@ -3,6 +3,16 @@ 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.
+ * @example
+ * ```typescript
+ * const retriever = new ContextualCompressionRetriever({
+ *   baseCompressor: new LLMChainExtractor(),
+ *   baseRetriever: new HNSWLib().asRetriever(),
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What did the speaker say about Justice Breyer?",
+ * );
+ * ```
  */
 export class ContextualCompressionRetriever extends BaseRetriever {
     static lc_name() {

package/dist/retrievers/document_compressors/embeddings_filter.cjs

@@ -6,6 +6,19 @@ const math_js_1 = require("../../util/math.cjs");
 /**
  * Class that represents a document compressor that uses embeddings to
  * drop documents unrelated to the query.
+ * @example
+ * ```typescript
+ * const embeddingsFilter = new EmbeddingsFilter({
+ *   embeddings: new OpenAIEmbeddings(),
+ *   similarityThreshold: 0.8,
+ *   k: 5,
+ * });
+ * const retrievedDocs = await embeddingsFilter.filterDocuments(
+ *   getDocuments(),
+ *   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+ * );
+ * console.log({ retrievedDocs });
+ * ```
  */
 class EmbeddingsFilter extends index_js_1.BaseDocumentCompressor {
     constructor(params) {

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

@@ -14,6 +14,19 @@ export interface EmbeddingsFilterParams {
 /**
  * Class that represents a document compressor that uses embeddings to
  * drop documents unrelated to the query.
+ * @example
+ * ```typescript
+ * const embeddingsFilter = new EmbeddingsFilter({
+ *   embeddings: new OpenAIEmbeddings(),
+ *   similarityThreshold: 0.8,
+ *   k: 5,
+ * });
+ * const retrievedDocs = await embeddingsFilter.filterDocuments(
+ *   getDocuments(),
+ *   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+ * );
+ * console.log({ retrievedDocs });
+ * ```
  */
 export declare class EmbeddingsFilter extends BaseDocumentCompressor {
     /**

package/dist/retrievers/document_compressors/embeddings_filter.js

@@ -3,6 +3,19 @@ import { cosineSimilarity } from "../../util/math.js";
 /**
  * Class that represents a document compressor that uses embeddings to
  * drop documents unrelated to the query.
+ * @example
+ * ```typescript
+ * const embeddingsFilter = new EmbeddingsFilter({
+ *   embeddings: new OpenAIEmbeddings(),
+ *   similarityThreshold: 0.8,
+ *   k: 5,
+ * });
+ * const retrievedDocs = await embeddingsFilter.filterDocuments(
+ *   getDocuments(),
+ *   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+ * );
+ * console.log({ retrievedDocs });
+ * ```
  */
 export class EmbeddingsFilter extends BaseDocumentCompressor {
     constructor(params) {

package/dist/retrievers/document_compressors/index.cjs

@@ -13,6 +13,32 @@ class BaseDocumentCompressor {
 exports.BaseDocumentCompressor = BaseDocumentCompressor;
 /**
  * Document compressor that uses a pipeline of Transformers.
+ * @example
+ * ```typescript
+ * const compressorPipeline = new DocumentCompressorPipeline({
+ *   transformers: [
+ *     new RecursiveCharacterTextSplitter({
+ *       chunkSize: 200,
+ *       chunkOverlap: 0,
+ *     }),
+ *     new EmbeddingsFilter({
+ *       embeddings: new OpenAIEmbeddings(),
+ *       similarityThreshold: 0.8,
+ *       k: 5,
+ *     }),
+ *   ],
+ * });
+ * const retriever = new ContextualCompressionRetriever({
+ *   baseCompressor: compressorPipeline,
+ *   baseRetriever: new TavilySearchAPIRetriever({
+ *     includeRawContent: true,
+ *   }),
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+ * );
+ * console.log({ retrievedDocs });
+ * ```
  */
 class DocumentCompressorPipeline extends BaseDocumentCompressor {
     constructor(fields) {

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

@@ -19,6 +19,32 @@ export declare abstract class BaseDocumentCompressor {
 }
 /**
  * Document compressor that uses a pipeline of Transformers.
+ * @example
+ * ```typescript
+ * const compressorPipeline = new DocumentCompressorPipeline({
+ *   transformers: [
+ *     new RecursiveCharacterTextSplitter({
+ *       chunkSize: 200,
+ *       chunkOverlap: 0,
+ *     }),
+ *     new EmbeddingsFilter({
+ *       embeddings: new OpenAIEmbeddings(),
+ *       similarityThreshold: 0.8,
+ *       k: 5,
+ *     }),
+ *   ],
+ * });
+ * const retriever = new ContextualCompressionRetriever({
+ *   baseCompressor: compressorPipeline,
+ *   baseRetriever: new TavilySearchAPIRetriever({
+ *     includeRawContent: true,
+ *   }),
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+ * );
+ * console.log({ retrievedDocs });
+ * ```
  */
 export declare class DocumentCompressorPipeline extends BaseDocumentCompressor {
     transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];

package/dist/retrievers/document_compressors/index.js

@@ -9,6 +9,32 @@ export class BaseDocumentCompressor {
 }
 /**
  * Document compressor that uses a pipeline of Transformers.
+ * @example
+ * ```typescript
+ * const compressorPipeline = new DocumentCompressorPipeline({
+ *   transformers: [
+ *     new RecursiveCharacterTextSplitter({
+ *       chunkSize: 200,
+ *       chunkOverlap: 0,
+ *     }),
+ *     new EmbeddingsFilter({
+ *       embeddings: new OpenAIEmbeddings(),
+ *       similarityThreshold: 0.8,
+ *       k: 5,
+ *     }),
+ *   ],
+ * });
+ * const retriever = new ContextualCompressionRetriever({
+ *   baseCompressor: compressorPipeline,
+ *   baseRetriever: new TavilySearchAPIRetriever({
+ *     includeRawContent: true,
+ *   }),
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+ * );
+ * console.log({ retrievedDocs });
+ * ```
  */
 export class DocumentCompressorPipeline extends BaseDocumentCompressor {
     constructor(fields) {

package/dist/retrievers/hyde.cjs

@@ -9,6 +9,25 @@ const base_js_2 = require("../vectorstores/base.cjs");
  * extends the VectorStoreRetriever class and uses a BaseLanguageModel to
  * generate a hypothetical answer to the query, which is then used to
  * retrieve relevant documents.
+ * @example
+ * ```typescript
+ * const retriever = new HydeRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   llm: new ChatOpenAI(),
+ *   k: 1,
+ * });
+ * await vectorStore.addDocuments(
+ *   [
+ *     "My name is John.",
+ *     "My name is Bob.",
+ *     "My favourite food is pizza.",
+ *     "My favourite food is pasta.",
+ *   ].map((pageContent) => new Document({ pageContent })),
+ * );
+ * const results = await retriever.getRelevantDocuments(
+ *   "What is my favourite food?",
+ * );
+ * ```
  */
 class HydeRetriever extends base_js_2.VectorStoreRetriever {
     static lc_name() {

package/dist/retrievers/hyde.d.ts

@@ -21,6 +21,25 @@ export type HydeRetrieverOptions<V extends VectorStore> = VectorStoreRetrieverIn
  * extends the VectorStoreRetriever class and uses a BaseLanguageModel to
  * generate a hypothetical answer to the query, which is then used to
  * retrieve relevant documents.
+ * @example
+ * ```typescript
+ * const retriever = new HydeRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   llm: new ChatOpenAI(),
+ *   k: 1,
+ * });
+ * await vectorStore.addDocuments(
+ *   [
+ *     "My name is John.",
+ *     "My name is Bob.",
+ *     "My favourite food is pizza.",
+ *     "My favourite food is pasta.",
+ *   ].map((pageContent) => new Document({ pageContent })),
+ * );
+ * const results = await retriever.getRelevantDocuments(
+ *   "What is my favourite food?",
+ * );
+ * ```
  */
 export declare class HydeRetriever<V extends VectorStore = VectorStore> extends VectorStoreRetriever<V> {
     static lc_name(): string;

package/dist/retrievers/hyde.js

@@ -6,6 +6,25 @@ import { VectorStoreRetriever, } from "../vectorstores/base.js";
  * extends the VectorStoreRetriever class and uses a BaseLanguageModel to
  * generate a hypothetical answer to the query, which is then used to
  * retrieve relevant documents.
+ * @example
+ * ```typescript
+ * const retriever = new HydeRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   llm: new ChatOpenAI(),
+ *   k: 1,
+ * });
+ * await vectorStore.addDocuments(
+ *   [
+ *     "My name is John.",
+ *     "My name is Bob.",
+ *     "My favourite food is pizza.",
+ *     "My favourite food is pasta.",
+ *   ].map((pageContent) => new Document({ pageContent })),
+ * );
+ * const results = await retriever.getRelevantDocuments(
+ *   "What is my favourite food?",
+ * );
+ * ```
  */
 export class HydeRetriever extends VectorStoreRetriever {
     static lc_name() {

package/dist/retrievers/metal.cjs

@@ -9,6 +9,17 @@ const document_js_1 = require("../document.cjs");
  * 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.
+ * @example
+ * ```typescript
+ * 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");
+ * ```
  */
 class MetalRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {

package/dist/retrievers/metal.d.ts

@@ -15,6 +15,17 @@ export interface MetalRetrieverFields extends BaseRetrieverInput {
  * 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.
+ * @example
+ * ```typescript
+ * 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");
+ * ```
  */
 export declare class MetalRetriever extends BaseRetriever {
     static lc_name(): string;

package/dist/retrievers/metal.js

@@ -6,6 +6,17 @@ import { Document } from "../document.js";
  * 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.
+ * @example
+ * ```typescript
+ * 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");
+ * ```
  */
 export class MetalRetriever extends BaseRetriever {
     static lc_name() {

package/dist/retrievers/multi_query.cjs

@@ -54,7 +54,19 @@ Question 3
 
 Original question: {question}`,
 });
-// Export class
+/**
+ * @example
+ * ```typescript
+ * const retriever = new MultiQueryRetriever.fromLLM({
+ *   llm: new ChatAnthropic({}),
+ *   retriever: new MemoryVectorStore().asRetriever(),
+ *   verbose: true,
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What are mitochondria made of?",
+ * );
+ * ```
+ */
 class MultiQueryRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {
         return "MultiQueryRetriever";

package/dist/retrievers/multi_query.d.ts

@@ -13,6 +13,19 @@ export interface MultiQueryRetrieverInput extends BaseRetrieverInput {
     queryCount?: number;
     parserKey?: string;
 }
+/**
+ * @example
+ * ```typescript
+ * const retriever = new MultiQueryRetriever.fromLLM({
+ *   llm: new ChatAnthropic({}),
+ *   retriever: new MemoryVectorStore().asRetriever(),
+ *   verbose: true,
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What are mitochondria made of?",
+ * );
+ * ```
+ */
 export declare class MultiQueryRetriever extends BaseRetriever {
     static lc_name(): string;
     lc_namespace: string[];

package/dist/retrievers/multi_query.js

@@ -51,7 +51,19 @@ Question 3
 
 Original question: {question}`,
 });
-// Export class
+/**
+ * @example
+ * ```typescript
+ * const retriever = new MultiQueryRetriever.fromLLM({
+ *   llm: new ChatAnthropic({}),
+ *   retriever: new MemoryVectorStore().asRetriever(),
+ *   verbose: true,
+ * });
+ * const retrievedDocs = await retriever.getRelevantDocuments(
+ *   "What are mitochondria made of?",
+ * );
+ * ```
+ */
 export class MultiQueryRetriever extends BaseRetriever {
     static lc_name() {
         return "MultiQueryRetriever";

package/dist/retrievers/multi_vector.cjs

@@ -6,6 +6,19 @@ const retriever_js_1 = require("../schema/retriever.cjs");
  * A retriever that retrieves documents from a vector store and a document
  * store. It uses the vector store to find relevant documents based on a
  * query, and then retrieves the full documents from the document store.
+ * @example
+ * ```typescript
+ * const retriever = new MultiVectorRetriever({
+ *   vectorstore: new FaissStore(),
+ *   docstore: new InMemoryStore(),
+ *   idKey: "doc_id",
+ *   childK: 20,
+ *   parentK: 5,
+ * });
+ *
+ * const retrieverResult = await retriever.getRelevantDocuments("justice breyer");
+ * console.log(retrieverResult[0].pageContent.length);
+ * ```
  */
 class MultiVectorRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {

package/dist/retrievers/multi_vector.d.ts

@@ -16,6 +16,19 @@ export interface MultiVectorRetrieverInput extends BaseRetrieverInput {
  * A retriever that retrieves documents from a vector store and a document
  * store. It uses the vector store to find relevant documents based on a
  * query, and then retrieves the full documents from the document store.
+ * @example
+ * ```typescript
+ * const retriever = new MultiVectorRetriever({
+ *   vectorstore: new FaissStore(),
+ *   docstore: new InMemoryStore(),
+ *   idKey: "doc_id",
+ *   childK: 20,
+ *   parentK: 5,
+ * });
+ *
+ * const retrieverResult = await retriever.getRelevantDocuments("justice breyer");
+ * console.log(retrieverResult[0].pageContent.length);
+ * ```
  */
 export declare class MultiVectorRetriever extends BaseRetriever {
     static lc_name(): string;

package/dist/retrievers/multi_vector.js

@@ -3,6 +3,19 @@ import { BaseRetriever } from "../schema/retriever.js";
  * A retriever that retrieves documents from a vector store and a document
  * store. It uses the vector store to find relevant documents based on a
  * query, and then retrieves the full documents from the document store.
+ * @example
+ * ```typescript
+ * const retriever = new MultiVectorRetriever({
+ *   vectorstore: new FaissStore(),
+ *   docstore: new InMemoryStore(),
+ *   idKey: "doc_id",
+ *   childK: 20,
+ *   parentK: 5,
+ * });
+ *
+ * const retrieverResult = await retriever.getRelevantDocuments("justice breyer");
+ * console.log(retrieverResult[0].pageContent.length);
+ * ```
  */
 export class MultiVectorRetriever extends BaseRetriever {
     static lc_name() {

package/dist/retrievers/parent_document.cjs

@@ -35,6 +35,27 @@ const multi_vector_js_1 = require("./multi_vector.cjs");
  *
  * This strikes a balance between better targeted retrieval with small documents
  * and the more context-rich larger documents.
+ * @example
+ * ```typescript
+ * const retriever = new ParentDocumentRetriever({
+ *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   docstore: new InMemoryStore(),
+ *   parentSplitter: new RecursiveCharacterTextSplitter({
+ *     chunkOverlap: 0,
+ *     chunkSize: 500,
+ *   }),
+ *   childSplitter: new RecursiveCharacterTextSplitter({
+ *     chunkOverlap: 0,
+ *     chunkSize: 50,
+ *   }),
+ *   childK: 20,
+ *   parentK: 5,
+ * });
+ *
+ * const parentDocuments = await getDocuments();
+ * await retriever.addDocuments(parentDocuments);
+ * const retrievedDocs = await retriever.getRelevantDocuments("justice breyer");
+ * ```
  */
 class ParentDocumentRetriever extends multi_vector_js_1.MultiVectorRetriever {
     static lc_name() {

package/dist/retrievers/parent_document.d.ts

@@ -23,6 +23,27 @@ export type ParentDocumentRetrieverFields = MultiVectorRetrieverInput & {
  *
  * This strikes a balance between better targeted retrieval with small documents
  * and the more context-rich larger documents.
+ * @example
+ * ```typescript
+ * const retriever = new ParentDocumentRetriever({
+ *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   docstore: new InMemoryStore(),
+ *   parentSplitter: new RecursiveCharacterTextSplitter({
+ *     chunkOverlap: 0,
+ *     chunkSize: 500,
+ *   }),
+ *   childSplitter: new RecursiveCharacterTextSplitter({
+ *     chunkOverlap: 0,
+ *     chunkSize: 50,
+ *   }),
+ *   childK: 20,
+ *   parentK: 5,
+ * });
+ *
+ * const parentDocuments = await getDocuments();
+ * await retriever.addDocuments(parentDocuments);
+ * const retrievedDocs = await retriever.getRelevantDocuments("justice breyer");
+ * ```
  */
 export declare class ParentDocumentRetriever extends MultiVectorRetriever {
     static lc_name(): string;

package/dist/retrievers/parent_document.js

@@ -9,6 +9,27 @@ import { MultiVectorRetriever, } from "./multi_vector.js";
  *
  * This strikes a balance between better targeted retrieval with small documents
  * and the more context-rich larger documents.
+ * @example
+ * ```typescript
+ * const retriever = new ParentDocumentRetriever({
+ *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   docstore: new InMemoryStore(),
+ *   parentSplitter: new RecursiveCharacterTextSplitter({
+ *     chunkOverlap: 0,
+ *     chunkSize: 500,
+ *   }),
+ *   childSplitter: new RecursiveCharacterTextSplitter({
+ *     chunkOverlap: 0,
+ *     chunkSize: 50,
+ *   }),
+ *   childK: 20,
+ *   parentK: 5,
+ * });
+ *
+ * const parentDocuments = await getDocuments();
+ * await retriever.addDocuments(parentDocuments);
+ * const retrievedDocs = await retriever.getRelevantDocuments("justice breyer");
+ * ```
  */
 export class ParentDocumentRetriever extends MultiVectorRetriever {
     static lc_name() {

package/dist/retrievers/remote/chatgpt-plugin.cjs

@@ -7,6 +7,16 @@ const base_js_1 = require("./base.cjs");
  * Class that connects ChatGPT to third-party applications via plugins. It
  * extends the RemoteRetriever class and implements the
  * ChatGPTPluginRetrieverParams interface.
+ * @example
+ * ```typescript
+ * const retriever = new ChatGPTPluginRetriever({
+ *   url: "http:
+ *   auth: {
+ *     bearer: "super-secret-jwt-token-with-at-least-32-characters-long",
+ *   },
+ * });
+ * const docs = await retriever.getRelevantDocuments("hello world");
+ * ```
  */
 class ChatGPTPluginRetriever extends base_js_1.RemoteRetriever {
     constructor({ topK = 4, filter, ...rest }) {