Class: LlamaCloudIndex

Constructors

new LlamaCloudIndex()

new LlamaCloudIndex(params): LlamaCloudIndex

Parameters

• params: CloudConstructorParams

Returns

LlamaCloudIndex

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:23

Properties

params

params: CloudConstructorParams

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:21

Methods

asQueryEngine()

asQueryEngine(params?): QueryEngine

Parameters

• params?: object & Omit<RetrievalParams, "query" | "searchFilters" | "className" | "denseSimilarityTopK"> & object

Returns

QueryEngine

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:260

---

asRetriever()

asRetriever(params): BaseRetriever

Parameters

• params: CloudRetrieveParams= {}

Returns

BaseRetriever

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:256

---

delete()

delete(document): Promise<void>

Parameters

• document: Document <Metadata>

Returns

Promise<void>

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:307

---

getPipelineId()

private getPipelineId(name, projectName): Promise<string>

Parameters

• name: string

• projectName: string

Returns

Promise<string>

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:136

---

insert()

insert(document): Promise<void>

Parameters

• document: Document <Metadata>

Returns

Promise<void>

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:279

---

refreshDoc()

refreshDoc(document): Promise<void>

Parameters

• document: Document <Metadata>

Returns

Promise<void>

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:327

---

waitForDocumentIngestion()

private waitForDocumentIngestion(docIds, verbose, raiseOnError): Promise<void>

Parameters

• docIds: string[]

• verbose: boolean= Settings.debug

• raiseOnError: boolean= false

Returns

Promise<void>

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:74

---

waitForPipelineIngestion()

private waitForPipelineIngestion(verbose, raiseOnError): Promise<void>

Parameters

• verbose: boolean= Settings.debug

• raiseOnError: boolean= false

Returns

Promise<void>

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:28

---

fromDocuments()

static fromDocuments(params): Promise <LlamaCloudIndex>

Parameters

• params: object & object & ClientParams

Returns

Promise <LlamaCloudIndex>

Source

packages/llamaindex/src/cloud/LlamaCloudIndex.ts:148