Class: LlamaCloudIndex
Constructors
new LlamaCloudIndex()
new LlamaCloudIndex(
params):LlamaCloudIndex
Parameters
• params: CloudConstructorParams
Returns
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:22
Properties
params
params:
CloudConstructorParams
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:20
Methods
asQueryEngine()
asQueryEngine(
params?):QueryEngine
Parameters
• params?: object & Omit<RetrievalParams, "query" | "search_filters" | "dense_similarity_top_k"> & object
Returns
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:297
asRetriever()
asRetriever(
params):BaseRetriever
Parameters
• params: CloudRetrieveParams = {}
Returns
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:293
delete()
delete(
document):Promise<void>
Parameters
• document: Document<Metadata>
Returns
Promise<void>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:346
getPipelineId()
getPipelineId(
name?,projectName?):Promise<string>
Parameters
• name?: string
• projectName?: string
Returns
Promise<string>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:143
getProjectId()
getProjectId(
projectName?,organizationId?):Promise<string>
Parameters
• projectName?: string
• organizationId?: string
Returns
Promise<string>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:159
insert()
insert(
document):Promise<void>
Parameters
• document: Document<Metadata>
Returns
Promise<void>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:316
refreshDoc()
refreshDoc(
document):Promise<void>
Parameters
• document: Document<Metadata>
Returns
Promise<void>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:368
fromDocuments()
staticfromDocuments(params):Promise<LlamaCloudIndex>
Parameters
• params: object & object & ClientParams
Returns
Promise<LlamaCloudIndex>