https://github.com/trangdata/askalex
An LLM-based tool for literature synthesis
https://github.com/trangdata/askalex
knowledge-graph llm openai openalex shiny
Last synced: 10 months ago
JSON representation
An LLM-based tool for literature synthesis
- Host: GitHub
- URL: https://github.com/trangdata/askalex
- Owner: trangdata
- License: mit
- Created: 2023-11-08T16:29:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T16:07:43.000Z (over 1 year ago)
- Last Synced: 2025-04-09T06:06:12.441Z (11 months ago)
- Topics: knowledge-graph, llm, openai, openalex, shiny
- Language: Python
- Homepage:
- Size: 4.13 MB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# AskAlex
AskAlex is a minimal Python Shiny app that integrates [OpenAI](https://platform.openai.com/docs) and [OpenAlex](https://openalex.org/) knowledge graph to optimize literature aggregation.
Given a scientific question from the user, AskAlex searches the OpenAlex database for 100 most relevant articles, uses semantic search to find the best 10 abstracts, and includes them in the prompt sent to OpenAI along with your original question.
Output is the OpenAI response and relevant articles.
Currently, the app works with [Azure OpenAI endpoints](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference).
## ⚙️ Setup
Assuming you have `conda` installed, you first want to create a new conda environment named `askalex` and install the necessary dependencies:
``` sh
conda create --name askalex
conda activate askalex
conda install pip
pip install -r requirements.txt
```
You will also need the following environment variables in your `.env` file:
```
OPENAI_API_TYPE = azure
OPENAI_API_KEY
OPENAI_API_BASE
OPENAI_API_VERSION = 2023-05-15
APP_RUN = local # or connect_server
```
and optionally:
```
OPENAI_PROXY
OPENALEX_API_KEY
COMPANY_PROXY
COMPANY_NO_PROXY
```
Finally, you may need to modify the `model_engine_dict` variable in [`app.py`](app.py) to match the your company's available models on Azure.
## 🌿 Run app
``` sh
# conda activate askalex
shiny run --port 56486 --reload app.py
```
## 🛤️ Roadmap
- fix token issue for text-davinci-003
- use openai endpoint
- add community key for public use
- incorporate full text?
- improve OpenAlex search (currently performing abstract search)
## 🤝 Contributing
Thank you for considering contributing!
Please open an issue to discuss a contribution you'd like to implement to make this app better.