Rayyan Loader
pip install llama-index-readers-rayyan
This loader fetches review articles from Rayyan using the Rayyan SDK. All articles for a given review are fetched by default unless a filter is specified.
Usage
To use this loader, you need to specify the path to the Rayyan credentials file and optionally the API server URL if different from the default. More details about these parameters can be found in the official Rayyan SDK repository.
from llama_index.readers.rayyan import RayyanReader
loader = RayyanReader(credentials_path="path/to/rayyan-creds.json")
Once the loader is initialized, you can load data from Rayyan, either all or filtered:
# Load all documents for a review with ID 123456
documents = loader.load_data(review_id=123456)
# Load only those that contain the word "outcome"
documents = loader.load_data(
review_id=123456, filters={"search[value]": "outcome"}
)
The Rayyan SDK has more information about the available filters.
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_rayyan-0.6.0.tar.gz.
File metadata
- Download URL: llama_index_readers_rayyan-0.6.0.tar.gz
- Upload date:
- Size: 4.8 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 |
535fb23e347619ee02015f4184d0f72eba78a8eb7c1374d967fcc30441ab2617
|
|
| MD5 |
b8d969552c23c7f42b06891b770bae88
|
|
| BLAKE2b-256 |
14e8c8e55a10969a0c309684c17c33da97cc340f37c5fc68add35ba2a5a00289
|
File details
Details for the file llama_index_readers_rayyan-0.6.0-py3-none-any.whl.
File metadata
- Download URL: llama_index_readers_rayyan-0.6.0-py3-none-any.whl
- Upload date:
- Size: 4.4 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 |
c48a22322490b3b5b316311f63bb6a23ef744744858ccd80e20e62cc8938ce8a
|
|
| MD5 |
fc465f22803301f9ccad3f6a187147f6
|
|
| BLAKE2b-256 |
1576590df8b54389d94d17e49829d7867d1c46dad706796dcac3aea302c78bc9
|
