Skip to content

Commit

Permalink
doc: adding more detailed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BachNgoH committed Jun 19, 2024
1 parent fd34302 commit a4d67cf
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 2 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,24 @@ python src/paper_ingest.py

**Starting the Application**

Before starting your application, you need to fill in some evironment variables. Create a `.env` file and fill in these:

```bash
# LLM Provider
OPENAI_API_KEY=
GROQ_API_KEY= # (Optional)
GOOGLE_API_KEY=

# For Searching
SERPER_API_KEY=

# Email Sending
SENDGRID_API_KEY= # (Optional)
CHAINLIT_AUTH_SECRET=

```
You can create th `CHAINLIT_AUTH_SECRET` by running the command `chainlit create-secret`.

Once everything is ready, you can launch the application by running:

```bash
Expand Down
1 change: 0 additions & 1 deletion app.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import sys
from fastapi import FastAPI
from dotenv import load_dotenv
from api.controller import router
Expand Down
2 changes: 1 addition & 1 deletion src/tools/paper_search_tool.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ def retrieve_paper(query_str: str, start_date: str = None, end_date: str = None)
operator=FilterOperator.GTE,
value=datetime.strptime(start_date, "%Y-%m-%d").timestamp()))

if end_date is not None:
if end_date is not None and end_date != '':
filters.filters.append(
MetadataFilter(
key="date",
Expand Down

0 comments on commit a4d67cf

Please sign in to comment.