Class: AzureCosmosNoSqlDocumentStore
Extends
KVDocumentStore
Constructors
new AzureCosmosNoSqlDocumentStore()
new AzureCosmosNoSqlDocumentStore(
__namedParameters):AzureCosmosNoSqlDocumentStore
Parameters
• __namedParameters: AzureCosmosNoSqlDocumentStoreArgs
Returns
Overrides
KVDocumentStore.constructor
Defined in
packages/llamaindex/src/storage/docStore/AzureCosmosNoSqlDocumentStore.ts:18
Properties
serializer
serializer:
Serializer<any>
Inherited from
KVDocumentStore.serializer
Defined in
packages/core/storage/doc-store/dist/index.d.ts:23
Methods
addDocuments()
addDocuments(
docs,allowUpdate):Promise<void>
Parameters
• allowUpdate: boolean = true
Returns
Promise<void>
Inherited from
KVDocumentStore.addDocuments
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:44
deleteDocument()
deleteDocument(
docId,raiseError,removeRefDocNode):Promise<void>
Parameters
• docId: string
• raiseError: boolean = true
• removeRefDocNode: boolean = true
Returns
Promise<void>
Inherited from
KVDocumentStore.deleteDocument
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:145
deleteRefDoc()
deleteRefDoc(
refDocId,raiseError):Promise<void>
Parameters
• refDocId: string
• raiseError: boolean = true
Returns
Promise<void>
Inherited from
KVDocumentStore.deleteRefDoc
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:162
docs()
Returns
Promise<Record<string, BaseNode<Metadata>>>
Inherited from
KVDocumentStore.docs
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:30
documentExists()
documentExists(
docId):Promise<boolean>
Parameters
• docId: string
Returns
Promise<boolean>
Inherited from
KVDocumentStore.documentExists
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:121
getAllDocumentHashes()
getAllDocumentHashes():
Promise<Record<string,string>>
Returns
Promise<Record<string, string>>
Inherited from
KVDocumentStore.getAllDocumentHashes
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:193
getAllRefDocInfo()
getAllRefDocInfo():
Promise<undefined|Record<string,RefDocInfo>>
Returns
Promise<undefined | Record<string, RefDocInfo>>
Inherited from
KVDocumentStore.getAllRefDocInfo
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:109
getDocument()
getDocument(
docId,raiseError):Promise<undefined|BaseNode<Metadata>>
Parameters
• docId: string
• raiseError: boolean = true
Returns
Promise<undefined | BaseNode<Metadata>>
Inherited from
KVDocumentStore.getDocument
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:86
getDocumentHash()
getDocumentHash(
docId):Promise<undefined|string>
Parameters
• docId: string
Returns
Promise<undefined | string>
Inherited from
KVDocumentStore.getDocumentHash
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:188
getNode()
Parameters
• nodeId: string
• raiseError?: boolean
Returns
Inherited from
KVDocumentStore.getNode
Defined in
packages/core/storage/doc-store/dist/index.d.ts:37
getNodeDict()
getNodeDict(
nodeIdDict):Promise<Record<number,BaseNode<Metadata>>>
Parameters
• nodeIdDict
Returns
Promise<Record<number, BaseNode<Metadata>>>
Inherited from
KVDocumentStore.getNodeDict
Defined in
packages/core/storage/doc-store/dist/index.d.ts:38
getNodes()
getNodes(
nodeIds,raiseError?):Promise<BaseNode<Metadata>[]>
Parameters
• nodeIds: string[]
• raiseError?: boolean
Returns
Inherited from
KVDocumentStore.getNodes
Defined in
packages/core/storage/doc-store/dist/index.d.ts:36
getRefDocInfo()
getRefDocInfo(
refDocId):Promise<undefined|RefDocInfo>
Parameters
• refDocId: string
Returns
Promise<undefined | RefDocInfo>
Inherited from
KVDocumentStore.getRefDocInfo
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:104
persist()
persist(
persistPath?):void
Parameters
• persistPath?: string
Returns
void
Inherited from
KVDocumentStore.persist
Defined in
packages/core/storage/doc-store/dist/index.d.ts:24
refDocExists()
refDocExists(
refDocId):Promise<boolean>
Parameters
• refDocId: string
Returns
Promise<boolean>
Inherited from
KVDocumentStore.refDocExists
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:117
setDocumentHash()
setDocumentHash(
docId,docHash):Promise<void>
Parameters
• docId: string
• docHash: string
Returns
Promise<void>
Inherited from
KVDocumentStore.setDocumentHash
Defined in
packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:183
fromAadToken()
staticfromAadToken(options):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.
Parameters
• options: AadTokenOptions = {}
Returns
Instance of AzureCosmosNoSqlDocumentStore
Defined in
packages/llamaindex/src/storage/docStore/AzureCosmosNoSqlDocumentStore.ts:66
fromAccountAndKey()
staticfromAccountAndKey(options):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.
Parameters
• options: AccountAndKeyOptions = {}
Returns
Instance of AzureCosmosNoSqlDocumentStore
Defined in
packages/llamaindex/src/storage/docStore/AzureCosmosNoSqlDocumentStore.ts:48
fromConnectionString()
staticfromConnectionString(options):AzureCosmosNoSqlDocumentStore
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
Instance of AzureCosmosNoSqlDocumentStore
Defined in
packages/llamaindex/src/storage/docStore/AzureCosmosNoSqlDocumentStore.ts:30