LlamaCloud Index + Retriever
NOTE: This package has been deprecated and is no longer maintained. Please use the llama-cloud package instead.
LlamaCloud is a new generation of managed parsing, ingestion, and retrieval services, designed to bring production-grade context-augmentation to your LLM and RAG applications.
Currently, LlamaCloud supports
- Managed Ingestion API, handling parsing and document management
- Managed Retrieval API, configuring optimal retrieval for your RAG system
Access
We are opening up a private beta to a limited set of enterprise partners for the managed ingestion and retrieval API. If you’re interested in centralizing your data pipelines and spending more time working on your actual RAG use cases, come talk to us.
If you have access to LlamaCloud, you can visit LlamaCloud to sign in and get an API key.
Setup
First, make sure you have the latest LlamaIndex version installed.
pip uninstall llama-index # run this if upgrading from v0.9.x or older
pip install -U llama-index --upgrade --no-cache-dir --force-reinstall
The llama-index-indices-managed-llama-cloud package is included with the above install, but you can also install directly
pip install -U llama-index-indices-managed-llama-cloud
Usage
You can create an index on LlamaCloud using the following code. By default, new indexes use managed embeddings (OpenAI text-embedding-3-small, 1536 dimensions, 1 credit/page):
import os
os.environ[
"LLAMA_CLOUD_API_KEY"
] = "llx-..." # can provide API-key in env or in the constructor later on
from llama_index.core import SimpleDirectoryReader
from llama_index.indices.managed.llama_cloud import LlamaCloudIndex
# create a new index (uses managed embeddings by default)
index = LlamaCloudIndex.from_documents(
documents,
"my_first_index",
project_name="default",
api_key="llx-...",
verbose=True,
)
# connect to an existing index
index = LlamaCloudIndex("my_first_index", project_name="default")
You can also configure a retriever for managed retrieval:
# from the existing index
index.as_retriever()
# from scratch
from llama_index.indices.managed.llama_cloud import LlamaCloudRetriever
retriever = LlamaCloudRetriever("my_first_index", project_name="default")
And of course, you can use other index shortcuts to get use out of your new managed index:
query_engine = index.as_query_engine(llm=llm)
chat_engine = index.as_chat_engine(llm=llm)
Retriever Settings
A full list of retriever settings/kwargs is below:
dense_similarity_top_k: Optional[int] -- If greater than 0, retrieveknodes using dense retrievalsparse_similarity_top_k: Optional[int] -- If greater than 0, retrieveknodes using sparse retrievalenable_reranking: Optional[bool] -- Whether to enable reranking or not. Sacrifices some speed for accuracyrerank_top_n: Optional[int] -- The number of nodes to return after reranking initial retrieval resultsalphaOptional[float] -- The weighting between dense and sparse retrieval. 1 = Full dense retrieval, 0 = Full sparse retrieval.
1 maintainer
Release files for llama-index-indices-managed-llama-cloud 0.12.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| llama_index_indices_managed_llama_cloud-0.12.0.tar.gz | 4.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| llama_index_indices_managed_llama_cloud-0.12.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.2 kB
Release files / llama_index_indices_managed_llama_cloud-0.12.0.tar.gz
| Download URL | llama_index_indices_managed_llama_cloud-0.12.0.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d4bca39ee803209c9f6d5697c23d1e06027cb74bbe2df9a91d3854135a23c720
|
|
BLAKE2b-256 checksum How to use checksums |
3615f3c4443dfaaf84235beefcde3df49cc505f32f2d340a64e22ae564d62f03
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / llama_index_indices_managed_llama_cloud-0.12.0-py3-none-any.whl
| Download URL | llama_index_indices_managed_llama_cloud-0.12.0-py3-none-any.whl |
|---|---|
| Size | 3.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d2e83a143e7f140f68893517ada12a34ce4be95584c5434dccf6e7bcce289a5a
|
|
BLAKE2b-256 checksum How to use checksums |
7dda4b1492a8db2d2bd34fe9f490322cc289d1c4dd7731bd91e26a3f5fe2830b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
