Class: LlamaCloudIndex
Constructors
new LlamaCloudIndex()
new LlamaCloudIndex(
params
):LlamaCloudIndex
Parameters
• params: CloudConstructorParams
Returns
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:22
Properties
params
params:
CloudConstructorParams
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:20
Methods
asQueryEngine()
asQueryEngine(
params
?):QueryEngine
Parameters
• params?: object
& Omit
<RetrievalParams
, "query"
| "searchFilters"
| "className"
| "denseSimilarityTopK"
> & object
Returns
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:260
asRetriever()
asRetriever(
params
):BaseRetriever
Parameters
• params: CloudRetrieveParams
= {}
Returns
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:256
delete()
delete(
document
):Promise
<void
>
Parameters
• document: Document
<Metadata
>
Returns
Promise
<void
>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:307
insert()
insert(
document
):Promise
<void
>
Parameters
• document: Document
<Metadata
>
Returns
Promise
<void
>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:279
refreshDoc()
refreshDoc(
document
):Promise
<void
>
Parameters
• document: Document
<Metadata
>
Returns
Promise
<void
>
Defined in
packages/llamaindex/src/cloud/LlamaCloudIndex.ts:327
fromDocuments()
static
fromDocuments(params
):Promise
<LlamaCloudIndex
>
Parameters
• params: object
& object
& ClientParams
Returns
Promise
<LlamaCloudIndex
>