langchain 0.0.192 → 0.0.194

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 }) {

package/dist/retrievers/remote/chatgpt-plugin.d.ts

@@ -26,6 +26,16 @@ export interface ChatGPTPluginRetrieverParams extends RemoteRetrieverParams {
  * 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");
+ * ```
  */
 export declare class ChatGPTPluginRetriever extends RemoteRetriever implements ChatGPTPluginRetrieverParams {
     lc_namespace: string[];

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

@@ -4,6 +4,16 @@ import { RemoteRetriever, } from "./base.js";
  * 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");
+ * ```
  */
 export class ChatGPTPluginRetriever extends RemoteRetriever {
     constructor({ topK = 4, filter, ...rest }) {

package/dist/retrievers/self_query/chroma.cjs

@@ -8,6 +8,21 @@ const base_js_1 = require("./base.cjs");
  * BasicTranslator class and translates internal query language elements
  * to valid filters. The class defines a subset of allowed logical
  * operators and comparators that can be used in the translation process.
+ * @example
+ * ```typescript
+ * const chromaTranslator = new ChromaTranslator();
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new Chroma(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: chromaTranslator,
+ * });
+ *
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 class ChromaTranslator extends base_js_1.BasicTranslator {
     constructor() {

package/dist/retrievers/self_query/chroma.d.ts

@@ -5,6 +5,21 @@ import { BasicTranslator } from "./base.js";
  * BasicTranslator class and translates internal query language elements
  * to valid filters. The class defines a subset of allowed logical
  * operators and comparators that can be used in the translation process.
+ * @example
+ * ```typescript
+ * const chromaTranslator = new ChromaTranslator();
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new Chroma(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: chromaTranslator,
+ * });
+ *
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export declare class ChromaTranslator<T extends Chroma> extends BasicTranslator<T> {
     constructor();

package/dist/retrievers/self_query/chroma.js

@@ -5,6 +5,21 @@ import { BasicTranslator } from "./base.js";
  * BasicTranslator class and translates internal query language elements
  * to valid filters. The class defines a subset of allowed logical
  * operators and comparators that can be used in the translation process.
+ * @example
+ * ```typescript
+ * const chromaTranslator = new ChromaTranslator();
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new Chroma(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: chromaTranslator,
+ * });
+ *
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export class ChromaTranslator extends BasicTranslator {
     constructor() {

package/dist/retrievers/self_query/functional.cjs

@@ -7,6 +7,13 @@ const utils_js_1 = require("./utils.cjs");
 /**
  * A class that extends `BaseTranslator` to translate structured queries
  * into functional filters.
+ * @example
+ * ```typescript
+ * const functionalTranslator = new FunctionalTranslator();
+ * const relevantDocuments = await functionalTranslator.getRelevantDocuments(
+ *   "Which movies are rated higher than 8.5?",
+ * );
+ * ```
  */
 class FunctionalTranslator extends base_js_1.BaseTranslator {
     constructor() {

package/dist/retrievers/self_query/functional.d.ts

@@ -22,6 +22,13 @@ export type FunctionFilter = (document: Document) => boolean;
 /**
  * A class that extends `BaseTranslator` to translate structured queries
  * into functional filters.
+ * @example
+ * ```typescript
+ * const functionalTranslator = new FunctionalTranslator();
+ * const relevantDocuments = await functionalTranslator.getRelevantDocuments(
+ *   "Which movies are rated higher than 8.5?",
+ * );
+ * ```
  */
 export declare class FunctionalTranslator extends BaseTranslator {
     VisitOperationOutput: FunctionFilter;

package/dist/retrievers/self_query/functional.js

@@ -4,6 +4,13 @@ import { castValue, isFilterEmpty } from "./utils.js";
 /**
  * A class that extends `BaseTranslator` to translate structured queries
  * into functional filters.
+ * @example
+ * ```typescript
+ * const functionalTranslator = new FunctionalTranslator();
+ * const relevantDocuments = await functionalTranslator.getRelevantDocuments(
+ *   "Which movies are rated higher than 8.5?",
+ * );
+ * ```
  */
 export class FunctionalTranslator extends BaseTranslator {
     constructor() {

package/dist/retrievers/self_query/index.cjs

@@ -12,6 +12,19 @@ Object.defineProperty(exports, "BasicTranslator", { enumerable: true, get: funct
  * Class for question answering over an index. It retrieves relevant
  * documents based on a query. It extends the BaseRetriever class and
  * implements the SelfQueryRetrieverArgs interface.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: attributeInfo,
+ *   structuredQueryTranslator: new FunctionalTranslator(),
+ * });
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 class SelfQueryRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {

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

@@ -28,6 +28,19 @@ export interface SelfQueryRetrieverArgs<T extends VectorStore> extends BaseRetri
  * Class for question answering over an index. It retrieves relevant
  * documents based on a query. It extends the BaseRetriever class and
  * implements the SelfQueryRetrieverArgs interface.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: attributeInfo,
+ *   structuredQueryTranslator: new FunctionalTranslator(),
+ * });
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export declare class SelfQueryRetriever<T extends VectorStore> extends BaseRetriever implements SelfQueryRetrieverArgs<T> {
     static lc_name(): string;

package/dist/retrievers/self_query/index.js

@@ -7,6 +7,19 @@ export { BaseTranslator, BasicTranslator, FunctionalTranslator };
  * Class for question answering over an index. It retrieves relevant
  * documents based on a query. It extends the BaseRetriever class and
  * implements the SelfQueryRetrieverArgs interface.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: attributeInfo,
+ *   structuredQueryTranslator: new FunctionalTranslator(),
+ * });
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export class SelfQueryRetriever extends BaseRetriever {
     static lc_name() {

package/dist/retrievers/self_query/pinecone.cjs

@@ -9,6 +9,20 @@ const base_js_1 = require("./base.cjs");
  * LangChain. The class is initialized with a set of allowed operators and
  * comparators, which are used in the translation process to construct
  * queries and compare results.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new PineconeStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new PineconeTranslator(),
+ * });
+ *
+ * const queryResult = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 class PineconeTranslator extends base_js_1.BasicTranslator {
     constructor() {

package/dist/retrievers/self_query/pinecone.d.ts

@@ -6,6 +6,20 @@ import { BasicTranslator } from "./base.js";
  * LangChain. The class is initialized with a set of allowed operators and
  * comparators, which are used in the translation process to construct
  * queries and compare results.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new PineconeStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new PineconeTranslator(),
+ * });
+ *
+ * const queryResult = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export declare class PineconeTranslator<T extends PineconeStore> extends BasicTranslator<T> {
     constructor();

package/dist/retrievers/self_query/pinecone.js

@@ -6,6 +6,20 @@ import { BasicTranslator } from "./base.js";
  * LangChain. The class is initialized with a set of allowed operators and
  * comparators, which are used in the translation process to construct
  * queries and compare results.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new PineconeStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new PineconeTranslator(),
+ * });
+ *
+ * const queryResult = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export class PineconeTranslator extends BasicTranslator {
     constructor() {

package/dist/retrievers/self_query/supabase.cjs

@@ -9,6 +9,20 @@ const supabase_utils_js_1 = require("./supabase_utils.cjs");
  * A specialized translator designed to work with Supabase, extending the
  * BaseTranslator class. It translates structured queries into a format
  * that can be understood by the Supabase database.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new SupabaseVectorStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new SupabaseTranslator(),
+ * });
+ *
+ * const queryResult = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 class SupabaseTranslator extends base_js_1.BaseTranslator {
     constructor() {

package/dist/retrievers/self_query/supabase.d.ts

@@ -17,6 +17,20 @@ type ValueType = {
  * A specialized translator designed to work with Supabase, extending the
  * BaseTranslator class. It translates structured queries into a format
  * that can be understood by the Supabase database.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new SupabaseVectorStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new SupabaseTranslator(),
+ * });
+ *
+ * const queryResult = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export declare class SupabaseTranslator<T extends SupabaseVectorStore> extends BaseTranslator<T> {
     VisitOperationOutput: SupabaseFilterRPCCall;

package/dist/retrievers/self_query/supabase.js

@@ -6,6 +6,20 @@ import { ProxyParamsDuplicator, convertObjectFilterToStructuredQuery, } from "./
  * A specialized translator designed to work with Supabase, extending the
  * BaseTranslator class. It translates structured queries into a format
  * that can be understood by the Supabase database.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new SupabaseVectorStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new SupabaseTranslator(),
+ * });
+ *
+ * const queryResult = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
  */
 export class SupabaseTranslator extends BaseTranslator {
     constructor() {

package/dist/retrievers/self_query/weaviate.cjs

@@ -8,6 +8,20 @@ const utils_js_1 = require("./utils.cjs");
  * A class that translates or converts data into a format that can be used
  * with Weaviate, a vector search engine. It extends the `BaseTranslator`
  * class and provides specific implementation for Weaviate.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new WeaviateStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new WeaviateTranslator(),
+ * });
+ *
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are rated higher than 8.5?",
+ * );
+ * ```
  */
 class WeaviateTranslator extends base_js_1.BaseTranslator {
     constructor() {

package/dist/retrievers/self_query/weaviate.d.ts

@@ -33,6 +33,20 @@ export type WeaviateStructuredQueryResult = {
  * A class that translates or converts data into a format that can be used
  * with Weaviate, a vector search engine. It extends the `BaseTranslator`
  * class and provides specific implementation for Weaviate.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new WeaviateStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new WeaviateTranslator(),
+ * });
+ *
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are rated higher than 8.5?",
+ * );
+ * ```
  */
 export declare class WeaviateTranslator<T extends WeaviateStore> extends BaseTranslator<T> {
     VisitOperationOutput: WeaviateOperationResult;

package/dist/retrievers/self_query/weaviate.js

@@ -5,6 +5,20 @@ import { isFilterEmpty, isString, isInt, isFloat } from "./utils.js";
  * A class that translates or converts data into a format that can be used
  * with Weaviate, a vector search engine. It extends the `BaseTranslator`
  * class and provides specific implementation for Weaviate.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = new SelfQueryRetriever({
+ *   llm: new ChatOpenAI(),
+ *   vectorStore: new WeaviateStore(),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: [],
+ *   structuredQueryTranslator: new WeaviateTranslator(),
+ * });
+ *
+ * const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
+ *   "Which movies are rated higher than 8.5?",
+ * );
+ * ```
  */
 export class WeaviateTranslator extends BaseTranslator {
     constructor() {

package/dist/retrievers/time_weighted.cjs

@@ -7,6 +7,22 @@ exports.BUFFER_IDX = "buffer_idx";
 /**
  * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.
  * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py
+ * @example
+ * ```typescript
+ * const retriever = new TimeWeightedVectorStoreRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   memoryStream: [],
+ *   searchKwargs: 2,
+ * });
+ * await retriever.addDocuments([
+ *   { pageContent: "My name is John.", metadata: {} },
+ *   { pageContent: "My favourite food is pizza.", metadata: {} },
+ *
+ * ]);
+ * const results = await retriever.getRelevantDocuments(
+ *   "What is my favourite food?",
+ * );
+ * ```
  */
 class TimeWeightedVectorStoreRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {

package/dist/retrievers/time_weighted.d.ts

@@ -20,6 +20,22 @@ export declare const BUFFER_IDX = "buffer_idx";
 /**
  * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.
  * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py
+ * @example
+ * ```typescript
+ * const retriever = new TimeWeightedVectorStoreRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   memoryStream: [],
+ *   searchKwargs: 2,
+ * });
+ * await retriever.addDocuments([
+ *   { pageContent: "My name is John.", metadata: {} },
+ *   { pageContent: "My favourite food is pizza.", metadata: {} },
+ *
+ * ]);
+ * const results = await retriever.getRelevantDocuments(
+ *   "What is my favourite food?",
+ * );
+ * ```
  */
 export declare class TimeWeightedVectorStoreRetriever extends BaseRetriever {
     static lc_name(): string;

package/dist/retrievers/time_weighted.js

@@ -4,6 +4,22 @@ export const BUFFER_IDX = "buffer_idx";
 /**
  * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.
  * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py
+ * @example
+ * ```typescript
+ * const retriever = new TimeWeightedVectorStoreRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   memoryStream: [],
+ *   searchKwargs: 2,
+ * });
+ * await retriever.addDocuments([
+ *   { pageContent: "My name is John.", metadata: {} },
+ *   { pageContent: "My favourite food is pizza.", metadata: {} },
+ *
+ * ]);
+ * const results = await retriever.getRelevantDocuments(
+ *   "What is my favourite food?",
+ * );
+ * ```
  */
 export class TimeWeightedVectorStoreRetriever extends BaseRetriever {
     static lc_name() {