Skip to main content

Class: AzureCosmosNoSqlIndexStore

Extends

  • KVIndexStore

Constructors

new AzureCosmosNoSqlIndexStore()

new AzureCosmosNoSqlIndexStore(__namedParameters): AzureCosmosNoSqlIndexStore

Parameters

__namedParameters: AzureCosmosNoSqlIndexStoreArgs

Returns

AzureCosmosNoSqlIndexStore

Overrides

KVIndexStore.constructor

Defined in

packages/llamaindex/src/storage/indexStore/AzureCosmosNoSqlIndexStore.ts:18

Methods

addIndexStruct()

addIndexStruct(indexStruct): Promise<void>

Parameters

indexStruct: IndexStruct

Returns

Promise<void>

Inherited from

KVIndexStore.addIndexStruct

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:20


deleteIndexStruct()

deleteIndexStruct(key): Promise<void>

Parameters

key: string

Returns

Promise<void>

Inherited from

KVIndexStore.deleteIndexStruct

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:26


getIndexStruct()

getIndexStruct(structId?): Promise<undefined | IndexStruct>

Parameters

structId?: string

Returns

Promise<undefined | IndexStruct>

Inherited from

KVIndexStore.getIndexStruct

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:30


getIndexStructs()

getIndexStructs(): Promise<IndexStruct[]>

Returns

Promise<IndexStruct[]>

Inherited from

KVIndexStore.getIndexStructs

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:46


persist()

persist(persistPath?): Promise<void>

Parameters

persistPath?: string

Returns

Promise<void>

Inherited from

KVIndexStore.persist

Defined in

packages/core/storage/index-store/dist/index.d.ts:10


fromAadToken()

static fromAadToken(options): 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.

Parameters

options: AadTokenOptions = {}

Returns

AzureCosmosNoSqlIndexStore

Instance of AzureCosmosNoSqlIndexStore

Defined in

packages/llamaindex/src/storage/indexStore/AzureCosmosNoSqlIndexStore.ts:65


fromAccountAndKey()

static fromAccountAndKey(options): 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.

Parameters

options: AccountAndKeyOptions = {}

Returns

AzureCosmosNoSqlIndexStore

Instance of AzureCosmosNoSqlIndexStore

Defined in

packages/llamaindex/src/storage/indexStore/AzureCosmosNoSqlIndexStore.ts:47


fromConnectionString()

static fromConnectionString(options): AzureCosmosNoSqlIndexStore

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.

Parameters

options: ConnectionStringOptions = {}

Returns

AzureCosmosNoSqlIndexStore

Instance of AzureCosmosNoSqlIndexStore

Defined in

packages/llamaindex/src/storage/indexStore/AzureCosmosNoSqlIndexStore.ts:30