langchain 0.0.130 → 0.0.132

package/dist/retrievers/hyde.cjs

@@ -4,7 +4,16 @@ 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";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "hyde"];
     }
@@ -49,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,16 +3,34 @@ 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[];
     llm: BaseLanguageModel;
     promptTemplate?: BasePromptTemplate;
     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,7 +1,16 @@
 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";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "hyde"];
     }
@@ -45,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,7 +3,17 @@ 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";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {

package/dist/retrievers/metal.d.ts

@@ -1,10 +1,23 @@
 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[];
     private client;
     constructor(fields: MetalRetrieverFields);

package/dist/retrievers/metal.js

@@ -1,6 +1,16 @@
 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";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {

package/dist/retrievers/parent_document.cjs

@@ -27,7 +27,19 @@ 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";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {
@@ -66,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) {

package/dist/retrievers/parent_document.d.ts

@@ -3,20 +3,36 @@ import { Document } from "../document.js";
 import { VectorStore } from "../vectorstores/base.js";
 import { Docstore } from "../schema/index.js";
 import { TextSplitter } from "../text_splitter.js";
+/**
+ * Interface for the fields required to initialize a
+ * ParentDocumentRetriever instance.
+ */
 export interface ParentDocumentRetrieverFields extends BaseRetrieverInput {
     vectorstore: VectorStore;
     docstore: Docstore;
     childSplitter: TextSplitter;
     parentSplitter?: TextSplitter;
     idKey?: string;
+    childK?: number;
 }
+/**
+ * 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.
+ */
 export declare class ParentDocumentRetriever extends BaseRetriever {
+    static lc_name(): string;
     lc_namespace: string[];
     protected vectorstore: VectorStore;
     protected docstore: Docstore;
     protected childSplitter: TextSplitter;
     protected parentSplitter?: TextSplitter;
     protected idKey: string;
+    protected childK?: number;
     constructor(fields: ParentDocumentRetrieverFields);
     _getRelevantDocuments(query: string): Promise<Document[]>;
     /**

package/dist/retrievers/parent_document.js

@@ -1,7 +1,19 @@
 import * as uuid from "uuid";
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * 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.
+ */
 export class ParentDocumentRetriever extends BaseRetriever {
+    static lc_name() {
+        return "ParentDocumentRetriever";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {
@@ -40,14 +52,21 @@ export class ParentDocumentRetriever extends 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) {

package/dist/retrievers/remote/base.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoteRetriever = void 0;
 const retriever_js_1 = require("../../schema/retriever.cjs");
 const async_caller_js_1 = require("../../util/async_caller.cjs");
+/**
+ * Abstract class for interacting with a remote server to retrieve
+ * relevant documents based on a given query.
+ */
 class RemoteRetriever extends retriever_js_1.BaseRetriever {
     get lc_secrets() {
         return {

package/dist/retrievers/remote/base.d.ts

@@ -1,10 +1,21 @@
 import { BaseRetriever, BaseRetrieverInput } from "../../schema/retriever.js";
 import { AsyncCaller, AsyncCallerParams } from "../../util/async_caller.js";
 import { Document } from "../../document.js";
+/**
+ * Type for the authentication method used by the RemoteRetriever. It can
+ * either be false (no authentication) or an object with a bearer token.
+ */
 export type RemoteRetrieverAuth = false | {
     bearer: string;
 };
+/**
+ * Type for the JSON response values from the remote server.
+ */
 export type RemoteRetrieverValues = Record<string, any>;
+/**
+ * Interface for the parameters required to initialize a RemoteRetriever
+ * instance.
+ */
 export interface RemoteRetrieverParams extends AsyncCallerParams, BaseRetrieverInput {
     /**
      * The URL of the remote retriever server
@@ -17,6 +28,10 @@ export interface RemoteRetrieverParams extends AsyncCallerParams, BaseRetrieverI
      */
     auth: RemoteRetrieverAuth;
 }
+/**
+ * Abstract class for interacting with a remote server to retrieve
+ * relevant documents based on a given query.
+ */
 export declare abstract class RemoteRetriever extends BaseRetriever implements RemoteRetrieverParams {
     get lc_secrets(): {
         [key: string]: string;
@@ -26,7 +41,20 @@ export declare abstract class RemoteRetriever extends BaseRetriever implements R
     headers: Record<string, string>;
     asyncCaller: AsyncCaller;
     constructor(fields: RemoteRetrieverParams);
+    /**
+     * Abstract method that should be implemented by subclasses to create the
+     * JSON body of the request based on the given query.
+     * @param query The query based on which the JSON body of the request is created.
+     * @returns The JSON body of the request.
+     */
     abstract createJsonBody(query: string): RemoteRetrieverValues;
+    /**
+     * Abstract method that should be implemented by subclasses to process the
+     * JSON response from the server and convert it into an array of Document
+     * instances.
+     * @param json The JSON response from the server.
+     * @returns An array of Document instances.
+     */
     abstract processJsonResponse(json: RemoteRetrieverValues): Document[];
     _getRelevantDocuments(query: string): Promise<Document[]>;
 }

package/dist/retrievers/remote/base.js

@@ -1,5 +1,9 @@
 import { BaseRetriever } from "../../schema/retriever.js";
 import { AsyncCaller } from "../../util/async_caller.js";
+/**
+ * Abstract class for interacting with a remote server to retrieve
+ * relevant documents based on a given query.
+ */
 export class RemoteRetriever extends BaseRetriever {
     get lc_secrets() {
         return {

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

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChatGPTPluginRetriever = void 0;
 const document_js_1 = require("../../document.cjs");
 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.
+ */
 class ChatGPTPluginRetriever extends base_js_1.RemoteRetriever {
     constructor({ topK = 4, filter, ...rest }) {
         super(rest);
@@ -27,6 +32,12 @@ class ChatGPTPluginRetriever extends base_js_1.RemoteRetriever {
         this.topK = topK;
         this.filter = filter;
     }
+    /**
+     * Creates a JSON body for the request to the ChatGPTRetrievalPlugin
+     * server.
+     * @param query The query to send to the server.
+     * @returns A JSON object representing the body of the request.
+     */
     createJsonBody(query) {
         return {
             queries: [
@@ -38,6 +49,12 @@ class ChatGPTPluginRetriever extends base_js_1.RemoteRetriever {
             ],
         };
     }
+    /**
+     * Processes the JSON response from the ChatGPTRetrievalPlugin server and
+     * returns an array of Document instances.
+     * @param json The JSON response from the server.
+     * @returns An array of Document instances.
+     */
     processJsonResponse(json) {
         const results = json?.results?.[0]?.results;
         if (!results) {

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

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { RemoteRetriever, RemoteRetrieverParams, RemoteRetrieverValues } from "./base.js";
+/**
+ * Interface for the filter parameters used when querying the
+ * ChatGPTRetrievalPlugin server.
+ */
 export interface ChatGPTPluginRetrieverFilter {
     document_id?: string;
     source?: string;
@@ -18,11 +22,28 @@ export interface ChatGPTPluginRetrieverParams extends RemoteRetrieverParams {
      */
     filter?: ChatGPTPluginRetrieverFilter;
 }
+/**
+ * Class that connects ChatGPT to third-party applications via plugins. It
+ * extends the RemoteRetriever class and implements the
+ * ChatGPTPluginRetrieverParams interface.
+ */
 export declare class ChatGPTPluginRetriever extends RemoteRetriever implements ChatGPTPluginRetrieverParams {
     lc_namespace: string[];
     topK: number;
     filter?: ChatGPTPluginRetrieverFilter;
     constructor({ topK, filter, ...rest }: ChatGPTPluginRetrieverParams);
+    /**
+     * Creates a JSON body for the request to the ChatGPTRetrievalPlugin
+     * server.
+     * @param query The query to send to the server.
+     * @returns A JSON object representing the body of the request.
+     */
     createJsonBody(query: string): RemoteRetrieverValues;
+    /**
+     * Processes the JSON response from the ChatGPTRetrievalPlugin server and
+     * returns an array of Document instances.
+     * @param json The JSON response from the server.
+     * @returns An array of Document instances.
+     */
     processJsonResponse(json: RemoteRetrieverValues): Document[];
 }

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

@@ -1,5 +1,10 @@
 import { Document } from "../../document.js";
 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.
+ */
 export class ChatGPTPluginRetriever extends RemoteRetriever {
     constructor({ topK = 4, filter, ...rest }) {
         super(rest);
@@ -24,6 +29,12 @@ export class ChatGPTPluginRetriever extends RemoteRetriever {
         this.topK = topK;
         this.filter = filter;
     }
+    /**
+     * Creates a JSON body for the request to the ChatGPTRetrievalPlugin
+     * server.
+     * @param query The query to send to the server.
+     * @returns A JSON object representing the body of the request.
+     */
     createJsonBody(query) {
         return {
             queries: [
@@ -35,6 +46,12 @@ export class ChatGPTPluginRetriever extends RemoteRetriever {
             ],
         };
     }
+    /**
+     * Processes the JSON response from the ChatGPTRetrievalPlugin server and
+     * returns an array of Document instances.
+     * @param json The JSON response from the server.
+     * @returns An array of Document instances.
+     */
     processJsonResponse(json) {
         const results = json?.results?.[0]?.results;
         if (!results) {

package/dist/retrievers/remote/remote-retriever.cjs

@@ -3,6 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoteLangChainRetriever = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * Specific implementation of the `RemoteRetriever` class designed to
+ * retrieve documents from a remote source using a JSON-based API. It
+ * implements the `RemoteLangChainRetrieverParams` interface which defines
+ * the keys used to interact with the JSON API.
+ */
 class RemoteLangChainRetriever extends base_js_1.RemoteRetriever {
     constructor({ inputKey = "message", responseKey = "response", pageContentKey = "page_content", metadataKey = "metadata", ...rest }) {
         super(rest);
@@ -41,11 +47,25 @@ class RemoteLangChainRetriever extends base_js_1.RemoteRetriever {
         this.pageContentKey = pageContentKey;
         this.metadataKey = metadataKey;
     }
+    /**
+     * Creates the JSON body of the request sent to the API. The `inputKey` is
+     * set to the query.
+     * @param query Query string to be sent to the API.
+     * @returns An object with the `inputKey` set to the query.
+     */
     createJsonBody(query) {
         return {
             [this.inputKey]: query,
         };
     }
+    /**
+     * Processes the JSON response from the API. It returns an array of
+     * `Document` objects, each created with the page content and metadata
+     * extracted from the response using the `pageContentKey` and
+     * `metadataKey`, respectively.
+     * @param json JSON response from the API.
+     * @returns An array of `Document` objects.
+     */
     processJsonResponse(json) {
         return json[this.responseKey].map(
         // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/retrievers/remote/remote-retriever.d.ts

@@ -18,6 +18,12 @@ export interface RemoteLangChainRetrieverParams extends RemoteRetrieverParams {
      */
     metadataKey?: string;
 }
+/**
+ * Specific implementation of the `RemoteRetriever` class designed to
+ * retrieve documents from a remote source using a JSON-based API. It
+ * implements the `RemoteLangChainRetrieverParams` interface which defines
+ * the keys used to interact with the JSON API.
+ */
 export declare class RemoteLangChainRetriever extends RemoteRetriever implements RemoteLangChainRetrieverParams {
     lc_namespace: string[];
     inputKey: string;
@@ -25,6 +31,20 @@ export declare class RemoteLangChainRetriever extends RemoteRetriever implements
     pageContentKey: string;
     metadataKey: string;
     constructor({ inputKey, responseKey, pageContentKey, metadataKey, ...rest }: RemoteLangChainRetrieverParams);
+    /**
+     * Creates the JSON body of the request sent to the API. The `inputKey` is
+     * set to the query.
+     * @param query Query string to be sent to the API.
+     * @returns An object with the `inputKey` set to the query.
+     */
     createJsonBody(query: string): RemoteRetrieverValues;
+    /**
+     * Processes the JSON response from the API. It returns an array of
+     * `Document` objects, each created with the page content and metadata
+     * extracted from the response using the `pageContentKey` and
+     * `metadataKey`, respectively.
+     * @param json JSON response from the API.
+     * @returns An array of `Document` objects.
+     */
     processJsonResponse(json: RemoteRetrieverValues): Document[];
 }

package/dist/retrievers/remote/remote-retriever.js

@@ -1,5 +1,11 @@
 import { Document } from "../../document.js";
 import { RemoteRetriever, } from "./base.js";
+/**
+ * Specific implementation of the `RemoteRetriever` class designed to
+ * retrieve documents from a remote source using a JSON-based API. It
+ * implements the `RemoteLangChainRetrieverParams` interface which defines
+ * the keys used to interact with the JSON API.
+ */
 export class RemoteLangChainRetriever extends RemoteRetriever {
     constructor({ inputKey = "message", responseKey = "response", pageContentKey = "page_content", metadataKey = "metadata", ...rest }) {
         super(rest);
@@ -38,11 +44,25 @@ export class RemoteLangChainRetriever extends RemoteRetriever {
         this.pageContentKey = pageContentKey;
         this.metadataKey = metadataKey;
     }
+    /**
+     * Creates the JSON body of the request sent to the API. The `inputKey` is
+     * set to the query.
+     * @param query Query string to be sent to the API.
+     * @returns An object with the `inputKey` set to the query.
+     */
     createJsonBody(query) {
         return {
             [this.inputKey]: query,
         };
     }
+    /**
+     * Processes the JSON response from the API. It returns an array of
+     * `Document` objects, each created with the page content and metadata
+     * extracted from the response using the `pageContentKey` and
+     * `metadataKey`, respectively.
+     * @param json JSON response from the API.
+     * @returns An array of `Document` objects.
+     */
     processJsonResponse(json) {
         return json[this.responseKey].map(
         // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/retrievers/self_query/base.cjs

@@ -3,9 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasicTranslator = exports.BaseTranslator = void 0;
 const ir_js_1 = require("../../chains/query_constructor/ir.cjs");
 const utils_js_1 = require("./utils.cjs");
+/**
+ * Abstract class that provides a blueprint for creating specific
+ * translator classes. Defines two abstract methods: formatFunction and
+ * mergeFilters.
+ */
 class BaseTranslator extends ir_js_1.Visitor {
 }
 exports.BaseTranslator = BaseTranslator;
+/**
+ * Class that extends the BaseTranslator class and provides concrete
+ * implementations for the abstract methods. Also declares three types:
+ * VisitOperationOutput, VisitComparisonOutput, and
+ * VisitStructuredQueryOutput, which are used as the return types for the
+ * visitOperation, visitComparison, and visitStructuredQuery methods
+ * respectively.
+ */
 class BasicTranslator extends BaseTranslator {
     constructor(opts) {
         super();
@@ -52,12 +65,22 @@ class BasicTranslator extends BaseTranslator {
         }
         return `$${func}`;
     }
+    /**
+     * Visits an operation and returns a result.
+     * @param operation The operation to visit.
+     * @returns The result of visiting the operation.
+     */
     visitOperation(operation) {
         const args = operation.args?.map((arg) => arg.accept(this));
         return {
             [this.formatFunction(operation.operator)]: args,
         };
     }
+    /**
+     * Visits a comparison and returns a result.
+     * @param comparison The comparison to visit.
+     * @returns The result of visiting the comparison.
+     */
     visitComparison(comparison) {
         return {
             [comparison.attribute]: {
@@ -65,6 +88,11 @@ class BasicTranslator extends BaseTranslator {
             },
         };
     }
+    /**
+     * Visits a structured query and returns a result.
+     * @param query The structured query to visit.
+     * @returns The result of visiting the structured query.
+     */
     visitStructuredQuery(query) {
         let nextArg = {};
         if (query.filter) {