Interface AzureCosmosDBNoSQLConfig

Configuration options for the AzureCosmosDBNoSQLVectorStore constructor.

interface AzureCosmosDBNoSQLConfig {
    client?: CosmosClient;
    connectionString?: string;
    containerName?: string;
    createContainerOptions?: Partial<Omit<ContainerRequest, "id" | "vectorEmbeddingPolicy" | "indexingPolicy">>;
    createDatabaseOptions?: Partial<Omit<DatabaseRequest, "id">>;
    credentials?: TokenCredential;
    databaseName?: string;
    endpoint?: string;
    indexingPolicy?: IndexingPolicy;
    metadataKey?: string;
    textKey?: string;
    vectorEmbeddingPolicy?: VectorEmbeddingPolicy;
}

Hierarchy (view full)

Properties

client? connectionString? containerName? createContainerOptions? createDatabaseOptions? credentials? databaseName? endpoint? indexingPolicy? metadataKey? textKey? vectorEmbeddingPolicy?

Properties

Optional Readonlyclient

client?: CosmosClient

Optional ReadonlyconnectionString

connectionString?: string

Optional ReadonlycontainerName

containerName?: string

Optional ReadonlycreateContainerOptions

createContainerOptions?: Partial<Omit<ContainerRequest, "id" | "vectorEmbeddingPolicy" | "indexingPolicy">>

Optional ReadonlycreateDatabaseOptions

createDatabaseOptions?: Partial<Omit<DatabaseRequest, "id">>

Optional Readonlycredentials

credentials?: TokenCredential

Optional ReadonlydatabaseName

databaseName?: string

Optional Readonlyendpoint

endpoint?: string

Optional ReadonlyindexingPolicy

indexingPolicy?: IndexingPolicy

Optional ReadonlymetadataKey

metadataKey?: string

Optional ReadonlytextKey

textKey?: string

Optional ReadonlyvectorEmbeddingPolicy

vectorEmbeddingPolicy?: VectorEmbeddingPolicy

Settings

Member Visibility

On This Page

Properties