LlamaIndex Readers Integration: Faiss
Overview
Faiss Reader retrieves documents through an existing in-memory Faiss index. These documents can then be used in a downstream LlamaIndex data structure. If you wish to use Faiss itself as an index to organize documents, insert documents, and perform queries on them, please use VectorStoreIndex with FaissVectorStore.
Installation
You can install Faiss Reader via pip:
pip install llama-index-readers-faiss
Usage
from llama_index.readers.faiss import FaissReader
# Initialize FaissReader with an existing Faiss Index object
reader = FaissReader(index="<Faiss Index Object>")
# Load data from Faiss
documents = reader.load_data(
query="<Query Vector>", # 2D numpy array of query vectors
id_to_text_map={"<ID>": "<Text>"}, # A map from IDs to text
k=4, # Number of nearest neighbors to retrieve
separate_documents=True, # Whether to return separate documents
)
This loader is designed to be used as a way to load data into LlamaIndex.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file llama_index_readers_faiss-0.6.0.tar.gz.
File metadata
- Download URL: llama_index_readers_faiss-0.6.0.tar.gz
- Upload date:
- Size: 4.2 kB
- Tags: Source
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a7f717ec468b90aa5fbf83c6203ca431c1a710c0426bb3540f7a6b6a786eac8
|
|
| MD5 |
223f40057f702e2ae5c36b10e98b6cf1
|
|
| BLAKE2b-256 |
d79d2ae42c7e2c05bf70c91adfddba1a4ae1c5fb6af50bb64cacaffa30c2ba50
|
File details
Details for the file llama_index_readers_faiss-0.6.0-py3-none-any.whl.
File metadata
- Download URL: llama_index_readers_faiss-0.6.0-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6879c0716fd12314577235f81b5178bfc51b140458329f12fdd6671195e8882
|
|
| MD5 |
dee2f215bb92fbad47935568771f1fbd
|
|
| BLAKE2b-256 |
fa4fb3df8843b77636f2b31f3650d5fdf87259c07d29a64c75b52668cbb9aa1f
|
