langchain 0.0.169 → 0.0.171

package/dist/types/assemblyai-types.js

@@ -1,149 +1 @@
-/**
- * The list of PII Redaction policies to enable.
- * See [PII redaction]{@link https://www.assemblyai.com/docs/Models/pii_redaction} for more details.
- */
-export const PiiPolicy = {
-    /**
-     * Medical process, including treatments, procedures, and tests (e.g., heart surgery, CT scan)
-     */
-    MedicalProcess: "medical_process",
-    /**
-     * Name of a medical condition, disease, syndrome, deficit, or disorder (e.g., chronic fatigue syndrome, arrhythmia, depression)
-     */
-    MedicalCondition: "medical_condition",
-    /**
-     * Blood type (e.g., O-, AB positive)
-     */
-    BloodType: "blood_type",
-    /**
-     * Medications, vitamins, or supplements (e.g., Advil, Acetaminophen, Panadol)
-     */
-    Drug: "drug",
-    /**
-     * Bodily injury (e.g., I broke my arm, I have a sprained wrist)
-     */
-    Injury: "injury",
-    /**
-     * A "lazy" rule that will redact any sequence of numbers equal to or greater than 2
-     */
-    NumberSequence: "number_sequence",
-    /**
-     * Email address (e.g., support@assemblyai.com)
-     */
-    EmailAddress: "email_address",
-    /**
-     * Date of Birth (e.g., Date of Birth: March 7,1961)
-     */
-    DateOfBirth: "date_of_birth",
-    /**
-     * Telephone or fax number
-     */
-    PhoneNumber: "phone_number",
-    /**
-     * Social Security Number or equivalent
-     */
-    UsSocialSecurityNumber: "us_social_security_number",
-    /**
-     * Credit card number
-     */
-    CreditCardNumber: "credit_card_number",
-    /**
-     * Expiration date of a credit card
-     */
-    CreditCardExpiration: "credit_card_expiration",
-    /**
-     * Credit card verification code (e.g., CVV: 080)
-     */
-    CreditCardCvv: "credit_card_cvv",
-    /**
-     * Specific calendar date (e.g., December 18)
-     */
-    Date: "date",
-    /**
-     * Terms indicating nationality, ethnicity, or race (e.g., American, Asian, Caucasian)
-     */
-    Nationality: "nationality",
-    /**
-     * Name of an event or holiday (e.g., Olympics, Yom Kippur)
-     */
-    Event: "event",
-    /**
-     * Name of a natural language (e.g., Spanish, French)
-     */
-    Language: "language",
-    /**
-     * Any Location reference including mailing address, postal code, city, state, province, or country
-     */
-    Location: "location",
-    /**
-     * Name and/or amount of currency (e.g., 15 pesos, $94.50)
-     */
-    MoneyAmount: "money_amount",
-    /**
-     * Name of a person (e.g., Bob, Doug Jones)
-     */
-    PersonName: "person_name",
-    /**
-     * Number associated with an age (e.g., 27, 75)
-     */
-    PersonAge: "person_age",
-    /**
-     * Name of an organization (e.g., CNN, McDonalds, University of Alaska)
-     */
-    Organization: "organization",
-    /**
-     * Terms referring to a political party, movement, or ideology (e.g., Republican, Liberal)
-     */
-    PoliticalAffiliation: "political_affiliation",
-    /**
-     * Job title or profession (e.g., professor, actors, engineer, CPA)
-     */
-    Occupation: "occupation",
-    /**
-     * Terms indicating religious affiliation (e.g., Hindu, Catholic)
-     */
-    Religion: "religion",
-    /**
-     * Driver’s license number (e.g., DL# 356933-540)
-     */
-    DriversLicense: "drivers_license",
-    /**
-     * Banking information, including account and routing numbers
-     */
-    BankingInformation: "banking_information",
-};
-export const EntityType = {
-    BloodType: "Blood type (e.g., O-, AB positive)",
-    CreditCardCvv: "Credit card verification code (e.g., CVV: 080)",
-    CreditCardExpiration: "Expiration date of a credit card",
-    CreditCardNumber: "Credit card number",
-    Date: "Specific calendar date (e.g., December 18)",
-    DateOfBirth: "Date of Birth (e.g., Date of Birth: March 7, 1961)",
-    Drug: "Medications, vitamins, or supplements (e.g., Advil, Acetaminophen, Panadol)",
-    Event: "Name of an event or holiday (e.g., Olympics, Yom Kippur)",
-    EmailAddress: "Email address (e.g., support@assemblyai.com)",
-    Injury: "Bodily injury (e.g., I broke my arm, I have a sprained wrist)",
-    Language: "Name of a natural language (e.g., Spanish, French)",
-    Location: "Any location reference including mailing address, postal code, city, state, province, or country",
-    MedicalCondition: "Name of a medical condition, disease, syndrome, deficit, or disorder (e.g., chronic fatigue syndrome, arrhythmia, depression)",
-    MedicalProcess: "Medical process, including treatments, procedures, and tests (e.g., heart surgery, CT scan)",
-    MoneyAmount: "Name and/or amount of currency (e.g., 15 pesos, $94.50)",
-    Nationality: "Terms indicating nationality, ethnicity, or race (e.g., American, Asian, Caucasian)",
-    Occupation: "Job title or profession (e.g., professor, actors, engineer, CPA)",
-    Organization: "Name of an organization (e.g., CNN, McDonalds, University of Alaska)",
-    PersonAge: "Number associated with an age (e.g., 27, 75)",
-    PersonName: "Name of a person (e.g., Bob, Doug Jones)",
-    PhoneNumber: "Telephone or fax number",
-    PoliticalAffiliation: "Terms referring to a political party, movement, or ideology (e.g., Republican, Liberal)",
-    Religion: "Terms indicating religious affiliation (e.g., Hindu, Catholic)",
-    UsSocialSecurityNumber: "Social Security Number or equivalent",
-    DriversLicense: "Driver's license number (e.g., DL #356933-540)",
-    BankingInformation: "Banking information, including account and routing numbers",
-};
-/**
- * The format of the subtitles.
- */
-export const SubtitleFormat = {
-    Srt: "srt",
-    Vtt: "vtt",
-};
+export {};

