ASSISTANT FOR YOU !

A diligent assistant will assist you!

Have you ever felt the need to follow a document or URL when using LLM ? It's your assistant's turn! The assistant receives a list of references and creates his own bookshelf. He will chat with us and answer QA based on the contents of his own bookshelf!

📝 Requirements

• git
• python >= 3.11
• OPENAI_API_KEY

🚀 Quickstart

Step 1 - download and install assistant with git clone & pip

$ git clone https://github.com/sakakibara-yuuki/assistant.git
$ cd assistant
$ pip install -e .

Step 2 - set OPNEAI_API_KEY

$ export OPENAI_API_KEY = "your_openai_api_key_here!"

Step 3 - Write a list of articles you want your assistant to refer to in the reference.yaml file.

files:
  - hogehoge.txt
  - hogehoge.pdf
  - https://hoghoge/index.html

Step 4 - Give the reference.yaml file to your assistant to create a bookshelf.

$ python -m assistant bookshelf -u reference.yaml

Step 5 - Let your assistant help you!

$ python -m assistant chat
> you: what is prarie dog?
> A  : prarie dog is ...
> you: bye
> A  : bye!

or

$ python -m assistant qa -p prompt.txt
> A  : prarie dog is ...

or

$ python -m assistant qa -i 
> you:  what is prarie dog?
> A  : prarie dog is ...

Documents

For more detailed programme content, click HERE!!