Class: LlamaCloudRetriever

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

Implements

• BaseRetriever

Constructors

new LlamaCloudRetriever()

new LlamaCloudRetriever(params): LlamaCloudRetriever

Parameters

• params: object & ClientParams & Omit<RetrievalParams, "query" | "className" | "searchFilters" | "pipelineId"> & object

Returns

LlamaCloudRetriever

Source

packages/llamaindex/src/cloud/LlamaCloudRetriever.ts:35

Properties

client?

optional client: PlatformApiClient

Source

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

---

clientParams

clientParams: ClientParams

Source

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

---

pipelineName

pipelineName: string

Source

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

---

projectName

projectName: string = DEFAULT_PROJECT_NAME

Source

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

---

retrieveParams

retrieveParams: CloudRetrieveParams

Source

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

Methods

getClient()

private getClient(): Promise<PlatformApiClient>

Returns

Promise<PlatformApiClient>

Source

packages/llamaindex/src/cloud/LlamaCloudRetriever.ts:47

---

resultNodesToNodeWithScore()

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

Parameters

• nodes: TextNodeWithScore[]

Returns

NodeWithScore <Metadata>[]

Source

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

---

retrieve()

retrieve(__namedParameters): Promise <NodeWithScore <Metadata>[]>

Parameters

• __namedParameters: RetrieveParams

Returns

Promise <NodeWithScore <Metadata>[]>

Implementation of

BaseRetriever . retrieve

Source

packages/llamaindex/src/cloud/LlamaCloudRetriever.ts:55