Skip to main content

Class: LlamaCloudRetriever

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

Implements​

Constructors​

new LlamaCloudRetriever()​

new LlamaCloudRetriever(params): LlamaCloudRetriever

Parameters​

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

Returns​

LlamaCloudRetriever

Source​

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

Properties​

clientParams​

clientParams: ClientParams

Source​

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

pipelineName​

pipelineName: string

Source​

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

projectName​

projectName: string = DEFAULT_PROJECT_NAME

Source​

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

retrieveParams​

retrieveParams: CloudRetrieveParams

Source​

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

Methods​

resultNodesToNodeWithScore()​

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

Parameters​

• nodes: TextNodeWithScore[]

Returns​

NodeWithScore <Metadata>[]

Source​

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

retrieve()​

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

Parameters​

• __namedParameters: RetrieveParams

Returns​

Promise <NodeWithScore <Metadata>[]>

Implementation of​

BaseRetriever . retrieve

Source​

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