# Rayyan Loader
```bash
pip install llama-index-readers-rayyan
```
This loader fetches review articles from [Rayyan](https://www.rayyan.ai/)
using the [Rayyan SDK](https://github.com/rayyansys/rayyan-python-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](https://github.com/run-llama/llama_index/).
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-rayyan",
"maintainer": "hammady",
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": "rayyan, systematic review",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/c8/cd/aa7bbc6c2db51a6fdd84a2b2cf396b8160d13b6ec3b2bb85b7e7b2f2217c/llama_index_readers_rayyan-0.2.0.tar.gz",
"platform": null,
"description": "# Rayyan Loader\n\n```bash\npip install llama-index-readers-rayyan\n```\n\nThis loader fetches review articles from [Rayyan](https://www.rayyan.ai/)\nusing the [Rayyan SDK](https://github.com/rayyansys/rayyan-python-sdk). All articles\nfor a given review are fetched by default unless a filter is specified.\n\n## Usage\n\nTo use this loader, you need to specify the path to the Rayyan credentials file\nand optionally the API server URL if different from the default. More details\nabout these parameters can be found in the official Rayyan SDK repository.\n\n```python\nfrom llama_index.readers.rayyan import RayyanReader\n\nloader = RayyanReader(credentials_path=\"path/to/rayyan-creds.json\")\n```\n\nOnce the loader is initialized, you can load data from Rayyan, either all or filtered:\n\n```python\n# Load all documents for a review with ID 123456\ndocuments = loader.load_data(review_id=123456)\n\n# Load only those that contain the word \"outcome\"\ndocuments = loader.load_data(\n review_id=123456, filters={\"search[value]\": \"outcome\"}\n)\n```\n\nThe Rayyan SDK has more information about the available filters.\n\nThis loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers rayyan integration",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [
"rayyan",
" systematic review"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d637c4906ddaa505f51e7ef0155d4174c66f7026de9cb7e60a3c72caee5638e",
"md5": "5a85a08bfa3264171f4fd55c097b97f5",
"sha256": "fae2ea48397666ea1b3d82774fe4631dbf6e21cf8644092ae1d15a89b3b02f24"
},
"downloads": -1,
"filename": "llama_index_readers_rayyan-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a85a08bfa3264171f4fd55c097b97f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3538,
"upload_time": "2024-08-22T06:53:22",
"upload_time_iso_8601": "2024-08-22T06:53:22.960261Z",
"url": "https://files.pythonhosted.org/packages/5d/63/7c4906ddaa505f51e7ef0155d4174c66f7026de9cb7e60a3c72caee5638e/llama_index_readers_rayyan-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c8cdaa7bbc6c2db51a6fdd84a2b2cf396b8160d13b6ec3b2bb85b7e7b2f2217c",
"md5": "2d07cdbf08d6d802be2e718457650061",
"sha256": "34b848ba5567fea1ceff295b31831b532affd37e5df7d112045fb57008d56ac2"
},
"downloads": -1,
"filename": "llama_index_readers_rayyan-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2d07cdbf08d6d802be2e718457650061",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 3324,
"upload_time": "2024-08-22T06:53:23",
"upload_time_iso_8601": "2024-08-22T06:53:23.776169Z",
"url": "https://files.pythonhosted.org/packages/c8/cd/aa7bbc6c2db51a6fdd84a2b2cf396b8160d13b6ec3b2bb85b7e7b2f2217c/llama_index_readers_rayyan-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 06:53:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-rayyan"
}
JSON