LlamaCloudIndex
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:32
Constructors
Constructor
new LlamaCloudIndex(
params):LlamaCloudIndex
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:35
Parameters
params
Returns
LlamaCloudIndex
Properties
params
params:
CloudConstructorParams
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:33
Methods
getPipelineId()
getPipelineId(
name?,projectName?,organizationId?):Promise<string>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:148
Parameters
name?
string
projectName?
string
organizationId?
string
Returns
Promise<string>
getProjectId()
getProjectId(
projectName?,organizationId?):Promise<string>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:160
Parameters
projectName?
string
organizationId?
string
Returns
Promise<string>
fromDocuments()
staticfromDocuments(params,config?):Promise<LlamaCloudIndex>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:179
Adds documents to the given index parameters. If the index does not exist, it will be created.
Parameters
params
object & object & ClientParams
An object containing the following properties:
- documents: An array of Document objects to be added to the index.
- verbose: Optional boolean to enable verbose logging.
- Additional properties from CloudConstructorParams.
config?
embedding
undefined | null | AzureOpenAIEmbeddingConfig | CohereEmbeddingConfig | GeminiEmbeddingConfig | HuggingFaceInferenceAPIEmbeddingConfig | OpenAIEmbeddingConfig | VertexAIEmbeddingConfig | BedrockEmbeddingConfig
transform
undefined | null | AutoTransformConfig | AdvancedModeTransformConfig
Returns
Promise<LlamaCloudIndex>
A Promise that resolves to a new LlamaCloudIndex instance.
addDocuments()
addDocuments(
documents,verbose?):Promise<void>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:195
Parameters
documents
Document<Metadata>[]
verbose?
boolean
Returns
Promise<void>
asRetriever()
asRetriever(
params):BaseRetriever
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:255
Parameters
params
CloudRetrieveParams = {}
Returns
BaseRetriever
asQueryEngine()
asQueryEngine(
params?):BaseQueryEngine
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:259
Parameters
params?
object & Omit<RetrievalParams, "query" | "search_filters" | "dense_similarity_top_k"> & object
Returns
BaseQueryEngine
asQueryTool()
asQueryTool(
params):QueryEngineTool
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:277
Parameters
params
Returns
queryTool()
queryTool(
params):QueryEngineTool
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:289
Parameters
params
Returns
insert()
insert(
document):Promise<void>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:293
Parameters
document
Document
Returns
Promise<void>
delete()
delete(
document):Promise<void>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:314
Parameters
document
Document
Returns
Promise<void>
refreshDoc()
refreshDoc(
document):Promise<void>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:329
Parameters
document
Document
Returns
Promise<void>
ensureIndex()
ensureIndex(
config?):Promise<void>
Defined in: packages/llamaindex/src/cloud/LlamaCloudIndex.ts:350
Parameters
config?
embedding?
null | AzureOpenAIEmbeddingConfig | CohereEmbeddingConfig | GeminiEmbeddingConfig | HuggingFaceInferenceAPIEmbeddingConfig | OpenAIEmbeddingConfig | VertexAIEmbeddingConfig | BedrockEmbeddingConfig
transform?
null | AutoTransformConfig | AdvancedModeTransformConfig
verbose?
boolean
Returns
Promise<void>