Rayyan Loader

bash

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.

python

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:

python

# 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.