@langchain/google-cloud-sql-pg 0.0.2 → 1.0.1

package/dist/vectorstore.d.ts

@@ -1,41 +1,43 @@
-import { EmbeddingsInterface } from "@langchain/core/embeddings";
+import { PostgresEngine } from "./engine.js";
+import { BaseIndex, DistanceStrategy, QueryOptions } from "./indexes.js";
 import { MaxMarginalRelevanceSearchOptions, VectorStore } from "@langchain/core/vectorstores";
 import { Document } from "@langchain/core/documents";
-import { BaseIndex, DistanceStrategy, QueryOptions } from "./indexes.js";
-import PostgresEngine from "./engine.js";
-export interface PostgresVectorStoreArgs {
-    schemaName?: string;
-    contentColumn?: string;
-    embeddingColumn?: string;
-    metadataColumns?: Array<string>;
-    idColumn?: string;
-    distanceStrategy?: DistanceStrategy;
-    k?: number;
-    fetchK?: number;
-    lambdaMult?: number;
-    ignoreMetadataColumns?: Array<string>;
-    metadataJsonColumn?: string;
-    indexQueryOptions?: QueryOptions;
+import { EmbeddingsInterface } from "@langchain/core/embeddings";
+
+//#region src/vectorstore.d.ts
+interface PostgresVectorStoreArgs {
+  schemaName?: string;
+  contentColumn?: string;
+  embeddingColumn?: string;
+  metadataColumns?: Array<string>;
+  idColumn?: string;
+  distanceStrategy?: DistanceStrategy;
+  k?: number;
+  fetchK?: number;
+  lambdaMult?: number;
+  ignoreMetadataColumns?: Array<string>;
+  metadataJsonColumn?: string;
+  indexQueryOptions?: QueryOptions;
 }
-export interface dbConfigArgs {
-    engine: PostgresEngine;
-    tableName: string;
-    dbConfig?: PostgresVectorStoreArgs;
+interface dbConfigArgs {
+  engine: PostgresEngine;
+  tableName: string;
+  dbConfig?: PostgresVectorStoreArgs;
 }
 interface VSArgs {
-    engine: PostgresEngine;
-    tableName: string;
-    schemaName: string;
-    contentColumn: string;
-    embeddingColumn: string;
-    metadataColumns: Array<string>;
-    idColumn: string;
-    distanceStrategy: DistanceStrategy;
-    k: number;
-    fetchK: number;
-    lambdaMult: number;
-    metadataJsonColumn: string;
-    indexQueryOptions?: QueryOptions;
+  engine: PostgresEngine;
+  tableName: string;
+  schemaName: string;
+  contentColumn: string;
+  embeddingColumn: string;
+  metadataColumns: Array<string>;
+  idColumn: string;
+  distanceStrategy: DistanceStrategy;
+  k: number;
+  fetchK: number;
+  lambdaMult: number;
+  metadataJsonColumn: string;
+  indexQueryOptions?: QueryOptions;
 }
 /**
  * Google Cloud SQL for PostgreSQL vector store integration.
@@ -183,101 +185,116 @@ interface VSArgs {
  *
  * <br />
  */
-export declare class PostgresVectorStore extends VectorStore {
-    FilterType: string;
-    engine: PostgresEngine;
-    embeddings: EmbeddingsInterface;
-    tableName: string;
-    schemaName: string;
-    contentColumn: string;
-    embeddingColumn: string;
-    metadataColumns: Array<string>;
-    idColumn: string;
-    metadataJsonColumn: string;
-    distanceStrategy: DistanceStrategy;
-    k: number;
-    fetchK: number;
-    lambdaMult: number;
-    indexQueryOptions: QueryOptions | undefined;
-    /**
-     * Initializes a new vector store with embeddings and database configuration.
-     *
-     * @param embeddings - Instance of `EmbeddingsInterface` used to embed queries.
-     * @param dbConfig - Configuration settings for the database or storage system.
-     */
-    constructor(embeddings: EmbeddingsInterface, dbConfig: VSArgs);
-    /**
-     * Create a new PostgresVectorStore instance.
-     * @param {PostgresEngine} engine Required - Connection pool engine for managing connections to Cloud SQL for PostgreSQL database.
-     * @param {Embeddings} embeddings Required - Text embedding model to use.
-     * @param {string} tableName Required - Name of an existing table or table to be created.
-     * @param {string} schemaName Database schema name of the table. Defaults to "public".
-     * @param {string} contentColumn Column that represent a Document's page_content. Defaults to "content".
-     * @param {string} embeddingColumn Column for embedding vectors. The embedding is generated from the document value. Defaults to "embedding".
-     * @param {Array<string>} metadataColumns Column(s) that represent a document's metadata.
-     * @param {Array<string>} ignoreMetadataColumns Optional - Column(s) to ignore in pre-existing tables for a document's metadata. Can not be used with metadata_columns.
-     * @param {string} idColumn Column that represents the Document's id. Defaults to "langchain_id".
-     * @param {string} metadataJsonColumn Optional - Column to store metadata as JSON. Defaults to "langchain_metadata".
-     * @param {DistanceStrategy} distanceStrategy Distance strategy to use for vector similarity search. Defaults to COSINE_DISTANCE.
-     * @param {number} k Number of Documents to return from search. Defaults to 4.
-     * @param {number} fetchK Number of Documents to fetch to pass to MMR algorithm.
-     * @param {number} lambdaMult Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
-     * @param {QueryOptions} indexQueryOptions Optional - Index query option.
-     * @returns PostgresVectorStore instance.
-     */
-    static initialize(engine: PostgresEngine, embeddings: EmbeddingsInterface, tableName: string, { schemaName, contentColumn, embeddingColumn, metadataColumns, ignoreMetadataColumns, idColumn, metadataJsonColumn, distanceStrategy, k, fetchK, lambdaMult, indexQueryOptions, }?: PostgresVectorStoreArgs): Promise<PostgresVectorStore>;
-    static fromTexts(texts: string[], metadatas: object[] | object, embeddings: EmbeddingsInterface, dbConfig: dbConfigArgs): Promise<VectorStore>;
-    static fromDocuments(docs: Document[], embeddings: EmbeddingsInterface, dbConfig: dbConfigArgs): Promise<VectorStore>;
-    addVectors(vectors: number[][], documents: Document[], options?: {
-        ids?: string[];
-    }): Promise<string[] | void>;
-    _vectorstoreType(): string;
-    /**
-     * Adds documents to the vector store, embedding them first through the
-     * `embeddings` instance.
-     *
-     * @param documents - Array of documents to embed and add.
-     * @param options - Optional configuration for embedding and storing documents.
-     * @returns A promise resolving to an array of document IDs or void, based on implementation.
-     * @abstract
-     */
-    addDocuments(documents: Document[], options?: {
-        ids?: string[];
-    }): Promise<string[] | void>;
-    /**
-     * Deletes documents from the vector store based on the specified ids.
-     *
-     * @param params - Flexible key-value pairs defining conditions for document deletion.
-     * @param ids -  Optional: Property of {params} that contains the array of ids to be deleted
-     * @returns A promise that resolves once the deletion is complete.
-     */
-    delete(params: {
-        ids?: string[];
-    }): Promise<void>;
-    similaritySearchVectorWithScore(embedding: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
-    private queryCollection;
-    maxMarginalRelevanceSearch(query: string, options: MaxMarginalRelevanceSearchOptions<this["FilterType"]>): Promise<Document[]>;
-    /**
-     * Create an index on the vector store table
-     * @param {BaseIndex} index
-     * @param {string} name Optional
-     * @param {boolean} concurrently Optional
-     */
-    applyVectorIndex(index: BaseIndex, name?: string, concurrently?: boolean): Promise<void>;
-    /**
-     * Check if index exists in the table.
-     * @param {string} indexName Optional - index name
-     */
-    isValidIndex(indexName?: string): Promise<boolean>;
-    /**
-     * Drop the vector index
-     * @param {string} indexName Optional - index name
-     */
-    dropVectorIndex(indexName?: string): Promise<void>;
-    /**
-     * Re-index the vector store table
-     * @param {string} indexName Optional - index name
-     */
-    reIndex(indexName?: string): Promise<void>;
+declare class PostgresVectorStore extends VectorStore {
+  FilterType: string;
+  engine: PostgresEngine;
+  embeddings: EmbeddingsInterface;
+  tableName: string;
+  schemaName: string;
+  contentColumn: string;
+  embeddingColumn: string;
+  metadataColumns: Array<string>;
+  idColumn: string;
+  metadataJsonColumn: string;
+  distanceStrategy: DistanceStrategy;
+  k: number;
+  fetchK: number;
+  lambdaMult: number;
+  indexQueryOptions: QueryOptions | undefined;
+  /**
+   * Initializes a new vector store with embeddings and database configuration.
+   *
+   * @param embeddings - Instance of `EmbeddingsInterface` used to embed queries.
+   * @param dbConfig - Configuration settings for the database or storage system.
+   */
+  constructor(embeddings: EmbeddingsInterface, dbConfig: VSArgs);
+  /**
+   * Create a new PostgresVectorStore instance.
+   * @param {PostgresEngine} engine Required - Connection pool engine for managing connections to Cloud SQL for PostgreSQL database.
+   * @param {Embeddings} embeddings Required - Text embedding model to use.
+   * @param {string} tableName Required - Name of an existing table or table to be created.
+   * @param {string} schemaName Database schema name of the table. Defaults to "public".
+   * @param {string} contentColumn Column that represent a Document's page_content. Defaults to "content".
+   * @param {string} embeddingColumn Column for embedding vectors. The embedding is generated from the document value. Defaults to "embedding".
+   * @param {Array<string>} metadataColumns Column(s) that represent a document's metadata.
+   * @param {Array<string>} ignoreMetadataColumns Optional - Column(s) to ignore in pre-existing tables for a document's metadata. Can not be used with metadata_columns.
+   * @param {string} idColumn Column that represents the Document's id. Defaults to "langchain_id".
+   * @param {string} metadataJsonColumn Optional - Column to store metadata as JSON. Defaults to "langchain_metadata".
+   * @param {DistanceStrategy} distanceStrategy Distance strategy to use for vector similarity search. Defaults to COSINE_DISTANCE.
+   * @param {number} k Number of Documents to return from search. Defaults to 4.
+   * @param {number} fetchK Number of Documents to fetch to pass to MMR algorithm.
+   * @param {number} lambdaMult Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
+   * @param {QueryOptions} indexQueryOptions Optional - Index query option.
+   * @returns PostgresVectorStore instance.
+   */
+  static initialize(engine: PostgresEngine, embeddings: EmbeddingsInterface, tableName: string, {
+    schemaName,
+    contentColumn,
+    embeddingColumn,
+    metadataColumns,
+    ignoreMetadataColumns,
+    idColumn,
+    metadataJsonColumn,
+    distanceStrategy,
+    k,
+    fetchK,
+    lambdaMult,
+    indexQueryOptions
+  }?: PostgresVectorStoreArgs): Promise<PostgresVectorStore>;
+  static fromTexts(texts: string[], metadatas: object[] | object, embeddings: EmbeddingsInterface, dbConfig: dbConfigArgs): Promise<VectorStore>;
+  static fromDocuments(docs: Document[], embeddings: EmbeddingsInterface, dbConfig: dbConfigArgs): Promise<VectorStore>;
+  addVectors(vectors: number[][], documents: Document[], options?: {
+    ids?: string[];
+  }): Promise<string[] | void>;
+  _vectorstoreType(): string;
+  /**
+   * Adds documents to the vector store, embedding them first through the
+   * `embeddings` instance.
+   *
+   * @param documents - Array of documents to embed and add.
+   * @param options - Optional configuration for embedding and storing documents.
+   * @returns A promise resolving to an array of document IDs or void, based on implementation.
+   * @abstract
+   */
+  addDocuments(documents: Document[], options?: {
+    ids?: string[];
+  }): Promise<string[] | void>;
+  /**
+   * Deletes documents from the vector store based on the specified ids.
+   *
+   * @param params - Flexible key-value pairs defining conditions for document deletion.
+   * @param ids -  Optional: Property of {params} that contains the array of ids to be deleted
+   * @returns A promise that resolves once the deletion is complete.
+   */
+  delete(params: {
+    ids?: string[];
+  }): Promise<void>;
+  similaritySearchVectorWithScore(embedding: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
+  private queryCollection;
+  maxMarginalRelevanceSearch(query: string, options: MaxMarginalRelevanceSearchOptions<this["FilterType"]>): Promise<Document[]>;
+  /**
+   * Create an index on the vector store table
+   * @param {BaseIndex} index
+   * @param {string} name Optional
+   * @param {boolean} concurrently Optional
+   */
+  applyVectorIndex(index: BaseIndex, name?: string, concurrently?: boolean): Promise<void>;
+  /**
+   * Check if index exists in the table.
+   * @param {string} indexName Optional - index name
+   */
+  isValidIndex(indexName?: string): Promise<boolean>;
+  /**
+   * Drop the vector index
+   * @param {string} indexName Optional - index name
+   */
+  dropVectorIndex(indexName?: string): Promise<void>;
+  /**
+   * Re-index the vector store table
+   * @param {string} indexName Optional - index name
+   */
+  reIndex(indexName?: string): Promise<void>;
 }
-export default PostgresVectorStore;
+//#endregion
+export { PostgresVectorStore, PostgresVectorStoreArgs, dbConfigArgs };
+//# sourceMappingURL=vectorstore.d.ts.map