Skip to main content

Class: LlamaCloudIndex

Constructors

new LlamaCloudIndex()

new LlamaCloudIndex(params): LlamaCloudIndex

Parameters

params: CloudConstructorParams

Returns

LlamaCloudIndex

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

QueryEngine

Defined in

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


asRetriever()

asRetriever(params): BaseRetriever

Parameters

params: CloudRetrieveParams = {}

Returns

BaseRetriever

Defined in

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


delete()

delete(document): Promise<void>

Parameters

document: Document<Metadata>

Returns

Promise<void>

Defined in

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


getPipelineId()

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

Parameters

name?: string

projectName?: string

Returns

Promise<string>

Defined in

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


getProjectId()

getProjectId(projectName?, organizationId?): Promise<string>

Parameters

projectName?: string

organizationId?: string

Returns

Promise<string>

Defined in

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


insert()

insert(document): Promise<void>

Parameters

document: Document<Metadata>

Returns

Promise<void>

Defined in

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


refreshDoc()

refreshDoc(document): Promise<void>

Parameters

document: Document<Metadata>

Returns

Promise<void>

Defined in

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


fromDocuments()

static fromDocuments(params): Promise<LlamaCloudIndex>

Parameters

params: object & object & ClientParams

Returns

Promise<LlamaCloudIndex>

Defined in

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