Class: LlamaCloudRetriever

Retrievers retrieve the nodes that most closely match our query in similarity.

Implements

• BaseRetriever

Constructors

constructor

• new LlamaCloudRetriever(params): LlamaCloudRetriever

Parameters

Name	Type
params	{ name: string ; projectName?: string ; serviceContext?: ServiceContext } & ClientParams & Omit<RetrievalParams, "query" | "className" | "searchFilters" | "pipelineId"> & { similarityTopK?: number }

Returns

LlamaCloudRetriever

Defined in

packages/core/src/cloud/LlamaCloudRetriever.ts:34

Properties

client

• Optional client: PlatformApiClient

Defined in

packages/core/src/cloud/LlamaCloudRetriever.ts:16

---

clientParams

• clientParams: ClientParams

Defined in

packages/core/src/cloud/LlamaCloudRetriever.ts:17

---

pipelineName

• pipelineName: string

Defined in

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

---

projectName

• projectName: string = DEFAULT_PROJECT_NAME

Defined in

packages/core/src/cloud/LlamaCloudRetriever.ts:19

---

retrieveParams

• retrieveParams: CloudRetrieveParams

Defined in

packages/core/src/cloud/LlamaCloudRetriever.ts:18

Methods

getClient

▸ getClient(): Promise<PlatformApiClient>

Returns

Promise<PlatformApiClient>

Defined in

packages/core/src/cloud/LlamaCloudRetriever.ts:46

---

resultNodesToNodeWithScore

▸ resultNodesToNodeWithScore(nodes): NodeWithScore<Metadata>[]

Parameters

Name	Type
nodes	TextNodeWithScore[]

Returns

NodeWithScore<Metadata>[]

Defined in

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

---

retrieve

▸ retrieve(«destructured»): Promise<NodeWithScore<Metadata>[]>

Parameters

Name	Type
«destructured»	RetrieveParams

Returns

Promise<NodeWithScore<Metadata>[]>

Implementation of

BaseRetriever.retrieve

Defined in

packages/core/src/cloud/LlamaCloudRetriever.ts:53