run-llama/sec-insights
1
0
Fork 0
mirror of https://github.com/run-llama/sec-insights.git synced 2026-07-01 20:24:03 -04:00
Code Issues 44 Packages Projects Releases Wiki Activity

Update FAQ.md (#40)

Browse Source 
Add note on SEC use-case specific prompts
This commit is contained in:
Sourabh Desai
2023-09-26 13:29:36 -07:00
committed by GitHub
parent b74965f2ae
commit 916a8a4199
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FAQ.md
+6
View File
@@ -31,3 +31,9 @@ Here are some high level steps:
1. Send a message within the newly created conversation with `message <your message here>` e.g. `message What is the document about?`
* The first time that there is a message for a newly inserted document, the backend will need to go through the embedding + indexing process for that document which can take some time.
1. Start chatting away! The platform should now be ready for questions regarding this document within this Chat REPL.
You will also find that some of the prompts used in the application are specific to the SEC Insights use case. These will need to be changed to fit your particular use case. Here's an initial list of places in the codebase that may need to be changed to tune the prompts to your use case:
* [Custom Response Synth prompt](https://github.com/run-llama/sec-insights/blob/e81c839/backend/app/chat/qa_response_synth.py#L15-L48)
* [Vector Index tool descriptions](https://github.com/run-llama/sec-insights/blob/e81c83958a428e2aa02e8cb1280c3a17c55c4aa9/backend/app/chat/engine.py#L295-L296)
* System Message ([template](https://github.com/run-llama/sec-insights/blob/e81c83958a428e2aa02e8cb1280c3a17c55c4aa9/backend/app/chat/constants.py#L3-L17) and [construction](https://github.com/run-llama/sec-insights/blob/e81c83958a428e2aa02e8cb1280c3a17c55c4aa9/backend/app/chat/engine.py#L336))
* [User Message Prefix](https://github.com/run-llama/sec-insights/blob/e81c83958a428e2aa02e8cb1280c3a17c55c4aa9/backend/app/chat/messaging.py#L143-L145)