llama-index-readers-openalex


Namellama-index-readers-openalex JSON
Version 0.4.0 PyPI version JSON
download
home_pageNone
Summaryllama-index readers openalex integration
upload_time2025-07-30 20:53:12
maintainershauryr
docs_urlNone
authorNone
requires_python<4.0,>=3.9
licenseNone
keywords academic papers open access openalex scientific papers
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # OpenAlex Reader

```bash
pip install llama-index-readers-openalex
```

This loader will search for papers in OpenAlex and load them in llama-index. The main advantage of using OpenAlex is that you can search the full-text for Open Access papers as well.

## Usage

```python
from llama_index.readers.openalex import OpenAlexReader

openalex_reader = OpenAlexReader(email="shauryr@gmail.com")
query = "biases in large language models"

# changing this to full_text=True will let you search full-text
documents = openalex_reader.load_data(query, full_text=False)
```

## What can it do?

As shown in [demo.ipynb](demo.ipynb) we can get answers with citations.

```python
query = "biases in large language models"
response = query_engine.query(
    "list the biases in large language models in a markdown table"
)
```

#### Output

| Source    | Biases                                                                                           |
| --------- | ------------------------------------------------------------------------------------------------ |
| Source 1  | Data selection bias, social bias (gender, age, sexual orientation, ethnicity, religion, culture) |
| Source 2  | Biases of what is right and wrong to do, reflecting ethical and moral norms of society           |
| Source 3  | Anti-Muslim bias                                                                                 |
| Source 6  | Gender bias                                                                                      |
| Source 9  | Anti-LGBTQ+ bias                                                                                 |
| Source 10 | Potential bias in the output                                                                     |

## Credits

- OpenAlex API details are listed [here](https://docs.openalex.org/how-to-use-the-api/get-lists-of-entities/search-entities)

- Some code adopted from [pyAlex](https://github.com/J535D165/pyalex/blob/435287ac20d84ca047e84c71e2c32a6bb84f61a1/pyalex/api.py#L95)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-readers-openalex",
    "maintainer": "shauryr",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "academic papers, open access, openalex, scientific papers",
    "author": null,
    "author_email": "Your Name <you@example.com>",
    "download_url": "https://files.pythonhosted.org/packages/c6/d9/5e4b69684f7996ed1df0b375435cf04f83972e21d42acc68895af3b808a1/llama_index_readers_openalex-0.4.0.tar.gz",
    "platform": null,
    "description": "# OpenAlex Reader\n\n```bash\npip install llama-index-readers-openalex\n```\n\nThis loader will search for papers in OpenAlex and load them in llama-index. The main advantage of using OpenAlex is that you can search the full-text for Open Access papers as well.\n\n## Usage\n\n```python\nfrom llama_index.readers.openalex import OpenAlexReader\n\nopenalex_reader = OpenAlexReader(email=\"shauryr@gmail.com\")\nquery = \"biases in large language models\"\n\n# changing this to full_text=True will let you search full-text\ndocuments = openalex_reader.load_data(query, full_text=False)\n```\n\n## What can it do?\n\nAs shown in [demo.ipynb](demo.ipynb) we can get answers with citations.\n\n```python\nquery = \"biases in large language models\"\nresponse = query_engine.query(\n    \"list the biases in large language models in a markdown table\"\n)\n```\n\n#### Output\n\n| Source    | Biases                                                                                           |\n| --------- | ------------------------------------------------------------------------------------------------ |\n| Source 1  | Data selection bias, social bias (gender, age, sexual orientation, ethnicity, religion, culture) |\n| Source 2  | Biases of what is right and wrong to do, reflecting ethical and moral norms of society           |\n| Source 3  | Anti-Muslim bias                                                                                 |\n| Source 6  | Gender bias                                                                                      |\n| Source 9  | Anti-LGBTQ+ bias                                                                                 |\n| Source 10 | Potential bias in the output                                                                     |\n\n## Credits\n\n- OpenAlex API details are listed [here](https://docs.openalex.org/how-to-use-the-api/get-lists-of-entities/search-entities)\n\n- Some code adopted from [pyAlex](https://github.com/J535D165/pyalex/blob/435287ac20d84ca047e84c71e2c32a6bb84f61a1/pyalex/api.py#L95)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "llama-index readers openalex integration",
    "version": "0.4.0",
    "project_urls": null,
    "split_keywords": [
        "academic papers",
        " open access",
        " openalex",
        " scientific papers"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "204cf8a7f41d4219a467eaa964dce4c8d662c66c182c741010f795e2fe9ce689",
                "md5": "8eb32b9360947df68190aa5a36bc99c0",
                "sha256": "b19ec5ec4ce3e15c3a6082966c5009797dafc141b621596439060ebae889e020"
            },
            "downloads": -1,
            "filename": "llama_index_readers_openalex-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8eb32b9360947df68190aa5a36bc99c0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 4432,
            "upload_time": "2025-07-30T20:53:11",
            "upload_time_iso_8601": "2025-07-30T20:53:11.596281Z",
            "url": "https://files.pythonhosted.org/packages/20/4c/f8a7f41d4219a467eaa964dce4c8d662c66c182c741010f795e2fe9ce689/llama_index_readers_openalex-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c6d95e4b69684f7996ed1df0b375435cf04f83972e21d42acc68895af3b808a1",
                "md5": "f85a1517691a63709ba97f219baed202",
                "sha256": "a4315684e7aacbcd0d2e9914d8a4e23e460e7d6bf0f6ead4caae5776bf2c9e88"
            },
            "downloads": -1,
            "filename": "llama_index_readers_openalex-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f85a1517691a63709ba97f219baed202",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 4826,
            "upload_time": "2025-07-30T20:53:12",
            "upload_time_iso_8601": "2025-07-30T20:53:12.326002Z",
            "url": "https://files.pythonhosted.org/packages/c6/d9/5e4b69684f7996ed1df0b375435cf04f83972e21d42acc68895af3b808a1/llama_index_readers_openalex-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-30 20:53:12",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-openalex"
}
        
Elapsed time: 2.74896s