@vectorstores/azure 0.1.0

package/dist/storage.d.ts

@@ -0,0 +1,220 @@
+import { BaseKVStore, KVDocumentStore, KVIndexStore } from '@vectorstores/core';
+import { MongoClient } from 'mongodb';
+import { CosmosClient } from '@azure/cosmos';
+import { TokenCredential } from '@azure/identity';
+
+interface VcoreConnectionStringOptions extends AzureCosmosVCoreKVStoreConfig {
+    connectionString?: string;
+}
+interface AzureCosmosVCoreKVStoreConfig {
+    mongoClient?: MongoClient;
+    dbName?: string;
+    collectionName?: string;
+}
+declare class AzureCosmosVCoreKVStore extends BaseKVStore {
+    private mongoClient;
+    private dbName;
+    private collectionName;
+    private collection?;
+    /**
+     * Create a new AzureCosmosDBNoSQLVectorStore instance.
+     */
+    constructor({ mongoClient, dbName, collectionName, }: AzureCosmosVCoreKVStoreConfig);
+    client(): MongoClient;
+    private ensureCollection;
+    put(key: string, val: Record<string, any>): Promise<void>;
+    get(key: string): Promise<Record<string, any> | null>;
+    getAll(): Promise<Record<string, Record<string, any>>>;
+    delete(key: string): Promise<boolean>;
+}
+
+interface AzureCosmosVCoreDocumentStoreArgs {
+    azureCosmosVCoreKVStore: AzureCosmosVCoreKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosVCoreDocumentStore extends KVDocumentStore {
+    constructor({ azureCosmosVCoreKVStore, namespace, }: AzureCosmosVCoreDocumentStoreArgs);
+    /**
+     * Static method for creating an instance using a MongoClient.
+     * @returns Instance of AzureCosmosVCoreDocumentStore
+     * @param mongoClient - MongoClient instance
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const mongoClient = new MongoClient("mongodb://localhost:27017");
+     * const indexStore = AzureCosmosVCoreDocumentStore.fromMongoClient(mongoClient, "my_db", "my_collection");
+     * ```
+     */
+    static fromMongoClient(mongoClient: MongoClient, dbName?: string, collectionName?: string): AzureCosmosVCoreDocumentStore;
+    /**
+     * Static method for creating an instance using a connection string.
+     * @returns Instance of AzureCosmosVCoreDocumentStore
+     * @param connectionString - MongoDB connection string
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const indexStore = AzureCosmosVCoreDocumentStore.fromConnectionString("mongodb://localhost:27017", "my_db", "my_collection");
+     * ```
+     */
+    static fromConnectionString(connectionString: string, dbName?: string, collectionName?: string): AzureCosmosVCoreDocumentStore;
+}
+
+interface CosmosDatabaseProperties {
+    throughput?: number;
+}
+interface CosmosContainerProperties {
+    partitionKey: any;
+    [key: string]: any;
+}
+interface ConnectionStringOptions extends AzureCosmosNoSqlKVStoreConfig {
+    connectionString?: string;
+}
+interface AccountAndKeyOptions extends AzureCosmosNoSqlKVStoreConfig {
+    endpoint?: string;
+    key?: string;
+}
+interface AadTokenOptions extends AzureCosmosNoSqlKVStoreConfig {
+    endpoint?: string;
+    credential?: TokenCredential;
+}
+interface AzureCosmosNoSqlKVStoreConfig {
+    cosmosClient?: CosmosClient;
+    dbName?: string;
+    containerName?: string;
+    cosmosContainerProperties?: CosmosContainerProperties;
+    cosmosDatabaseProperties?: CosmosDatabaseProperties;
+}
+declare class AzureCosmosNoSqlKVStore extends BaseKVStore {
+    private cosmosClient;
+    private database;
+    private container;
+    private initPromise?;
+    private dbName;
+    private containerName;
+    private cosmosContainerProperties;
+    private cosmosDatabaseProperties;
+    private initialize;
+    constructor({ cosmosClient, dbName, containerName, cosmosContainerProperties, cosmosDatabaseProperties, }: AzureCosmosNoSqlKVStoreConfig);
+    client(): CosmosClient;
+    private init;
+    /**
+     * Static method for creating an instance using a connection string.
+     * If no connection string is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_CONNECTION_STRING` as connection string.
+     * @returns Instance of AzureCosmosNoSqlKVStore
+     */
+    static fromConnectionString(config?: {
+        connectionString?: string;
+    } & AzureCosmosNoSqlKVStoreConfig): AzureCosmosNoSqlKVStore;
+    /**
+     * Static method for creating an instance using a account endpoint and key.
+     * If no endpoint and key  is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as enpoint and `AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY` as key.
+     * @returns Instance of AzureCosmosNoSqlKVStore
+     */
+    static fromAccountAndKey(config?: {
+        endpoint?: string;
+        key?: string;
+    } & AzureCosmosNoSqlKVStoreConfig): AzureCosmosNoSqlKVStore;
+    /**
+     * Static method for creating an instance using AAD token.
+     * If no endpoint and credentials are provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as endpoint and use DefaultAzureCredential() as credentials.
+     * @returns Instance of AzureCosmosNoSqlKVStore
+     */
+    static fromAadToken(config?: {
+        endpoint?: string;
+        credential?: TokenCredential;
+    } & AzureCosmosNoSqlKVStoreConfig): AzureCosmosNoSqlKVStore;
+    put(key: string, val: Record<string, any>): Promise<void>;
+    get(key: string): Promise<Record<string, any> | null>;
+    getAll(): Promise<Record<string, Record<string, any>>>;
+    delete(key: string): Promise<boolean>;
+}
+
+interface AzureCosmosNoSqlDocumentStoreArgs {
+    azureCosmosNoSqlKVStore: AzureCosmosNoSqlKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosNoSqlDocumentStore extends KVDocumentStore {
+    constructor({ azureCosmosNoSqlKVStore, namespace, }: AzureCosmosNoSqlDocumentStoreArgs);
+    /**
+     * Static method for creating an instance using a connection string.
+     * If no connection string is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_CONNECTION_STRING` as connection string.
+     * @returns Instance of AzureCosmosNoSqlDocumentStore
+     */
+    static fromConnectionString(options?: ConnectionStringOptions): AzureCosmosNoSqlDocumentStore;
+    /**
+     * Static method for creating an instance using a account endpoint and key.
+     * If no endpoint and key  is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as enpoint and `AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY` as key.
+     * @returns Instance of AzureCosmosNoSqlDocumentStore
+     */
+    static fromAccountAndKey(options?: AccountAndKeyOptions): AzureCosmosNoSqlDocumentStore;
+    /**
+     * Static method for creating an instance using AAD token.
+     * If no endpoint and credentials are provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as endpoint and use DefaultAzureCredential() as credentials.
+     * @returns Instance of AzureCosmosNoSqlDocumentStore
+     */
+    static fromAadToken(options?: AadTokenOptions): AzureCosmosNoSqlDocumentStore;
+}
+
+interface AzureCosmosVCoreIndexStoreArgs {
+    azureCosmosVCoreKVStore: AzureCosmosVCoreKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosVCoreIndexStore extends KVIndexStore {
+    constructor({ azureCosmosVCoreKVStore, namespace, }: AzureCosmosVCoreIndexStoreArgs);
+    /**
+     * Static method for creating an instance using a MongoClient.
+     * @returns Instance of AzureCosmosVCoreIndexStore
+     * @param mongoClient - MongoClient instance
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const mongoClient = new MongoClient("mongodb://localhost:27017");
+     * const indexStore = AzureCosmosVCoreIndexStore.fromMongoClient(mongoClient, "my_db", "my_collection");
+     * ```
+     */
+    static fromMongoClient(mongoClient: MongoClient, dbName?: string, collectionName?: string): AzureCosmosVCoreIndexStore;
+    /**
+     * Static method for creating an instance using a connection string.
+     * @returns Instance of AzureCosmosVCoreIndexStore
+     * @param connectionString - MongoDB connection string
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const indexStore = AzureCosmosVCoreIndexStore.fromConnectionString("mongodb://localhost:27017", "my_db", "my_collection");
+     * ```
+     */
+    static fromConnectionString(connectionString: string, dbName?: string, collectionName?: string): AzureCosmosVCoreIndexStore;
+}
+
+interface AzureCosmosNoSqlIndexStoreArgs {
+    azureCosmosNoSqlKVStore: AzureCosmosNoSqlKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosNoSqlIndexStore extends KVIndexStore {
+    constructor({ azureCosmosNoSqlKVStore, namespace, }: AzureCosmosNoSqlIndexStoreArgs);
+    /**
+     * Static method for creating an instance using a connection string.
+     * If no connection string is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_CONNECTION_STRING` as connection string.
+     * @returns Instance of AzureCosmosNoSqlIndexStore
+     */
+    static fromConnectionString(options?: ConnectionStringOptions): AzureCosmosNoSqlIndexStore;
+    /**
+     * Static method for creating an instance using a account endpoint and key.
+     * If no endpoint and key  is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as enpoint and `AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY` as key.
+     * @returns Instance of AzureCosmosNoSqlIndexStore
+     */
+    static fromAccountAndKey(options?: AccountAndKeyOptions): AzureCosmosNoSqlIndexStore;
+    /**
+     * Static method for creating an instance using AAD token.
+     * If no endpoint and credentials are provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as endpoint and use DefaultAzureCredential() as credentials.
+     * @returns Instance of AzureCosmosNoSqlIndexStore
+     */
+    static fromAadToken(options?: AadTokenOptions): AzureCosmosNoSqlIndexStore;
+}
+
+export { AzureCosmosNoSqlDocumentStore, AzureCosmosNoSqlIndexStore, AzureCosmosNoSqlKVStore, AzureCosmosVCoreDocumentStore, AzureCosmosVCoreIndexStore, AzureCosmosVCoreKVStore };
+export type { AadTokenOptions, AccountAndKeyOptions, AzureCosmosNoSqlDocumentStoreArgs, AzureCosmosNoSqlIndexStoreArgs, AzureCosmosNoSqlKVStoreConfig, AzureCosmosVCoreDocumentStoreArgs, AzureCosmosVCoreIndexStoreArgs, AzureCosmosVCoreKVStoreConfig, ConnectionStringOptions, CosmosContainerProperties, CosmosDatabaseProperties, VcoreConnectionStringOptions };

package/dist/storage.edge-light.d.ts

@@ -0,0 +1,220 @@
+import { BaseKVStore, KVDocumentStore, KVIndexStore } from '@vectorstores/core';
+import { MongoClient } from 'mongodb';
+import { CosmosClient } from '@azure/cosmos';
+import { TokenCredential } from '@azure/identity';
+
+interface VcoreConnectionStringOptions extends AzureCosmosVCoreKVStoreConfig {
+    connectionString?: string;
+}
+interface AzureCosmosVCoreKVStoreConfig {
+    mongoClient?: MongoClient;
+    dbName?: string;
+    collectionName?: string;
+}
+declare class AzureCosmosVCoreKVStore extends BaseKVStore {
+    private mongoClient;
+    private dbName;
+    private collectionName;
+    private collection?;
+    /**
+     * Create a new AzureCosmosDBNoSQLVectorStore instance.
+     */
+    constructor({ mongoClient, dbName, collectionName, }: AzureCosmosVCoreKVStoreConfig);
+    client(): MongoClient;
+    private ensureCollection;
+    put(key: string, val: Record<string, any>): Promise<void>;
+    get(key: string): Promise<Record<string, any> | null>;
+    getAll(): Promise<Record<string, Record<string, any>>>;
+    delete(key: string): Promise<boolean>;
+}
+
+interface AzureCosmosVCoreDocumentStoreArgs {
+    azureCosmosVCoreKVStore: AzureCosmosVCoreKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosVCoreDocumentStore extends KVDocumentStore {
+    constructor({ azureCosmosVCoreKVStore, namespace, }: AzureCosmosVCoreDocumentStoreArgs);
+    /**
+     * Static method for creating an instance using a MongoClient.
+     * @returns Instance of AzureCosmosVCoreDocumentStore
+     * @param mongoClient - MongoClient instance
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const mongoClient = new MongoClient("mongodb://localhost:27017");
+     * const indexStore = AzureCosmosVCoreDocumentStore.fromMongoClient(mongoClient, "my_db", "my_collection");
+     * ```
+     */
+    static fromMongoClient(mongoClient: MongoClient, dbName?: string, collectionName?: string): AzureCosmosVCoreDocumentStore;
+    /**
+     * Static method for creating an instance using a connection string.
+     * @returns Instance of AzureCosmosVCoreDocumentStore
+     * @param connectionString - MongoDB connection string
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const indexStore = AzureCosmosVCoreDocumentStore.fromConnectionString("mongodb://localhost:27017", "my_db", "my_collection");
+     * ```
+     */
+    static fromConnectionString(connectionString: string, dbName?: string, collectionName?: string): AzureCosmosVCoreDocumentStore;
+}
+
+interface CosmosDatabaseProperties {
+    throughput?: number;
+}
+interface CosmosContainerProperties {
+    partitionKey: any;
+    [key: string]: any;
+}
+interface ConnectionStringOptions extends AzureCosmosNoSqlKVStoreConfig {
+    connectionString?: string;
+}
+interface AccountAndKeyOptions extends AzureCosmosNoSqlKVStoreConfig {
+    endpoint?: string;
+    key?: string;
+}
+interface AadTokenOptions extends AzureCosmosNoSqlKVStoreConfig {
+    endpoint?: string;
+    credential?: TokenCredential;
+}
+interface AzureCosmosNoSqlKVStoreConfig {
+    cosmosClient?: CosmosClient;
+    dbName?: string;
+    containerName?: string;
+    cosmosContainerProperties?: CosmosContainerProperties;
+    cosmosDatabaseProperties?: CosmosDatabaseProperties;
+}
+declare class AzureCosmosNoSqlKVStore extends BaseKVStore {
+    private cosmosClient;
+    private database;
+    private container;
+    private initPromise?;
+    private dbName;
+    private containerName;
+    private cosmosContainerProperties;
+    private cosmosDatabaseProperties;
+    private initialize;
+    constructor({ cosmosClient, dbName, containerName, cosmosContainerProperties, cosmosDatabaseProperties, }: AzureCosmosNoSqlKVStoreConfig);
+    client(): CosmosClient;
+    private init;
+    /**
+     * Static method for creating an instance using a connection string.
+     * If no connection string is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_CONNECTION_STRING` as connection string.
+     * @returns Instance of AzureCosmosNoSqlKVStore
+     */
+    static fromConnectionString(config?: {
+        connectionString?: string;
+    } & AzureCosmosNoSqlKVStoreConfig): AzureCosmosNoSqlKVStore;
+    /**
+     * Static method for creating an instance using a account endpoint and key.
+     * If no endpoint and key  is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as enpoint and `AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY` as key.
+     * @returns Instance of AzureCosmosNoSqlKVStore
+     */
+    static fromAccountAndKey(config?: {
+        endpoint?: string;
+        key?: string;
+    } & AzureCosmosNoSqlKVStoreConfig): AzureCosmosNoSqlKVStore;
+    /**
+     * Static method for creating an instance using AAD token.
+     * If no endpoint and credentials are provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as endpoint and use DefaultAzureCredential() as credentials.
+     * @returns Instance of AzureCosmosNoSqlKVStore
+     */
+    static fromAadToken(config?: {
+        endpoint?: string;
+        credential?: TokenCredential;
+    } & AzureCosmosNoSqlKVStoreConfig): AzureCosmosNoSqlKVStore;
+    put(key: string, val: Record<string, any>): Promise<void>;
+    get(key: string): Promise<Record<string, any> | null>;
+    getAll(): Promise<Record<string, Record<string, any>>>;
+    delete(key: string): Promise<boolean>;
+}
+
+interface AzureCosmosNoSqlDocumentStoreArgs {
+    azureCosmosNoSqlKVStore: AzureCosmosNoSqlKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosNoSqlDocumentStore extends KVDocumentStore {
+    constructor({ azureCosmosNoSqlKVStore, namespace, }: AzureCosmosNoSqlDocumentStoreArgs);
+    /**
+     * Static method for creating an instance using a connection string.
+     * If no connection string is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_CONNECTION_STRING` as connection string.
+     * @returns Instance of AzureCosmosNoSqlDocumentStore
+     */
+    static fromConnectionString(options?: ConnectionStringOptions): AzureCosmosNoSqlDocumentStore;
+    /**
+     * Static method for creating an instance using a account endpoint and key.
+     * If no endpoint and key  is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as enpoint and `AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY` as key.
+     * @returns Instance of AzureCosmosNoSqlDocumentStore
+     */
+    static fromAccountAndKey(options?: AccountAndKeyOptions): AzureCosmosNoSqlDocumentStore;
+    /**
+     * Static method for creating an instance using AAD token.
+     * If no endpoint and credentials are provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as endpoint and use DefaultAzureCredential() as credentials.
+     * @returns Instance of AzureCosmosNoSqlDocumentStore
+     */
+    static fromAadToken(options?: AadTokenOptions): AzureCosmosNoSqlDocumentStore;
+}
+
+interface AzureCosmosVCoreIndexStoreArgs {
+    azureCosmosVCoreKVStore: AzureCosmosVCoreKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosVCoreIndexStore extends KVIndexStore {
+    constructor({ azureCosmosVCoreKVStore, namespace, }: AzureCosmosVCoreIndexStoreArgs);
+    /**
+     * Static method for creating an instance using a MongoClient.
+     * @returns Instance of AzureCosmosVCoreIndexStore
+     * @param mongoClient - MongoClient instance
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const mongoClient = new MongoClient("mongodb://localhost:27017");
+     * const indexStore = AzureCosmosVCoreIndexStore.fromMongoClient(mongoClient, "my_db", "my_collection");
+     * ```
+     */
+    static fromMongoClient(mongoClient: MongoClient, dbName?: string, collectionName?: string): AzureCosmosVCoreIndexStore;
+    /**
+     * Static method for creating an instance using a connection string.
+     * @returns Instance of AzureCosmosVCoreIndexStore
+     * @param connectionString - MongoDB connection string
+     * @param dbName - Database name
+     * @param collectionName - Collection name
+     * @example
+     * ```ts
+     * const indexStore = AzureCosmosVCoreIndexStore.fromConnectionString("mongodb://localhost:27017", "my_db", "my_collection");
+     * ```
+     */
+    static fromConnectionString(connectionString: string, dbName?: string, collectionName?: string): AzureCosmosVCoreIndexStore;
+}
+
+interface AzureCosmosNoSqlIndexStoreArgs {
+    azureCosmosNoSqlKVStore: AzureCosmosNoSqlKVStore;
+    namespace?: string;
+}
+declare class AzureCosmosNoSqlIndexStore extends KVIndexStore {
+    constructor({ azureCosmosNoSqlKVStore, namespace, }: AzureCosmosNoSqlIndexStoreArgs);
+    /**
+     * Static method for creating an instance using a connection string.
+     * If no connection string is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_CONNECTION_STRING` as connection string.
+     * @returns Instance of AzureCosmosNoSqlIndexStore
+     */
+    static fromConnectionString(options?: ConnectionStringOptions): AzureCosmosNoSqlIndexStore;
+    /**
+     * Static method for creating an instance using a account endpoint and key.
+     * If no endpoint and key  is provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as enpoint and `AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY` as key.
+     * @returns Instance of AzureCosmosNoSqlIndexStore
+     */
+    static fromAccountAndKey(options?: AccountAndKeyOptions): AzureCosmosNoSqlIndexStore;
+    /**
+     * Static method for creating an instance using AAD token.
+     * If no endpoint and credentials are provided, it will attempt to use the env variable `AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT` as endpoint and use DefaultAzureCredential() as credentials.
+     * @returns Instance of AzureCosmosNoSqlIndexStore
+     */
+    static fromAadToken(options?: AadTokenOptions): AzureCosmosNoSqlIndexStore;
+}
+
+export { AzureCosmosNoSqlDocumentStore, AzureCosmosNoSqlIndexStore, AzureCosmosNoSqlKVStore, AzureCosmosVCoreDocumentStore, AzureCosmosVCoreIndexStore, AzureCosmosVCoreKVStore };
+export type { AadTokenOptions, AccountAndKeyOptions, AzureCosmosNoSqlDocumentStoreArgs, AzureCosmosNoSqlIndexStoreArgs, AzureCosmosNoSqlKVStoreConfig, AzureCosmosVCoreDocumentStoreArgs, AzureCosmosVCoreIndexStoreArgs, AzureCosmosVCoreKVStoreConfig, ConnectionStringOptions, CosmosContainerProperties, CosmosDatabaseProperties, VcoreConnectionStringOptions };