Skip to content

Commit

Permalink
add jsm notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jonmatthis committed Feb 12, 2024
1 parent f62d3e4 commit 94cfa17
Show file tree
Hide file tree
Showing 4 changed files with 116 additions and 6 deletions.
12 changes: 7 additions & 5 deletions Writerside/s.tree
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,21 @@

<toc-element topic="Overview.md">
<toc-element topic="SkellyBot-Server-Setup-Guide.md"/>
<toc-element topic="ProjectNotes.md">
<toc-element topic="Development.md">
<toc-element topic="ProjectNotes.md"/>
<toc-element topic="Onboarding.md"/>
<toc-element topic="Environment-Setup.md"/>
</toc-element>
<toc-element topic="Environment-Setup.md"/>
<toc-element topic="Onboarding.md"/>
<toc-element topic="2024-02-12-JSM-Notes.md"/>
</toc-element>
<toc-element topic="Concepts.md">
<toc-element topic="SkellyBot.md">
<toc-element topic="JonBot.md">
<toc-element topic="ClassBot.md">
<toc-element topic="GolemGarden.md"/>
</toc-element>
</toc-element>
</toc-element>
</toc-element>
<toc-element topic="Concepts.md">
<toc-element topic="ContextRoute.md">
<toc-element topic="User.md">
<toc-element topic="Interfaces.md">
Expand Down
105 changes: 105 additions & 0 deletions Writerside/topics/2024-02-12-JSM-Notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# 2024-02-12-Project-Planning-Notes

## JSM
### User Stories for SkellyBot Software

#### Nightly Tasks

- Configure cron jobs to:
- Send messages to users
- Extract data from a server
- Process stored data
- Configurable via DMs or as an embed in the server

#### Vector Store Memory

- Add vector store memory to the bot
- Set context as part of chat functionality configuration

#### Data Analysis Jobs

- Analyze gathered data from the server
- Summarize chats and extract tags
- Attach analyses to cron jobs

#### Data-Based Messaging

- Send messages based on data from the server
- Run analysis on user data and send reports
- Set message duration and frequency through backend or config file system

### Developer Perspective on User Stories

#### Nightly Tasks Implementation

- Implement a cron job module in the core process
- Trigger independently of any interface
- Configuration through Discord
- Use slash commands or message context commands
- Accept configuration files in JSON or YAML format
- Utilize Discord attachment handler for file loading
- Cron job module to create and track jobs
- Ensure triggering at correct intervals

#### Vector Store Memory Development

##### Processing Step

- Message processing through AI module for:
- Tag extraction
- Summarization
- Vector embedding
- Core database models to include:
- Tags
- Summaries
- Embeddings

##### Database Integration

- Processing assumed to be part of database entry route
- Option to trigger processing on the entire database

##### AI Data Extraction

- Extract AI data from messages upon changes
- Options for reprocessing:
- Immediate for each change
- Incremental updates
- Utilizing local models for cost efficiency

##### Retrieval Augmented Generation

- Set up retrievers as AI tools
- Use large language models to:
- Determine context relevance
- Generate queries from inputs
- Stuff retrieved data into chat context
- Track metadata of extracted documents
- Include sources in the response to users
- Attach retrieval reports to messages in a presentable format

##### Data Analysis Jobs and Database Messaging

- Sending processed data to users, channels, or servers

###### Types of Analyses

- Volume and structure analyses:
- Counting messages, characters, tokens, chats, channels, servers
- Natural language processing tasks:
- Summarizing chats
- Extracting tags
- Vector store embeddings
- Running prompts for data processing

##### Summarization and Tag Extraction

- Raw summarization
- Simple analysis tasks with basic prompts

##### Analyses Requiring Additional Documents

- Analyses dependent on external references
- Example: Cron job sending feedback to a student based on rubric progress
- Evaluate student's conversation and assignment data
- Message students about their progress, plan adjustments, or action changes
3 changes: 3 additions & 0 deletions Writerside/topics/Development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Development

Start typing here...
2 changes: 1 addition & 1 deletion Writerside/topics/ProjectNotes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Project Notes
# 2023-12-31 Project Notes

## Services:
### [Discord](Discord)
Expand Down

0 comments on commit 94cfa17

Please sign in to comment.