update readme and .env.example
This commit is contained in:
parent
18d64d0651
commit
4db069026e
3
hw2/.env.example
Normal file
3
hw2/.env.example
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
GOOGLE_API_KEY=""
|
||||||
|
SERPAPI_API_KEY=""
|
||||||
|
OPENAI_API_KEY=""
|
@ -1,14 +1,27 @@
|
|||||||
|
###### David Westgate 26 April 2024
|
||||||
## HW2 for gensec
|
## HW2 for gensec
|
||||||
|
This appliation is a langchain agent using both provided imported tools and custom tools. This agent is derived from agent and tools example found [here](https://github.com/wu4f/cs410g-src/blob/main/04_Agents) and includes additions to support dall-e image generation, google jobs searching, and ansering of questions related to the game kerbal space program, from the RAG application developed for homework 1.
|
||||||
|
|
||||||
|
|
||||||
### Enviornment
|
### Setup
|
||||||
|
Install python3
|
||||||
|
|
||||||
|
If not already done, we first must load the documents needed for the kerbal space program rag application
|
||||||
|
```
|
||||||
|
cd hw1
|
||||||
|
pip install -r requirnments.txt
|
||||||
|
cp .env.example .env
|
||||||
|
#populate .env with the needed keys
|
||||||
|
python3 loader.py
|
||||||
|
```
|
||||||
|
After this, we can setup our langchain agent
|
||||||
Install python3, then run the following:
|
Install python3, then run the following:
|
||||||
```
|
```
|
||||||
|
cd ../hw2
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
|
#populate .env with the needed keys
|
||||||
```
|
```
|
||||||
After, populate .env with your OPENAI_API_KEY and FIREWALL_API_KEY
|
|
||||||
|
|
||||||
|
|
||||||
### Running
|
### Running
|
||||||
```
|
```
|
||||||
@ -17,8 +30,11 @@ python3 app.py
|
|||||||
|
|
||||||
### Example Queries
|
### Example Queries
|
||||||
```
|
```
|
||||||
|
What is the IP address of dwestgate.us
|
||||||
|
What is the OS version and linux kernel version of the current machine?
|
||||||
|
Generate an image of a gray calico cat about to pounce on a laser pointer dot
|
||||||
|
Find an AI related software job posting near Portland, Oregon
|
||||||
|
Tell me about the planet Duna
|
||||||
```
|
```
|
||||||
|
|
||||||
Enjoy!
|
Enjoy!
|
Reference in New Issue
Block a user