Class: LlamaCloudRetriever
Retrievers retrieve the nodes that most closely match our query in similarity.
Implements
Constructors
constructor
• new LlamaCloudRetriever(params
): LlamaCloudRetriever
Parameters
Name | Type |
---|---|
params | { name : string ; projectName? : string ; serviceContext? : ServiceContext } & ClientParams & Omit <RetrievalParams , "query" | "searchFilters" | "pipelineId" | "className" > & { similarityTopK? : number } |
Returns
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:39
Properties
client
• Optional
client: PlatformApiClient
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:20
clientParams
• clientParams: ClientParams
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:21
pipelineName
• pipelineName: string
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:24
projectName
• projectName: string
= DEFAULT_PROJECT_NAME
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:23
retrieveParams
• retrieveParams: RetrieveParams
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:22
serviceContext
• serviceContext: ServiceContext
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:25
Methods
getClient
▸ getClient(): Promise
<PlatformApiClient
>
Returns
Promise
<PlatformApiClient
>
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:51
getServiceContext
▸ getServiceContext(): ServiceContext
Returns
Implementation of
BaseRetriever.getServiceContext
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:97
resultNodesToNodeWithScore
▸ resultNodesToNodeWithScore(nodes
): NodeWithScore
<Metadata
>[]
Parameters
Name | Type |
---|---|
nodes | TextNodeWithScore [] |
Returns
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:27
retrieve
▸ retrieve(query
, parentEvent?
, preFilters?
): Promise
<NodeWithScore
<Metadata
>[]>
Parameters
Name | Type |
---|---|
query | string |
parentEvent? | Event |
preFilters? | unknown |
Returns
Promise
<NodeWithScore
<Metadata
>[]>