Skip to main content

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.

Metadata

Release files for llama-index-readers-rayyan 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llama-index-readers-rayyan 0.6.0
File Size Uploaded Provenance Actions
llama_index_readers_rayyan-0.6.0.tar.gz 4.8 kB Without provenance Details for llama_index_readers_rayyan-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for llama-index-readers-rayyan 0.6.0
File Interpreter ABI Platform Actions
llama_index_readers_rayyan-0.6.0-py3-none-any.whl Python 3 none any Details for llama_index_readers_rayyan-0.6.0-py3-none-any.whl

Total release size: 9.1 kB

Release files / llama_index_readers_rayyan-0.6.0.tar.gz

Download URL llama_index_readers_rayyan-0.6.0.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
535fb23e347619ee02015f4184d0f72eba78a8eb7c1374d967fcc30441ab2617
BLAKE2b-256 checksum
How to use checksums
14e8c8e55a10969a0c309684c17c33da97cc340f37c5fc68add35ba2a5a00289
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_readers_rayyan-0.6.0-py3-none-any.whl

Download URL llama_index_readers_rayyan-0.6.0-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c48a22322490b3b5b316311f63bb6a23ef744744858ccd80e20e62cc8938ce8a
BLAKE2b-256 checksum
How to use checksums
1576590df8b54389d94d17e49829d7867d1c46dad706796dcac3aea302c78bc9
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}

Security for llama-index-readers-rayyan 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page