Class: LlamaCloudIndex

Constructors

constructor

• new LlamaCloudIndex(params): LlamaCloudIndex

Parameters

Name	Type
params	CloudConstructorParams

Returns

LlamaCloudIndex

Defined in

packages/core/src/cloud/LlamaCloudIndex.ts:22

Properties

params

• params: CloudConstructorParams

Defined in

packages/core/src/cloud/LlamaCloudIndex.ts:20

Methods

asQueryEngine

▸ asQueryEngine(params?): QueryEngine

Parameters

Name	Type
params?	{ nodePostprocessors?: BaseNodePostprocessor[] ; preFilters?: unknown ; responseSynthesizer?: BaseSynthesizer } & Omit<RetrievalParams, "query" | "className" | "searchFilters" | "pipelineId"> & { similarityTopK?: number }

Returns

QueryEngine

Defined in

packages/core/src/cloud/LlamaCloudIndex.ts:175

---

asRetriever

▸ asRetriever(params?): BaseRetriever

Parameters

Name	Type
params	CloudRetrieveParams

Returns

BaseRetriever

Defined in

packages/core/src/cloud/LlamaCloudIndex.ts:171

---

fromDocuments

▸ fromDocuments(params): Promise<LlamaCloudIndex>

Parameters

Name	Type
params	{ documents: Document<Metadata>[] ; transformations?: TransformComponent[] ; verbose?: boolean } & { name: string ; projectName?: string ; serviceContext?: ServiceContext } & ClientParams

Returns

Promise<LlamaCloudIndex>

Defined in

packages/core/src/cloud/LlamaCloudIndex.ts:26