SEC-copilot 🤖

Demo

An AI copilot allowing users ask natural language questions and get answers about SEC fillings of their choice companies | using Langchain🦜 | OpenAI | Streamlit ⚡| Kay

To use this app, you would need API keys from OpenAI and Kay

Architecture ⚙️

Quick Start 🚀

App URL: SEC-copilot

Running Locally 💻

Follow these steps to set up and run the service locally :

Prerequisites

Python 3.8 or higher
LangChain
Streamlit
Git

Installation

Clone the repository :

git clone https://github.com/Urias-T/SEC-copilot

Navigate to the project directory :

cd sec_copilot

Create a virtual environment :

python -m venv venv
venv/Scripts/activate

Install the required dependencies in the virtual environment :

pip install -r requirements.txt

Launch the copilot service locally :

streamlit run app.py

That's it! The service is now up and running on localhost:8501. 🤗

With Docker 🐋

To run this as a docker container:

Clone the repository:

git clone https://github.com/Urias-T/SEC-copilot

Navigate to the project directory :

cd sec_copilot

Build the Docker image:

docker build --build-arg OPENAI_API_KEY=<your_openai_api_key> --build-arg KAY_API_KEY=<your_kay_api_key> -t sec-copilot .

Remeber to replace <your_openai_api_key> and <your_kay_api_key> with your actual API keys

Run the Docker container:

docker run -p 8080:8501 -d sec-copilot

Congratulations, your service will be running on localhost:8080 🎉

Contributing 🙌🏽

If you want to contribute to this project, please open an issue and submit a pull request.

License ⚖️

This project is made available under the MIT License.