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" | "search_filters" | "dense_similarity_top_k"> & object

Returns

LlamaCloudRetriever

Defined in

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

Properties

clientParams

clientParams: ClientParams

Defined in

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


organizationId?

optional organizationId: string

Defined in

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


pipelineName

pipelineName: string

Defined in

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


projectName

projectName: string = DEFAULT_PROJECT_NAME

Defined in

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


retrieveParams

retrieveParams: CloudRetrieveParams

Defined in

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

Methods

retrieve()

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

Parameters

__namedParameters: RetrieveParams

Returns

Promise<NodeWithScore<Metadata>[]>

Implementation of

BaseRetriever.retrieve

Defined in

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