package/dist/util/stream.cjs

@@ -62,6 +62,9 @@ class IterableReadableStream extends ReadableStream {
                     });
                 }
             },
+            cancel() {
+                reader.releaseLock();
+            },
         });
     }
     static fromAsyncGenerator(generator) {

package/dist/util/stream.js

@@ -59,6 +59,9 @@ export class IterableReadableStream extends ReadableStream {
                     });
                 }
             },
+            cancel() {
+                reader.releaseLock();
+            },
         });
     }
     static fromAsyncGenerator(generator) {

package/dist/vectorstores/cassandra.cjs

@@ -53,6 +53,12 @@ class CassandraStore extends base_js_1.VectorStore {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "indices", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "isInitialized", {
             enumerable: true,
             configurable: true,
@@ -65,6 +71,7 @@ class CassandraStore extends base_js_1.VectorStore {
         this.table = args.table;
         this.primaryKey = args.primaryKey;
         this.metadataColumns = args.metadataColumns;
+        this.indices = args.indices;
     }
     /**
      * Method to save vectors to the Cassandra database.
@@ -94,13 +101,14 @@ class CassandraStore extends base_js_1.VectorStore {
      * Method to search for vectors that are similar to a given query vector.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
      */
-    async similaritySearchVectorWithScore(query, k) {
+    async similaritySearchVectorWithScore(query, k, filter) {
         if (!this.isInitialized) {
             await this.initialize();
         }
-        const queryStr = this.buildSearchQuery(query, k);
+        const queryStr = this.buildSearchQuery(query, k, filter);
         const queryResultSet = await this.client.execute(queryStr);
         return queryResultSet?.rows.map((row, index) => {
             const textContent = row.text;
@@ -173,6 +181,11 @@ class CassandraStore extends base_js_1.VectorStore {
         await this.client
             .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_vector_${this.table}
   ON ${this.keyspace}.${this.table}(vector) USING 'StorageAttachedIndex';`);
+        for await (const { name, value } of this.indices) {
+            await this.client
+                .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_${this.table}_${name}
+  ON ${this.keyspace}.${this.table} ${value} USING 'StorageAttachedIndex';`);
+        }
         this.isInitialized = true;
     }
     /**
@@ -200,15 +213,23 @@ class CassandraStore extends base_js_1.VectorStore {
         }
         return queries;
     }
+    buildWhereClause(filter) {
+        const whereClause = Object.entries(filter)
+            .map(([key, value]) => `${key} = '${value}'`)
+            .join(" AND ");
+        return `WHERE ${whereClause}`;
+    }
     /**
      * Method to build an CQL query for searching for similar vectors in the
      * Cassandra database.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns The CQL query string.
      */
-    buildSearchQuery(query, k) {
-        return `SELECT * FROM ${this.keyspace}.${this.table} ORDER BY vector ANN OF [${query}] LIMIT ${k || 1};`;
+    buildSearchQuery(query, k = 1, filter = undefined) {
+        const whereClause = filter ? this.buildWhereClause(filter) : "";
+        return `SELECT * FROM ${this.keyspace}.${this.table} ${whereClause} ORDER BY vector ANN OF [${query}] LIMIT ${k}`;
     }
 }
 exports.CassandraStore = CassandraStore;

package/dist/vectorstores/cassandra.d.ts

@@ -6,12 +6,17 @@ export interface Column {
     type: string;
     name: string;
 }
+export interface Index {
+    name: string;
+    value: string;
+}
 export interface CassandraLibArgs extends DseClientOptions {
     table: string;
     keyspace: string;
     dimensions: number;
     primaryKey: Column;
     metadataColumns: Column[];
+    indices: Index[];
 }
 /**
  * Class for interacting with the Cassandra database. It extends the
@@ -20,12 +25,14 @@ export interface CassandraLibArgs extends DseClientOptions {
  * texts or documents.
  */
 export declare class CassandraStore extends VectorStore {
+    FilterType: Record<string, any>;
     private client;
     private readonly dimensions;
     private readonly keyspace;
     private primaryKey;
     private metadataColumns;
     private readonly table;
+    private indices;
     private isInitialized;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: CassandraLibArgs);
@@ -46,9 +53,10 @@ export declare class CassandraStore extends VectorStore {
      * Method to search for vectors that are similar to a given query vector.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
      */
-    similaritySearchVectorWithScore(query: number[], k: number): Promise<[Document, number][]>;
+    similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
     /**
      * Static method to create an instance of CassandraStore from texts.
      * @param texts The texts to use.
@@ -87,11 +95,13 @@ export declare class CassandraStore extends VectorStore {
      * @returns The CQL query string.
      */
     private buildInsertQuery;
+    private buildWhereClause;
     /**
      * Method to build an CQL query for searching for similar vectors in the
      * Cassandra database.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns The CQL query string.
      */
     private buildSearchQuery;

package/dist/vectorstores/cassandra.js

@@ -50,6 +50,12 @@ export class CassandraStore extends VectorStore {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "indices", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "isInitialized", {
             enumerable: true,
             configurable: true,
@@ -62,6 +68,7 @@ export class CassandraStore extends VectorStore {
         this.table = args.table;
         this.primaryKey = args.primaryKey;
         this.metadataColumns = args.metadataColumns;
+        this.indices = args.indices;
     }
     /**
      * Method to save vectors to the Cassandra database.
@@ -91,13 +98,14 @@ export class CassandraStore extends VectorStore {
      * Method to search for vectors that are similar to a given query vector.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
      */
-    async similaritySearchVectorWithScore(query, k) {
+    async similaritySearchVectorWithScore(query, k, filter) {
         if (!this.isInitialized) {
             await this.initialize();
         }
-        const queryStr = this.buildSearchQuery(query, k);
+        const queryStr = this.buildSearchQuery(query, k, filter);
         const queryResultSet = await this.client.execute(queryStr);
         return queryResultSet?.rows.map((row, index) => {
             const textContent = row.text;
@@ -170,6 +178,11 @@ export class CassandraStore extends VectorStore {
         await this.client
             .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_vector_${this.table}
   ON ${this.keyspace}.${this.table}(vector) USING 'StorageAttachedIndex';`);
+        for await (const { name, value } of this.indices) {
+            await this.client
+                .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_${this.table}_${name}
+  ON ${this.keyspace}.${this.table} ${value} USING 'StorageAttachedIndex';`);
+        }
         this.isInitialized = true;
     }
     /**
@@ -197,14 +210,22 @@ export class CassandraStore extends VectorStore {
         }
         return queries;
     }
+    buildWhereClause(filter) {
+        const whereClause = Object.entries(filter)
+            .map(([key, value]) => `${key} = '${value}'`)
+            .join(" AND ");
+        return `WHERE ${whereClause}`;
+    }
     /**
      * Method to build an CQL query for searching for similar vectors in the
      * Cassandra database.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns The CQL query string.
      */
-    buildSearchQuery(query, k) {
-        return `SELECT * FROM ${this.keyspace}.${this.table} ORDER BY vector ANN OF [${query}] LIMIT ${k || 1};`;
+    buildSearchQuery(query, k = 1, filter = undefined) {
+        const whereClause = filter ? this.buildWhereClause(filter) : "";
+        return `SELECT * FROM ${this.keyspace}.${this.table} ${whereClause} ORDER BY vector ANN OF [${query}] LIMIT ${k}`;
     }
 }

package/dist/vectorstores/momento_vector_index.cjs

@@ -104,16 +104,6 @@ class MomentoVectorIndex extends base_js_1.VectorStore {
             throw new Error(`Unknown response type: ${response.toString()}`);
         }
     }
-    /**
-     * Converts the metadata to a format that can be stored in the index.
-     *
-     * @remarks stringifies all values in the metadata object
-     * @param metadata The metadata to convert.
-     * @returns The converted metadata.
-     */
-    static prepareMetadata(metadata) {
-        return Object.fromEntries(Object.entries(metadata).map(([key, val]) => [key, JSON.stringify(val)]));
-    }
     /**
      * Converts the documents to a format that can be stored in the index.
      *
@@ -129,7 +119,7 @@ class MomentoVectorIndex extends base_js_1.VectorStore {
             id: ids[idx],
             vector,
             metadata: {
-                ...MomentoVectorIndex.prepareMetadata(documents[idx].metadata),
+                ...documents[idx].metadata,
                 [this.textField]: documents[idx].pageContent,
             },
         }));
@@ -231,10 +221,8 @@ class MomentoVectorIndex extends base_js_1.VectorStore {
             }
             return response.hits().map((hit) => [
                 new document_js_1.Document({
-                    pageContent: hit.metadata[this.textField] ?? "",
-                    metadata: Object.fromEntries(Object.entries(hit.metadata)
-                        .filter(([key]) => key !== this.textField)
-                        .map(([key, val]) => [key, JSON.parse(val)])),
+                    pageContent: hit.metadata[this.textField]?.toString() ?? "",
+                    metadata: Object.fromEntries(Object.entries(hit.metadata).filter(([key]) => key !== this.textField)),
                 }),
                 hit.distance,
             ]);

package/dist/vectorstores/momento_vector_index.d.ts

@@ -61,14 +61,6 @@ export declare class MomentoVectorIndex extends VectorStore {
      * @returns Promise that resolves to true if the index was created, false if it already existed.
      */
     private ensureIndexExists;
-    /**
-     * Converts the metadata to a format that can be stored in the index.
-     *
-     * @remarks stringifies all values in the metadata object
-     * @param metadata The metadata to convert.
-     * @returns The converted metadata.
-     */
-    private static prepareMetadata;
     /**
      * Converts the documents to a format that can be stored in the index.
      *

package/dist/vectorstores/momento_vector_index.js

@@ -78,16 +78,6 @@ export class MomentoVectorIndex extends VectorStore {
             throw new Error(`Unknown response type: ${response.toString()}`);
         }
     }
-    /**
-     * Converts the metadata to a format that can be stored in the index.
-     *
-     * @remarks stringifies all values in the metadata object
-     * @param metadata The metadata to convert.
-     * @returns The converted metadata.
-     */
-    static prepareMetadata(metadata) {
-        return Object.fromEntries(Object.entries(metadata).map(([key, val]) => [key, JSON.stringify(val)]));
-    }
     /**
      * Converts the documents to a format that can be stored in the index.
      *
@@ -103,7 +93,7 @@ export class MomentoVectorIndex extends VectorStore {
             id: ids[idx],
             vector,
             metadata: {
-                ...MomentoVectorIndex.prepareMetadata(documents[idx].metadata),
+                ...documents[idx].metadata,
                 [this.textField]: documents[idx].pageContent,
             },
         }));
@@ -205,10 +195,8 @@ export class MomentoVectorIndex extends VectorStore {
             }
             return response.hits().map((hit) => [
                 new Document({
-                    pageContent: hit.metadata[this.textField] ?? "",
-                    metadata: Object.fromEntries(Object.entries(hit.metadata)
-                        .filter(([key]) => key !== this.textField)
-                        .map(([key, val]) => [key, JSON.parse(val)])),
+                    pageContent: hit.metadata[this.textField]?.toString() ?? "",
+                    metadata: Object.fromEntries(Object.entries(hit.metadata).filter(([key]) => key !== this.textField)),
                 }),
                 hit.distance,
             ]);

package/dist/vectorstores/neo4j_vector.cjs

@@ -33,6 +33,20 @@ const document_js_1 = require("../document.cjs");
 const base_js_1 = require("./base.cjs");
 const DEFAULT_SEARCH_TYPE = "vector";
 const DEFAULT_DISTANCE_STRATEGY = "cosine";
+/**
+ * @security *Security note*: Make sure that the database connection uses credentials
+ * that are narrowly-scoped to only include necessary permissions.
+ * Failure to do so may result in data corruption or loss, since the calling
+ * code may attempt commands that would result in deletion, mutation
+ * of data if appropriately prompted or reading sensitive data if such
+ * data is present in the database.
+ * The best way to guard against such negative outcomes is to (as appropriate)
+ * limit the permissions granted to the credentials used with this tool.
+ * For example, creating read only users for the database is a good way to
+ * ensure that the calling code cannot mutate or delete data.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
+ */
 class Neo4jVectorStore extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "neo4jvector";

package/dist/vectorstores/neo4j_vector.d.ts

@@ -19,6 +19,20 @@ interface Neo4jVectorStoreArgs {
     nodeLabel?: string;
     createIdIndex?: boolean;
 }
+/**
+ * @security *Security note*: Make sure that the database connection uses credentials
+ * that are narrowly-scoped to only include necessary permissions.
+ * Failure to do so may result in data corruption or loss, since the calling
+ * code may attempt commands that would result in deletion, mutation
+ * of data if appropriately prompted or reading sensitive data if such
+ * data is present in the database.
+ * The best way to guard against such negative outcomes is to (as appropriate)
+ * limit the permissions granted to the credentials used with this tool.
+ * For example, creating read only users for the database is a good way to
+ * ensure that the calling code cannot mutate or delete data.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
+ */
 export declare class Neo4jVectorStore extends VectorStore {
     private driver;
     private database;

package/dist/vectorstores/neo4j_vector.js

@@ -4,6 +4,20 @@ import { Document } from "../document.js";
 import { VectorStore } from "./base.js";
 const DEFAULT_SEARCH_TYPE = "vector";
 const DEFAULT_DISTANCE_STRATEGY = "cosine";
+/**
+ * @security *Security note*: Make sure that the database connection uses credentials
+ * that are narrowly-scoped to only include necessary permissions.
+ * Failure to do so may result in data corruption or loss, since the calling
+ * code may attempt commands that would result in deletion, mutation
+ * of data if appropriately prompted or reading sensitive data if such
+ * data is present in the database.
+ * The best way to guard against such negative outcomes is to (as appropriate)
+ * limit the permissions granted to the credentials used with this tool.
+ * For example, creating read only users for the database is a good way to
+ * ensure that the calling code cannot mutate or delete data.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
+ */
 export class Neo4jVectorStore extends VectorStore {
     _vectorstoreType() {
         return "neo4jvector";

package/dist/vectorstores/pgvector.cjs

@@ -193,7 +193,7 @@ class PGVectorStore extends base_js_1.VectorStore {
         const queryString = `
       SELECT *, ${this.vectorColumnName} <=> $1 as "_distance"
       FROM ${this.tableName}
-      WHERE ${this.metadataColumnName} @> $2
+      WHERE ${this.metadataColumnName}::jsonb @> $2
       ORDER BY "_distance" ASC
       LIMIT $3;`;
         const documents = (await this.pool.query(queryString, [embeddingString, _filter, k])).rows;

package/dist/vectorstores/pgvector.js

@@ -187,7 +187,7 @@ export class PGVectorStore extends VectorStore {
         const queryString = `
       SELECT *, ${this.vectorColumnName} <=> $1 as "_distance"
       FROM ${this.tableName}
-      WHERE ${this.metadataColumnName} @> $2
+      WHERE ${this.metadataColumnName}::jsonb @> $2
       ORDER BY "_distance" ASC
       LIMIT $3;`;
         const documents = (await this.pool.query(queryString, [embeddingString, _filter, k])).rows;