Text Generation
English
opsiie
artificial-intelligence
self-centered-intelligence
sci
ai-assistant
multi-modal
image-generation
video-generation
music-generation
conversational-ai
blockchain
web3
facial-recognition
voice-synthesis
bioinformatics
financial-intelligence
text-classification
sentiment-analysis
token-classification
ner
question-answering
fill-mask
summarization
translation
text2text-generation
zero-shot-classification
image-classification
image-segmentation
object-detection
image-to-text
text-to-image
image-to-image
audio-classification
automatic-speech-recognition
text-to-speech
video-classification
depth-estimation
document-question-answering
visual-question-answering
zero-shot-image-classification
zero-shot-audio-classification
zero-shot-object-detection
feature-extraction
image-feature-extraction
mask-generation
table-question-answering
text-to-audio
Upload 33 files
Browse files- .gitattributes +4 -0
- documentation/README.md +99 -0
- documentation/advanced-features/README.md +79 -0
- documentation/advanced-features/agentic-network.md +44 -0
- documentation/advanced-features/dna-analysis.md +43 -0
- documentation/advanced-features/financial-intelligence.md +213 -0
- documentation/advanced-features/web3-blockchain.md +196 -0
- documentation/api-reference/README.md +25 -0
- documentation/api-reference/command-reference.md +319 -0
- documentation/api-reference/error-codes.md +59 -0
- documentation/core-features/README.md +87 -0
- documentation/core-features/ai-generation.md +555 -0
- documentation/core-features/communication.md +107 -0
- documentation/core-features/document-intelligence.md +75 -0
- documentation/core-features/memory.md +498 -0
- documentation/core-features/voice.md +502 -0
- documentation/getting-started/configuration.md +393 -0
- documentation/getting-started/first-run.md +418 -0
- documentation/getting-started/installation.md +217 -0
- documentation/system-architecture/README.md +36 -0
- documentation/system-architecture/core-components.md +45 -0
- documentation/system-architecture/security-model.md +50 -0
- documentation/system-architecture/technology-stack.md +254 -0
- documentation/user-guides/README.md +74 -0
- documentation/user-guides/basic-commands.md +126 -0
- documentation/user-guides/first-time-user.md +250 -0
- documentation/user-guides/memory-management.md +249 -0
- documentation/user-guides/quick-start.md +102 -0
- system_sounds/alert.mp3 +3 -0
- system_sounds/drill.mp3 +3 -0
- system_sounds/gb.mp3 +0 -0
- system_sounds/heal.mp3 +3 -0
- system_sounds/helpbell.mp3 +0 -0
- system_sounds/opsiieboot.mp3 +3 -0
.gitattributes
CHANGED
|
@@ -34,3 +34,7 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
| 36 |
greeting.mp3 filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
| 36 |
greeting.mp3 filter=lfs diff=lfs merge=lfs -text
|
| 37 |
+
system_sounds/alert.mp3 filter=lfs diff=lfs merge=lfs -text
|
| 38 |
+
system_sounds/drill.mp3 filter=lfs diff=lfs merge=lfs -text
|
| 39 |
+
system_sounds/heal.mp3 filter=lfs diff=lfs merge=lfs -text
|
| 40 |
+
system_sounds/opsiieboot.mp3 filter=lfs diff=lfs merge=lfs -text
|
documentation/README.md
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# OPSIIE 0.3.79 XP Documentation
|
| 2 |
+
|
| 3 |
+
**Self-Centered Intelligence - AI with Memory and Personality**
|
| 4 |
+
|
| 5 |
+
OPSIIE is an advanced AI system with long-term memory, voice interaction, and multi-modal capabilities.
|
| 6 |
+
|
| 7 |
+
## π What is OPSIIE?
|
| 8 |
+
|
| 9 |
+
- π§ **Memory** - Mnemonic Matrix stores conversations
|
| 10 |
+
- π€ **Voice** - Full voice interaction
|
| 11 |
+
- π¨ **Generation** - Images, videos, music
|
| 12 |
+
- π§ **Email** - Gmail integration
|
| 13 |
+
- π **Documents** - PDF, CSV, DOCX analysis
|
| 14 |
+
- π€ **Agents** - Nyx, G1, Kronos (R-Grade)
|
| 15 |
+
- 𧬠**DNA** - Bioinformatics (R-Grade)
|
| 16 |
+
- π **Markets** - Financial data (R-Grade)
|
| 17 |
+
- π **Web3** - Blockchain operations (R-Grade)
|
| 18 |
+
|
| 19 |
+
## π Documentation
|
| 20 |
+
|
| 21 |
+
### π― [Getting Started](getting-started/installation.md)
|
| 22 |
+
- [Installation](getting-started/installation.md)
|
| 23 |
+
- [Configuration](getting-started/configuration.md)
|
| 24 |
+
- [First Run](getting-started/first-run.md)
|
| 25 |
+
|
| 26 |
+
### π [User Guides](user-guides/README.md)
|
| 27 |
+
- [Quick Start](user-guides/quick-start.md)
|
| 28 |
+
- [First Time User](user-guides/first-time-user.md)
|
| 29 |
+
- [Basic Commands](user-guides/basic-commands.md)
|
| 30 |
+
- [Memory Management](user-guides/memory-management.md)
|
| 31 |
+
|
| 32 |
+
### β‘ [Core Features](core-features/README.md)
|
| 33 |
+
- [Memory System](core-features/memory.md)
|
| 34 |
+
- [Voice Interaction](core-features/voice.md)
|
| 35 |
+
- [AI Generation](core-features/ai-generation.md)
|
| 36 |
+
- [Communication](core-features/communication.md)
|
| 37 |
+
- [Document Intelligence](core-features/document-intelligence.md)
|
| 38 |
+
|
| 39 |
+
### π [Advanced Features](advanced-features/README.md)
|
| 40 |
+
R-Grade required:
|
| 41 |
+
- [Agentic Network](advanced-features/agentic-network.md)
|
| 42 |
+
- [DNA Analysis](advanced-features/dna-analysis.md)
|
| 43 |
+
- [Financial Intelligence](advanced-features/financial-intelligence.md)
|
| 44 |
+
- [Web3 & Blockchain](advanced-features/web3-blockchain.md)
|
| 45 |
+
|
| 46 |
+
### π [API Reference](api-reference/README.md)
|
| 47 |
+
- [Command Reference](api-reference/command-reference.md)
|
| 48 |
+
- [Error Codes](api-reference/error-codes.md)
|
| 49 |
+
|
| 50 |
+
### ποΈ [System Architecture](system-architecture/README.md)
|
| 51 |
+
- [Core Components](system-architecture/core-components.md)
|
| 52 |
+
- [Security Model](system-architecture/security-model.md)
|
| 53 |
+
- [Technology Stack](system-architecture/technology-stack.md)
|
| 54 |
+
|
| 55 |
+
## π Access Levels
|
| 56 |
+
|
| 57 |
+
**R-Grade (Master)**: ARPA ID R### - Full access
|
| 58 |
+
**A-Grade (Standard)**: ARPA ID A### - Core features only
|
| 59 |
+
|
| 60 |
+
## π Essential Commands
|
| 61 |
+
|
| 62 |
+
**All Users**:
|
| 63 |
+
```bash
|
| 64 |
+
/recall, /memorize, /forget, /soulsig
|
| 65 |
+
/voice, /voice1, /voice2
|
| 66 |
+
/imagine, /video, /music
|
| 67 |
+
/mail, /read
|
| 68 |
+
/status, /theme, /help
|
| 69 |
+
```
|
| 70 |
+
|
| 71 |
+
**R-Grade Only**:
|
| 72 |
+
```bash
|
| 73 |
+
/ask, /ask live, /room
|
| 74 |
+
/markets, /markets compare
|
| 75 |
+
/dna
|
| 76 |
+
/0x buy, /0x sell, /0x send
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
## π Quick Start
|
| 80 |
+
|
| 81 |
+
```bash
|
| 82 |
+
# Install
|
| 83 |
+
pip install -r requirements.txt
|
| 84 |
+
|
| 85 |
+
# Configure .env and kun.py
|
| 86 |
+
|
| 87 |
+
# Run
|
| 88 |
+
python OPSIIE_0_3_79_XP.py
|
| 89 |
+
```
|
| 90 |
+
|
| 91 |
+
## π Support
|
| 92 |
+
|
| 93 |
+
Email: opsiebyarpa@gmail.com
|
| 94 |
+
|
| 95 |
+
---
|
| 96 |
+
|
| 97 |
+
**Intelligence meets personality.** β¨
|
| 98 |
+
|
| 99 |
+
*ARPA Corporation*
|
documentation/advanced-features/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Advanced Features
|
| 2 |
+
|
| 3 |
+
Specialized capabilities for R-Grade users including AI agents, DNA analysis, financial intelligence, and Web3.
|
| 4 |
+
|
| 5 |
+
## π Feature Overview
|
| 6 |
+
|
| 7 |
+
### [Agentic Network](agentic-network.md) π€
|
| 8 |
+
Multi-agent collaboration with Nyx, G1 Black, and Kronos.
|
| 9 |
+
- `/ask <agent>` - Query AI agents
|
| 10 |
+
- `/ask g1 live` - Real-time voice
|
| 11 |
+
- `/room` - Collaboration spaces
|
| 12 |
+
|
| 13 |
+
### [DNA Analysis](dna-analysis.md) π§¬
|
| 14 |
+
GDDA bioinformatics system.
|
| 15 |
+
- `/dna <sequence>` - Analyze DNA/RNA/Protein
|
| 16 |
+
- Structure prediction
|
| 17 |
+
- Homology search
|
| 18 |
+
- Database cross-refs
|
| 19 |
+
|
| 20 |
+
### [Financial Intelligence](financial-intelligence.md) π
|
| 21 |
+
Real-time market data via Yahoo Finance.
|
| 22 |
+
- `/markets <stock>` - Stock data
|
| 23 |
+
- `/markets <crypto>` - Crypto prices
|
| 24 |
+
- `/markets compare` - Stock comparison
|
| 25 |
+
|
| 26 |
+
### [Web3 & Blockchain](web3-blockchain.md) π
|
| 27 |
+
Multi-chain operations on Base, Ethereum, Polygon.
|
| 28 |
+
- `/0x buy/sell` - Token trading
|
| 29 |
+
- `/0x send` - Transfers
|
| 30 |
+
- `/0x receive` - View wallets
|
| 31 |
+
|
| 32 |
+
## β οΈ Access Requirements
|
| 33 |
+
|
| 34 |
+
**All advanced features require R-Grade (Master) access.**
|
| 35 |
+
|
| 36 |
+
R-Grade users have `arpa_id` starting with 'R' in kun.py:
|
| 37 |
+
```python
|
| 38 |
+
'arpa_id': 'R001' # R-Grade Master access
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
A-Grade users (`arpa_id` starting with 'A') cannot access these features.
|
| 42 |
+
|
| 43 |
+
## π Quick Examples
|
| 44 |
+
|
| 45 |
+
**Agentic Network:**
|
| 46 |
+
```bash
|
| 47 |
+
/ask Nyx Design a blockchain voting system
|
| 48 |
+
/ask g1 live
|
| 49 |
+
/room nyx, g1: Quantum computing
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
**DNA Analysis:**
|
| 53 |
+
```bash
|
| 54 |
+
/dna ATGCGTAACGGCATTAGC
|
| 55 |
+
/dna --verbose --homology MAKVLISPKQW
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
**Financial:**
|
| 59 |
+
```bash
|
| 60 |
+
/markets tesla
|
| 61 |
+
/markets btc
|
| 62 |
+
/markets compare tsla nio
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
**Web3:**
|
| 66 |
+
```bash
|
| 67 |
+
/0x buy 10 degen using eth on base
|
| 68 |
+
/0x send base eth 0.1 to Ross
|
| 69 |
+
/0x receive
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
+
## π Learn More
|
| 73 |
+
|
| 74 |
+
- [Command Reference](../api-reference/command-reference.md)
|
| 75 |
+
- [System Architecture](../system-architecture/core-components.md)
|
| 76 |
+
|
| 77 |
+
---
|
| 78 |
+
|
| 79 |
+
**Advanced features for power users.** β‘
|
documentation/advanced-features/agentic-network.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Agentic Network & Rooms
|
| 2 |
+
|
| 3 |
+
Multi-agent collaboration system with Nyx, G1 Black, and Kronos agents.
|
| 4 |
+
|
| 5 |
+
## π€ Agents
|
| 6 |
+
|
| 7 |
+
**OPSIIE**: Main coordinator, all features
|
| 8 |
+
**Nyx (OpenAI)**: Blockchain, AI, Python prototyping
|
| 9 |
+
**G1 Black (Gemini)**: Quantum, technical analysis, live voice
|
| 10 |
+
**Kronos**: Greek auditing, compliance, live voice
|
| 11 |
+
|
| 12 |
+
## π Commands
|
| 13 |
+
|
| 14 |
+
### /ask Agent
|
| 15 |
+
```bash
|
| 16 |
+
/ask Nyx <prompt>
|
| 17 |
+
/ask G1 <prompt>
|
| 18 |
+
/ask Kronos <prompt>
|
| 19 |
+
```
|
| 20 |
+
|
| 21 |
+
### Live Voice
|
| 22 |
+
```bash
|
| 23 |
+
/ask g1 live # Real-time voice with G1
|
| 24 |
+
/ask kronos live # Real-time voice with Kronos
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
### Rooms
|
| 28 |
+
```bash
|
| 29 |
+
/room <agents>: <theme>
|
| 30 |
+
/room nyx, g1: Quantum computing
|
| 31 |
+
/close # Close and save room
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
+
## π§ Setup
|
| 35 |
+
|
| 36 |
+
Requires R-Grade access and API keys in .env:
|
| 37 |
+
- OPENAI_API_KEY
|
| 38 |
+
- GOOGLE_API_KEY
|
| 39 |
+
- G1_VOICE_LIVE
|
| 40 |
+
- KRONOS_LIVE
|
| 41 |
+
|
| 42 |
+
---
|
| 43 |
+
|
| 44 |
+
**Collaborative intelligence.**
|
documentation/advanced-features/dna-analysis.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# DNA Analysis - GDDA System
|
| 2 |
+
|
| 3 |
+
Genetic Due Diligence Analysis (GDDA) v0.21 XP for bioinformatics.
|
| 4 |
+
|
| 5 |
+
## 𧬠Command
|
| 6 |
+
|
| 7 |
+
### /dna - Analyze Sequence
|
| 8 |
+
```bash
|
| 9 |
+
/dna <sequence> [options]
|
| 10 |
+
```
|
| 11 |
+
|
| 12 |
+
**Examples:**
|
| 13 |
+
```bash
|
| 14 |
+
/dna ATGCGTAACGGCATTAGC # DNA
|
| 15 |
+
/dna AUGCGUAACGGCAUUAGC # RNA
|
| 16 |
+
/dna MAKVLISPKQW # Protein
|
| 17 |
+
/dna --verbose ATGCGTAACGGC # Detailed
|
| 18 |
+
/dna --homology MAKVLISPKQW # With search
|
| 19 |
+
```
|
| 20 |
+
|
| 21 |
+
## π¬ Features
|
| 22 |
+
|
| 23 |
+
**Basic**: Type detection, GC content, k-mer frequency
|
| 24 |
+
**Structure**: DNA melting temp, RNA secondary, protein prediction
|
| 25 |
+
**Advanced**: Homology search, patents, literature
|
| 26 |
+
**RNA**: miRNA sites, siRNA regions, Rfam/miRBase refs
|
| 27 |
+
**Protein**: Weight, localization, UniProt/Pfam refs
|
| 28 |
+
|
| 29 |
+
## βοΈ Options
|
| 30 |
+
|
| 31 |
+
`--verbose` `--type` `--format` `--export` `--homology` `--structure` `--patents` `--literature`
|
| 32 |
+
|
| 33 |
+
## π§ Setup
|
| 34 |
+
|
| 35 |
+
```env
|
| 36 |
+
NCBI_EMAIL=your_email@example.com
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
**R-Grade Required**
|
| 40 |
+
|
| 41 |
+
---
|
| 42 |
+
|
| 43 |
+
**Bioinformatics intelligence.** π§¬
|
documentation/advanced-features/financial-intelligence.md
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Financial Intelligence - Markets
|
| 2 |
+
|
| 3 |
+
Real-time financial data analysis for stocks, crypto, and currencies via Yahoo Finance.
|
| 4 |
+
|
| 5 |
+
## π Overview
|
| 6 |
+
|
| 7 |
+
Market analysis features:
|
| 8 |
+
- Stock data and news
|
| 9 |
+
- Cryptocurrency prices
|
| 10 |
+
- Currency exchange rates
|
| 11 |
+
- Company financials
|
| 12 |
+
- Stock comparison
|
| 13 |
+
- Technical analysis
|
| 14 |
+
|
| 15 |
+
## π Commands
|
| 16 |
+
|
| 17 |
+
### /markets - Get Market Data
|
| 18 |
+
```bash
|
| 19 |
+
/markets <keyword> [extra]
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
**Examples:**
|
| 23 |
+
```bash
|
| 24 |
+
# Stocks
|
| 25 |
+
/markets tesla
|
| 26 |
+
/markets shell
|
| 27 |
+
/markets nio
|
| 28 |
+
|
| 29 |
+
# Crypto
|
| 30 |
+
/markets btc
|
| 31 |
+
/markets eth
|
| 32 |
+
/markets doge
|
| 33 |
+
|
| 34 |
+
# Currencies
|
| 35 |
+
/markets usd
|
| 36 |
+
/markets eur
|
| 37 |
+
|
| 38 |
+
# Detailed analysis
|
| 39 |
+
/markets tesla statistics
|
| 40 |
+
/markets shell financials
|
| 41 |
+
/markets nio analysis
|
| 42 |
+
|
| 43 |
+
# Compare stocks
|
| 44 |
+
/markets compare tsla nio
|
| 45 |
+
/markets compare aapl msft
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## π Data Types
|
| 49 |
+
|
| 50 |
+
### Basic Stock Data
|
| 51 |
+
```bash
|
| 52 |
+
/markets <company>
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
Shows:
|
| 56 |
+
- Current price
|
| 57 |
+
- Performance metrics
|
| 58 |
+
- Price chart (ASCII)
|
| 59 |
+
- Top news articles
|
| 60 |
+
|
| 61 |
+
### Cryptocurrency
|
| 62 |
+
```bash
|
| 63 |
+
/markets <crypto>
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
Shows:
|
| 67 |
+
- Latest price
|
| 68 |
+
- Performance (1d, 7d, 30d)
|
| 69 |
+
- Market cap
|
| 70 |
+
- Circulating supply
|
| 71 |
+
- Volume
|
| 72 |
+
- ASCII chart
|
| 73 |
+
|
| 74 |
+
### Currency Exchange
|
| 75 |
+
```bash
|
| 76 |
+
/markets <currency>
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
Shows:
|
| 80 |
+
- Current exchange rate
|
| 81 |
+
- Performance data
|
| 82 |
+
- Volume and range
|
| 83 |
+
- ASCII chart
|
| 84 |
+
|
| 85 |
+
### Detailed Analysis
|
| 86 |
+
|
| 87 |
+
**statistics:**
|
| 88 |
+
```bash
|
| 89 |
+
/markets <company> statistics
|
| 90 |
+
```
|
| 91 |
+
Key stats, valuation, financial highlights
|
| 92 |
+
|
| 93 |
+
**history:**
|
| 94 |
+
```bash
|
| 95 |
+
/markets <company> history
|
| 96 |
+
```
|
| 97 |
+
Historical price data
|
| 98 |
+
|
| 99 |
+
**profile:**
|
| 100 |
+
```bash
|
| 101 |
+
/markets <company> profile
|
| 102 |
+
```
|
| 103 |
+
Industry, sector, employees, business summary
|
| 104 |
+
|
| 105 |
+
**financials:**
|
| 106 |
+
```bash
|
| 107 |
+
/markets <company> financials
|
| 108 |
+
```
|
| 109 |
+
Financial statements
|
| 110 |
+
|
| 111 |
+
**analysis:**
|
| 112 |
+
```bash
|
| 113 |
+
/markets <company> analysis
|
| 114 |
+
```
|
| 115 |
+
Analyst recommendations and estimates
|
| 116 |
+
|
| 117 |
+
**options:**
|
| 118 |
+
```bash
|
| 119 |
+
/markets <company> options
|
| 120 |
+
```
|
| 121 |
+
Options chain and expiration dates
|
| 122 |
+
|
| 123 |
+
**holders:**
|
| 124 |
+
```bash
|
| 125 |
+
/markets <company> holders
|
| 126 |
+
```
|
| 127 |
+
Major and institutional shareholders
|
| 128 |
+
|
| 129 |
+
**sustainability:**
|
| 130 |
+
```bash
|
| 131 |
+
/markets <company> sustainability
|
| 132 |
+
```
|
| 133 |
+
ESG scores and metrics
|
| 134 |
+
|
| 135 |
+
### Stock Comparison
|
| 136 |
+
```bash
|
| 137 |
+
/markets compare <stock1> <stock2>
|
| 138 |
+
```
|
| 139 |
+
|
| 140 |
+
Compares:
|
| 141 |
+
- Market capitalization
|
| 142 |
+
- Revenue growth
|
| 143 |
+
- Profit margins
|
| 144 |
+
- Financial ratios
|
| 145 |
+
- P/E ratio
|
| 146 |
+
- Debt-to-equity
|
| 147 |
+
- ROE, ROA
|
| 148 |
+
- Dividend yield
|
| 149 |
+
|
| 150 |
+
## π§ Configuration
|
| 151 |
+
|
| 152 |
+
Uses Yahoo Finance API:
|
| 153 |
+
- Real-time data
|
| 154 |
+
- No API key required
|
| 155 |
+
- Internet connection needed
|
| 156 |
+
|
| 157 |
+
## π‘ Best Practices
|
| 158 |
+
|
| 159 |
+
**Stock Tickers:**
|
| 160 |
+
```bash
|
| 161 |
+
β
/markets tsla # Tesla
|
| 162 |
+
β
/markets aapl # Apple
|
| 163 |
+
β
/markets msft # Microsoft
|
| 164 |
+
```
|
| 165 |
+
|
| 166 |
+
**Crypto Symbols:**
|
| 167 |
+
```bash
|
| 168 |
+
β
/markets btc # Bitcoin
|
| 169 |
+
β
/markets eth # Ethereum
|
| 170 |
+
β
/markets ada # Cardano
|
| 171 |
+
```
|
| 172 |
+
|
| 173 |
+
**Currency Codes:**
|
| 174 |
+
```bash
|
| 175 |
+
β
/markets usd # US Dollar
|
| 176 |
+
β
/markets eur # Euro
|
| 177 |
+
β
/markets jpy # Japanese Yen
|
| 178 |
+
```
|
| 179 |
+
|
| 180 |
+
## π¨ Troubleshooting
|
| 181 |
+
|
| 182 |
+
**Symbol not found:** Check ticker symbol spelling
|
| 183 |
+
**No data:** Verify internet connection
|
| 184 |
+
**Timeout:** Retry or try simpler query
|
| 185 |
+
|
| 186 |
+
## π― Use Cases
|
| 187 |
+
|
| 188 |
+
**Investment Research:**
|
| 189 |
+
```bash
|
| 190 |
+
/markets tesla statistics
|
| 191 |
+
/markets compare tsla nio
|
| 192 |
+
```
|
| 193 |
+
|
| 194 |
+
**Crypto Monitoring:**
|
| 195 |
+
```bash
|
| 196 |
+
/markets btc
|
| 197 |
+
/markets eth
|
| 198 |
+
```
|
| 199 |
+
|
| 200 |
+
**Market Overview:**
|
| 201 |
+
```bash
|
| 202 |
+
/markets aapl
|
| 203 |
+
/markets googl
|
| 204 |
+
/markets msft
|
| 205 |
+
```
|
| 206 |
+
|
| 207 |
+
## π Access Control
|
| 208 |
+
|
| 209 |
+
**R-Grade Required** for markets features
|
| 210 |
+
|
| 211 |
+
---
|
| 212 |
+
|
| 213 |
+
**Financial intelligence in real-time.** π
|
documentation/advanced-features/web3-blockchain.md
ADDED
|
@@ -0,0 +1,196 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Web3 & Blockchain
|
| 2 |
+
|
| 3 |
+
Multi-chain Web3 operations on Base, Ethereum, and Polygon networks.
|
| 4 |
+
|
| 5 |
+
## π Overview
|
| 6 |
+
|
| 7 |
+
Web3 capabilities:
|
| 8 |
+
- Token trading (buy/sell)
|
| 9 |
+
- Token transfers
|
| 10 |
+
- Multi-chain support
|
| 11 |
+
- Gas strategy control
|
| 12 |
+
- Custom token/chain addition
|
| 13 |
+
- DEX integration
|
| 14 |
+
|
| 15 |
+
## π Supported Chains
|
| 16 |
+
|
| 17 |
+
**Base** (Chain ID: 8453)
|
| 18 |
+
- Native: ETH
|
| 19 |
+
- Explorer: basescan.org
|
| 20 |
+
|
| 21 |
+
**Ethereum** (Chain ID: 1)
|
| 22 |
+
- Native: ETH
|
| 23 |
+
- Explorer: etherscan.io
|
| 24 |
+
|
| 25 |
+
**Polygon** (Chain ID: 137)
|
| 26 |
+
- Native: MATIC
|
| 27 |
+
- Explorer: polygonscan.com
|
| 28 |
+
|
| 29 |
+
## π° Supported Tokens
|
| 30 |
+
|
| 31 |
+
**Degen**: Base network
|
| 32 |
+
**USDC**: Base, Ethereum, Polygon
|
| 33 |
+
|
| 34 |
+
## π Commands
|
| 35 |
+
|
| 36 |
+
### Buy Tokens
|
| 37 |
+
```bash
|
| 38 |
+
/0x buy <amount> <token> using <token> on <chain>
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
**Examples:**
|
| 42 |
+
```bash
|
| 43 |
+
/0x buy 10 degen using eth on base
|
| 44 |
+
/0x buy 100 usdc using eth on ethereum
|
| 45 |
+
/0x buy 50 degen using usdc on base
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
### Sell Tokens
|
| 49 |
+
```bash
|
| 50 |
+
/0x sell <amount> <token> for <token> on <chain>
|
| 51 |
+
```
|
| 52 |
+
|
| 53 |
+
**Examples:**
|
| 54 |
+
```bash
|
| 55 |
+
/0x sell 5 degen for eth on base
|
| 56 |
+
/0x sell 100 usdc for eth on polygon
|
| 57 |
+
/0x sell 10 degen for usdc on base
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
### Send Tokens
|
| 61 |
+
```bash
|
| 62 |
+
/0x send <chain> <token> <amount> to <recipient>
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
**Examples:**
|
| 66 |
+
```bash
|
| 67 |
+
/0x send base eth 0.1 to Ross
|
| 68 |
+
/0x send polygon usdc 100 to Alice
|
| 69 |
+
/0x send base degen 50 to R001
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
+
Recipients resolved from kun.py contacts.
|
| 73 |
+
|
| 74 |
+
### View Addresses
|
| 75 |
+
```bash
|
| 76 |
+
/0x receive
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
Shows wallet addresses and supported assets.
|
| 80 |
+
|
| 81 |
+
### Gas Strategy
|
| 82 |
+
```bash
|
| 83 |
+
/0x gas <low|medium|high>
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
**Levels:**
|
| 87 |
+
- **low**: 80% of current gas
|
| 88 |
+
- **medium**: 100% (default)
|
| 89 |
+
- **high**: 150%
|
| 90 |
+
|
| 91 |
+
### Add Custom Token
|
| 92 |
+
```bash
|
| 93 |
+
/0x new token <name> <chain> <address>
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
**Example:**
|
| 97 |
+
```bash
|
| 98 |
+
/0x new token pepe base 0x123...def
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
### Add Custom Chain
|
| 102 |
+
```bash
|
| 103 |
+
/0x new chain <name> <chain_id> <rpc_url>
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
**Example:**
|
| 107 |
+
```bash
|
| 108 |
+
/0x new chain avalanche 43114 https://api.avax.network/ext/bc/C/rpc
|
| 109 |
+
```
|
| 110 |
+
|
| 111 |
+
### Remove Configuration
|
| 112 |
+
```bash
|
| 113 |
+
/0x forget token <name>
|
| 114 |
+
/0x forget chain <name>
|
| 115 |
+
```
|
| 116 |
+
|
| 117 |
+
**Note:** Base chains (Base, Ethereum, Polygon) cannot be removed.
|
| 118 |
+
|
| 119 |
+
## π§ Configuration
|
| 120 |
+
|
| 121 |
+
### Required in .env
|
| 122 |
+
```env
|
| 123 |
+
AGENT_PRIVATE_KEY=0x...
|
| 124 |
+
BASE_RPC_URL=https://...
|
| 125 |
+
ETHEREUM_RPC_URL=https://...
|
| 126 |
+
POLYGON_RPC_URL=https://...
|
| 127 |
+
```
|
| 128 |
+
|
| 129 |
+
### OPSIIE Wallet
|
| 130 |
+
```python
|
| 131 |
+
AGENT_WALLET = {
|
| 132 |
+
'private_key': AGENT_PRIVATE_KEY,
|
| 133 |
+
'public_key': '0x89A7f83Db9C1919B89370182002ffE5dfFc03e21'
|
| 134 |
+
}
|
| 135 |
+
```
|
| 136 |
+
|
| 137 |
+
## π‘ Transaction Flow
|
| 138 |
+
|
| 139 |
+
1. Parse command intent
|
| 140 |
+
2. Get price quote from DEX
|
| 141 |
+
3. Display preview with USD values
|
| 142 |
+
4. Request confirmation
|
| 143 |
+
5. Execute on-chain
|
| 144 |
+
6. Display explorer link
|
| 145 |
+
|
| 146 |
+
### Price Quotes
|
| 147 |
+
- Best price from DEX routers
|
| 148 |
+
- Exchange rates calculated
|
| 149 |
+
- USD values shown
|
| 150 |
+
- Slippage tolerance: 0.5%
|
| 151 |
+
|
| 152 |
+
### DEX Routers
|
| 153 |
+
- **Base**: BaseSwap
|
| 154 |
+
- **Ethereum**: Uniswap V2
|
| 155 |
+
- **Polygon**: QuickSwap
|
| 156 |
+
|
| 157 |
+
## π¨ Troubleshooting
|
| 158 |
+
|
| 159 |
+
**Insufficient balance:** Check wallet funds
|
| 160 |
+
**Transaction failed:** Increase gas, check approvals
|
| 161 |
+
**Invalid address:** Use checksummed addresses
|
| 162 |
+
**RPC error:** Verify RPC URLs in .env
|
| 163 |
+
|
| 164 |
+
## π― Use Cases
|
| 165 |
+
|
| 166 |
+
**Token Trading:**
|
| 167 |
+
```bash
|
| 168 |
+
/0x buy 10 degen using eth on base
|
| 169 |
+
/0x sell 5 degen for eth on base
|
| 170 |
+
```
|
| 171 |
+
|
| 172 |
+
**Transfers:**
|
| 173 |
+
```bash
|
| 174 |
+
/0x send base eth 0.1 to Ross
|
| 175 |
+
```
|
| 176 |
+
|
| 177 |
+
**Portfolio Management:**
|
| 178 |
+
```bash
|
| 179 |
+
/0x receive # View holdings
|
| 180 |
+
/0x gas high # Priority transactions
|
| 181 |
+
```
|
| 182 |
+
|
| 183 |
+
## π Security
|
| 184 |
+
|
| 185 |
+
- Private keys in .env (never commit)
|
| 186 |
+
- Transaction confirmation required
|
| 187 |
+
- Checksummed addresses enforced
|
| 188 |
+
- Gas limit protections
|
| 189 |
+
|
| 190 |
+
## π Access Control
|
| 191 |
+
|
| 192 |
+
**R-Grade Required** for all /0x features
|
| 193 |
+
|
| 194 |
+
---
|
| 195 |
+
|
| 196 |
+
**Decentralized finance at your command.** π
|
documentation/api-reference/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# API Reference
|
| 2 |
+
|
| 3 |
+
Technical reference for OPSIIE.
|
| 4 |
+
|
| 5 |
+
## π Documents
|
| 6 |
+
|
| 7 |
+
### [Command Reference](command-reference.md)
|
| 8 |
+
Complete command syntax and examples for all features.
|
| 9 |
+
|
| 10 |
+
### [Error Codes](error-codes.md)
|
| 11 |
+
Common errors and solutions.
|
| 12 |
+
|
| 13 |
+
## π Quick Reference
|
| 14 |
+
|
| 15 |
+
**All Users**: `/recall`, `/memorize`, `/voice`, `/imagine`, `/mail`, `/read`
|
| 16 |
+
**R-Grade**: `/ask`, `/markets`, `/dna`, `/0x`
|
| 17 |
+
|
| 18 |
+
## π Access
|
| 19 |
+
|
| 20 |
+
**R-Grade**: ARPA ID R### (full access)
|
| 21 |
+
**A-Grade**: ARPA ID A### (core features only)
|
| 22 |
+
|
| 23 |
+
---
|
| 24 |
+
|
| 25 |
+
**Technical reference.** π
|
documentation/api-reference/command-reference.md
ADDED
|
@@ -0,0 +1,319 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Command Reference
|
| 2 |
+
|
| 3 |
+
Complete reference of all OPSIIE commands.
|
| 4 |
+
|
| 5 |
+
## π§ Memory Commands
|
| 6 |
+
|
| 7 |
+
### /recall
|
| 8 |
+
**Retrieve relevant memories**
|
| 9 |
+
```bash
|
| 10 |
+
/recall <keyword>
|
| 11 |
+
```
|
| 12 |
+
**Examples**: `/recall project x`, `/recall quantum computing`
|
| 13 |
+
|
| 14 |
+
### /memorize
|
| 15 |
+
**Store important information**
|
| 16 |
+
```bash
|
| 17 |
+
/memorize <message>
|
| 18 |
+
```
|
| 19 |
+
**Examples**: `/memorize Deadline is Friday`, `/memorize I prefer Python`
|
| 20 |
+
|
| 21 |
+
### /forget
|
| 22 |
+
**Exclude last interaction from memory**
|
| 23 |
+
```bash
|
| 24 |
+
/forget
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
### /soulsig
|
| 28 |
+
**Manage Soul Signature**
|
| 29 |
+
```bash
|
| 30 |
+
/soulsig # View
|
| 31 |
+
/soulsig <message> # Add
|
| 32 |
+
/soulsig wipe # Clear (permanent)
|
| 33 |
+
/soulsig heal # Restore (if recent)
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
## π€ Voice Commands
|
| 37 |
+
|
| 38 |
+
### /voice
|
| 39 |
+
**Full voice mode (speak & listen)**
|
| 40 |
+
```bash
|
| 41 |
+
/voice
|
| 42 |
+
```
|
| 43 |
+
Exit: Say "voice off"
|
| 44 |
+
|
| 45 |
+
### /voice1
|
| 46 |
+
**OPSIIE speaks, you type**
|
| 47 |
+
```bash
|
| 48 |
+
/voice1
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
### /voice2
|
| 52 |
+
**You speak, OPSIIE types**
|
| 53 |
+
```bash
|
| 54 |
+
/voice2
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
### /voiceoff
|
| 58 |
+
**Disable voice mode**
|
| 59 |
+
```bash
|
| 60 |
+
/voiceoff
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
## π¨ AI Generation Commands
|
| 64 |
+
|
| 65 |
+
### /imagine
|
| 66 |
+
**Generate images**
|
| 67 |
+
```bash
|
| 68 |
+
/imagine <description>
|
| 69 |
+
/imagine model # Check current model
|
| 70 |
+
/imagine model <model_name> # Change model
|
| 71 |
+
```
|
| 72 |
+
**Examples**: `/imagine futuristic city`, `/imagine model hakurei/waifu-diffusion`
|
| 73 |
+
|
| 74 |
+
### /video
|
| 75 |
+
**Generate videos**
|
| 76 |
+
```bash
|
| 77 |
+
/video <description>
|
| 78 |
+
/video model # Check current model
|
| 79 |
+
/video model <model_name> # Change model
|
| 80 |
+
```
|
| 81 |
+
**Examples**: `/video sunset timelapse`, `/video model zeroscope`
|
| 82 |
+
|
| 83 |
+
### /music
|
| 84 |
+
**Generate music**
|
| 85 |
+
```bash
|
| 86 |
+
/music <description>
|
| 87 |
+
```
|
| 88 |
+
**Examples**: `/music jazz piano`, `/music ambient soundscape`
|
| 89 |
+
|
| 90 |
+
## π§ Communication Commands
|
| 91 |
+
|
| 92 |
+
### /mail
|
| 93 |
+
**Send emails**
|
| 94 |
+
```bash
|
| 95 |
+
/mail <emails> subject "<subject>" content "<message>"
|
| 96 |
+
```
|
| 97 |
+
**Examples**:
|
| 98 |
+
- `/mail john@gmail.com subject "Hello" content "Test"`
|
| 99 |
+
- `/mail Ross subject "Update" content "Latest info"`
|
| 100 |
+
|
| 101 |
+
### /mail inbox
|
| 102 |
+
**View unread emails**
|
| 103 |
+
```bash
|
| 104 |
+
/mail inbox
|
| 105 |
+
```
|
| 106 |
+
Commands in inbox: number to read, `reply`, `inbox`, `exit`
|
| 107 |
+
|
| 108 |
+
## π Document Commands
|
| 109 |
+
|
| 110 |
+
### /read
|
| 111 |
+
**Load and analyze files**
|
| 112 |
+
```bash
|
| 113 |
+
/read "<file_path>"
|
| 114 |
+
```
|
| 115 |
+
Supports: PDF, CSV, DOCX, TXT, XLSX
|
| 116 |
+
**Example**: `/read "C:\Documents\report.pdf"`
|
| 117 |
+
|
| 118 |
+
### /open
|
| 119 |
+
**Reopen last file context**
|
| 120 |
+
```bash
|
| 121 |
+
/open
|
| 122 |
+
```
|
| 123 |
+
|
| 124 |
+
### /close
|
| 125 |
+
**Close file context**
|
| 126 |
+
```bash
|
| 127 |
+
/close
|
| 128 |
+
```
|
| 129 |
+
|
| 130 |
+
## βοΈ System Commands
|
| 131 |
+
|
| 132 |
+
### /status
|
| 133 |
+
**System diagnostics**
|
| 134 |
+
```bash
|
| 135 |
+
/status
|
| 136 |
+
```
|
| 137 |
+
|
| 138 |
+
### /theme
|
| 139 |
+
**Change color theme**
|
| 140 |
+
```bash
|
| 141 |
+
/theme
|
| 142 |
+
```
|
| 143 |
+
Options: Pastel, Vibrant
|
| 144 |
+
|
| 145 |
+
### /weblimit
|
| 146 |
+
**Set web content extraction limit**
|
| 147 |
+
```bash
|
| 148 |
+
/weblimit <number>
|
| 149 |
+
```
|
| 150 |
+
Range: 500-5000 characters
|
| 151 |
+
**Example**: `/weblimit 2000`
|
| 152 |
+
|
| 153 |
+
### /help
|
| 154 |
+
**Display help**
|
| 155 |
+
```bash
|
| 156 |
+
/help # Main menu
|
| 157 |
+
/help <command> # Specific command help
|
| 158 |
+
```
|
| 159 |
+
**Examples**: `/help imagine`, `/help markets`
|
| 160 |
+
|
| 161 |
+
## π€ R-Grade: Agentic Network
|
| 162 |
+
|
| 163 |
+
### /ask
|
| 164 |
+
**Query AI agents**
|
| 165 |
+
```bash
|
| 166 |
+
/ask <agent> <prompt>
|
| 167 |
+
```
|
| 168 |
+
Agents: Nyx, G1, Kronos
|
| 169 |
+
**Examples**:
|
| 170 |
+
- `/ask Nyx Write Python blockchain code`
|
| 171 |
+
- `/ask G1 Analyze quantum computing`
|
| 172 |
+
- `/ask Kronos Greek audit procedures`
|
| 173 |
+
|
| 174 |
+
### /ask live
|
| 175 |
+
**Live voice conversations**
|
| 176 |
+
```bash
|
| 177 |
+
/ask g1 live # G1 Black real-time voice
|
| 178 |
+
/ask kronos live # Kronos real-time voice
|
| 179 |
+
```
|
| 180 |
+
Exit: Press Ctrl+C
|
| 181 |
+
|
| 182 |
+
### /room
|
| 183 |
+
**Create collaboration room**
|
| 184 |
+
```bash
|
| 185 |
+
/room <agent1, agent2...>: <theme>
|
| 186 |
+
```
|
| 187 |
+
**Examples**:
|
| 188 |
+
- `/room nyx, g1: Quantum computing applications`
|
| 189 |
+
- `/room nyx: Python microservices design`
|
| 190 |
+
|
| 191 |
+
Close room: `/close` (prompts to save as CSV)
|
| 192 |
+
|
| 193 |
+
## π R-Grade: Financial Intelligence
|
| 194 |
+
|
| 195 |
+
### /markets
|
| 196 |
+
**Market data and analysis**
|
| 197 |
+
```bash
|
| 198 |
+
/markets <symbol> # Basic data
|
| 199 |
+
/markets <symbol> <extra> # Detailed analysis
|
| 200 |
+
/markets compare <sym1> <sym2> # Compare stocks
|
| 201 |
+
```
|
| 202 |
+
|
| 203 |
+
**Extras**: `statistics`, `history`, `profile`, `financials`, `analysis`, `options`, `holders`, `sustainability`
|
| 204 |
+
|
| 205 |
+
**Examples**:
|
| 206 |
+
- `/markets tesla`
|
| 207 |
+
- `/markets btc`
|
| 208 |
+
- `/markets shell statistics`
|
| 209 |
+
- `/markets compare tsla nio`
|
| 210 |
+
|
| 211 |
+
## 𧬠R-Grade: DNA Analysis
|
| 212 |
+
|
| 213 |
+
### /dna
|
| 214 |
+
**Analyze DNA/RNA/Protein sequences**
|
| 215 |
+
```bash
|
| 216 |
+
/dna <sequence> [options]
|
| 217 |
+
```
|
| 218 |
+
|
| 219 |
+
**Options**:
|
| 220 |
+
- `--verbose` - Detailed analysis
|
| 221 |
+
- `--type <dna|rna|protein>` - Force type
|
| 222 |
+
- `--format <format>` - Input format
|
| 223 |
+
- `--export <json|csv|txt>` - Export results
|
| 224 |
+
- `--homology` - Include similarity search
|
| 225 |
+
- `--structure` - Structure prediction
|
| 226 |
+
- `--patents` - Patent search
|
| 227 |
+
- `--literature` - Literature search
|
| 228 |
+
|
| 229 |
+
**Examples**:
|
| 230 |
+
- `/dna ATGCGTAACGGCATTAGC`
|
| 231 |
+
- `/dna --verbose --homology MAKVLISPKQW`
|
| 232 |
+
- `/dna --type rna AUGCGUAACGGCAUUAGC`
|
| 233 |
+
|
| 234 |
+
## π R-Grade: Web3 & Blockchain
|
| 235 |
+
|
| 236 |
+
### /0x buy
|
| 237 |
+
**Buy tokens**
|
| 238 |
+
```bash
|
| 239 |
+
/0x buy <amount> <token> using <token> on <chain>
|
| 240 |
+
```
|
| 241 |
+
**Example**: `/0x buy 10 degen using eth on base`
|
| 242 |
+
|
| 243 |
+
### /0x sell
|
| 244 |
+
**Sell tokens**
|
| 245 |
+
```bash
|
| 246 |
+
/0x sell <amount> <token> for <token> on <chain>
|
| 247 |
+
```
|
| 248 |
+
**Example**: `/0x sell 5 degen for eth on base`
|
| 249 |
+
|
| 250 |
+
### /0x send
|
| 251 |
+
**Send tokens**
|
| 252 |
+
```bash
|
| 253 |
+
/0x send <chain> <token> <amount> to <recipient>
|
| 254 |
+
```
|
| 255 |
+
**Example**: `/0x send base eth 0.1 to Ross`
|
| 256 |
+
|
| 257 |
+
### /0x receive
|
| 258 |
+
**View wallet addresses**
|
| 259 |
+
```bash
|
| 260 |
+
/0x receive
|
| 261 |
+
```
|
| 262 |
+
|
| 263 |
+
### /0x gas
|
| 264 |
+
**Set gas strategy**
|
| 265 |
+
```bash
|
| 266 |
+
/0x gas <low|medium|high>
|
| 267 |
+
```
|
| 268 |
+
|
| 269 |
+
### /0x new
|
| 270 |
+
**Add custom token/chain**
|
| 271 |
+
```bash
|
| 272 |
+
/0x new token <name> <chain> <address>
|
| 273 |
+
/0x new chain <name> <chain_id> <rpc_url>
|
| 274 |
+
```
|
| 275 |
+
|
| 276 |
+
### /0x forget
|
| 277 |
+
**Remove configuration**
|
| 278 |
+
```bash
|
| 279 |
+
/0x forget token <name>
|
| 280 |
+
/0x forget chain <name>
|
| 281 |
+
```
|
| 282 |
+
Note: Cannot remove Base, Ethereum, Polygon
|
| 283 |
+
|
| 284 |
+
## πͺ Session Commands
|
| 285 |
+
|
| 286 |
+
### exit / quit
|
| 287 |
+
**Terminate OPSIIE session**
|
| 288 |
+
```bash
|
| 289 |
+
exit
|
| 290 |
+
quit
|
| 291 |
+
```
|
| 292 |
+
Do not use `/` prefix
|
| 293 |
+
|
| 294 |
+
## π Command Categories
|
| 295 |
+
|
| 296 |
+
**All Users:**
|
| 297 |
+
- Memory: `/recall`, `/memorize`, `/forget`, `/soulsig`
|
| 298 |
+
- Voice: `/voice`, `/voice1`, `/voice2`, `/voiceoff`
|
| 299 |
+
- AI Gen: `/imagine`, `/video`, `/music`
|
| 300 |
+
- Email: `/mail`, `/mail inbox`
|
| 301 |
+
- Files: `/read`, `/open`, `/close`
|
| 302 |
+
- System: `/status`, `/theme`, `/weblimit`, `/help`
|
| 303 |
+
|
| 304 |
+
**R-Grade Only:**
|
| 305 |
+
- Agents: `/ask`, `/ask live`, `/room`
|
| 306 |
+
- Markets: `/markets`
|
| 307 |
+
- DNA: `/dna`
|
| 308 |
+
- Web3: `/0x`
|
| 309 |
+
|
| 310 |
+
## π Access Control
|
| 311 |
+
|
| 312 |
+
**R-Grade**: ARPA ID starts with 'R' (e.g., R001)
|
| 313 |
+
**A-Grade**: ARPA ID starts with 'A' (e.g., A001)
|
| 314 |
+
|
| 315 |
+
Check kun.py for your access level.
|
| 316 |
+
|
| 317 |
+
---
|
| 318 |
+
|
| 319 |
+
**Complete command reference.** π
|
documentation/api-reference/error-codes.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Error Codes & Troubleshooting
|
| 2 |
+
|
| 3 |
+
Common OPSIIE errors and solutions.
|
| 4 |
+
|
| 5 |
+
## π¨ Authentication
|
| 6 |
+
**Face Recognition Failed**: Check lighting, camera, photo in kun.py
|
| 7 |
+
**Camera Not Detected**: Verify connection, permissions, not in use
|
| 8 |
+
|
| 9 |
+
## π Database
|
| 10 |
+
**Connection Failed**: Start PostgreSQL, check .env credentials
|
| 11 |
+
**Table Not Found**: Create conversations table (see installation.md)
|
| 12 |
+
|
| 13 |
+
## π€ Voice
|
| 14 |
+
**Microphone Not Found**: Check connection, Windows default, permissions
|
| 15 |
+
**ElevenLabs API Error**: Verify ELEVENLABS_API_KEY in .env
|
| 16 |
+
**Recognition Failed**: Speak clearly, reduce noise, check internet
|
| 17 |
+
|
| 18 |
+
## π€ AI Models
|
| 19 |
+
**Ollama Not Running**: Start Ollama, `ollama pull llama3`
|
| 20 |
+
**Model Loading (503)**: Wait 2-5 min, retry, or change model
|
| 21 |
+
**GPU Not Available**: Install CUDA, or use CPU (slower)
|
| 22 |
+
|
| 23 |
+
## π§ Email
|
| 24 |
+
**SMTP Auth Failed**: Use Gmail app password (not regular password), enable 2FA
|
| 25 |
+
**Cannot Send**: Check internet, Gmail SMTP, recipient addresses
|
| 26 |
+
**IMAP Failed**: Enable IMAP in Gmail, verify credentials
|
| 27 |
+
|
| 28 |
+
## π Files
|
| 29 |
+
**File Not Found**: Use absolute paths, check exists, quote spaces
|
| 30 |
+
**Unsupported Format**: Use PDF, CSV, DOCX, TXT, XLSX only
|
| 31 |
+
**Extraction Failed**: Check file not corrupted, encoding, password
|
| 32 |
+
|
| 33 |
+
## π Web3
|
| 34 |
+
**Insufficient Balance**: Check `/0x receive`, add funds
|
| 35 |
+
**Transaction Failed**: Increase gas `/0x gas high`, check approvals
|
| 36 |
+
**RPC Error**: Verify RPC URLs in .env, check internet
|
| 37 |
+
|
| 38 |
+
## π€ Agents
|
| 39 |
+
**Agent Not Responding**: Check API keys, internet, rate limits
|
| 40 |
+
**Live Mode Failed**: Verify agent IDs in .env, check ElevenLabs
|
| 41 |
+
**Room Creation Failed**: Use correct names (nyx, g1, kronos)
|
| 42 |
+
|
| 43 |
+
## π Markets
|
| 44 |
+
**Symbol Not Found**: Check ticker spelling on Yahoo Finance
|
| 45 |
+
**Data Timeout**: Retry, check internet, simplify query
|
| 46 |
+
|
| 47 |
+
## 𧬠DNA
|
| 48 |
+
**Invalid Sequence**: DNA=ATGC, RNA=AUGC, Protein=valid AA, no spaces
|
| 49 |
+
**NCBI Error**: Set NCBI_EMAIL in .env, check internet
|
| 50 |
+
|
| 51 |
+
## π Access Control
|
| 52 |
+
**Restricted Command**: R-Grade required, check ARPA ID in kun.py
|
| 53 |
+
|
| 54 |
+
## π Support
|
| 55 |
+
Email: opsiebyarpa@gmail.com
|
| 56 |
+
|
| 57 |
+
---
|
| 58 |
+
|
| 59 |
+
**Quick troubleshooting reference.** π§
|
documentation/core-features/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Core Features
|
| 2 |
+
|
| 3 |
+
Essential features that form the foundation of OPSIIE's functionality.
|
| 4 |
+
|
| 5 |
+
## π Feature Overview
|
| 6 |
+
|
| 7 |
+
### [Memory System](memory.md) π§
|
| 8 |
+
Long-term conversation storage and intelligent context retrieval.
|
| 9 |
+
- `/recall` - Retrieve memories
|
| 10 |
+
- `/memorize` - Store information
|
| 11 |
+
- `/forget` - Exclude last interaction
|
| 12 |
+
- `/soulsig` - Manage Soul Signature
|
| 13 |
+
|
| 14 |
+
### [Voice Interaction](voice.md) π€
|
| 15 |
+
Comprehensive voice input/output capabilities.
|
| 16 |
+
- `/voice` - Full voice mode
|
| 17 |
+
- `/voice1` - OPSIIE speaks, you type
|
| 18 |
+
- `/voice2` - You speak, OPSIIE types
|
| 19 |
+
- `/voiceoff` - Disable voice
|
| 20 |
+
- Live conversations with AI agents
|
| 21 |
+
|
| 22 |
+
### [AI Generation](ai-generation.md) π¨
|
| 23 |
+
Multi-modal AI content creation.
|
| 24 |
+
- `/imagine` - Generate images
|
| 25 |
+
- `/video` - Generate videos
|
| 26 |
+
- `/music` - Generate music
|
| 27 |
+
- Vision analysis from URLs
|
| 28 |
+
|
| 29 |
+
### [Communication](communication.md) π§
|
| 30 |
+
Email management through Gmail integration.
|
| 31 |
+
- `/mail` - Send emails
|
| 32 |
+
- `/mail inbox` - Read inbox
|
| 33 |
+
- Reply to emails
|
| 34 |
+
- Contact name resolution
|
| 35 |
+
|
| 36 |
+
### [Document Intelligence](document-intelligence.md) π
|
| 37 |
+
Intelligent document processing (TAF-3000).
|
| 38 |
+
- `/read` - Load files (PDF, CSV, DOCX, TXT, XLSX)
|
| 39 |
+
- `/open` - Reopen last file
|
| 40 |
+
- `/close` - Close file context
|
| 41 |
+
- Natural language queries
|
| 42 |
+
|
| 43 |
+
## π Quick Examples
|
| 44 |
+
|
| 45 |
+
**Memory:**
|
| 46 |
+
```bash
|
| 47 |
+
/memorize Project deadline is Friday
|
| 48 |
+
/recall project
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
**Voice:**
|
| 52 |
+
```bash
|
| 53 |
+
/voice
|
| 54 |
+
[speak] "What's the weather?"
|
| 55 |
+
[hear response]
|
| 56 |
+
"voice off"
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
**AI Generation:**
|
| 60 |
+
```bash
|
| 61 |
+
/imagine futuristic city
|
| 62 |
+
/video sunset timelapse
|
| 63 |
+
/music jazz piano
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
**Communication:**
|
| 67 |
+
```bash
|
| 68 |
+
/mail john@gmail.com subject "Hello" content "Test"
|
| 69 |
+
/mail inbox
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
+
**Documents:**
|
| 73 |
+
```bash
|
| 74 |
+
/read "C:\report.pdf"
|
| 75 |
+
What are the conclusions?
|
| 76 |
+
/close
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
## π Learn More
|
| 80 |
+
|
| 81 |
+
- [Memory Management Guide](../user-guides/memory-management.md)
|
| 82 |
+
- [Basic Commands](../user-guides/basic-commands.md)
|
| 83 |
+
- [Command Reference](../api-reference/command-reference.md)
|
| 84 |
+
|
| 85 |
+
---
|
| 86 |
+
|
| 87 |
+
**Master these core features to unlock OPSIIE's full potential.** β¨
|
documentation/core-features/ai-generation.md
ADDED
|
@@ -0,0 +1,555 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# AI Generation - Multi-Modal Creation
|
| 2 |
+
|
| 3 |
+
OPSIIE provides multi-modal AI generation capabilities for images, videos, and music using various AI models and APIs.
|
| 4 |
+
|
| 5 |
+
## π¨ Overview
|
| 6 |
+
|
| 7 |
+
AI Generation features:
|
| 8 |
+
- **Image Generation**: AI-powered image creation via Hugging Face models
|
| 9 |
+
- **Video Generation**: Text-to-video synthesis with multiple models
|
| 10 |
+
- **Music Generation**: AI music composition using Facebook's MusicGen
|
| 11 |
+
- **Model Flexibility**: Switch between different AI models
|
| 12 |
+
- **Local & API-Based**: Mix of local and cloud-based generation
|
| 13 |
+
|
| 14 |
+
## πΌοΈ Image Generation
|
| 15 |
+
|
| 16 |
+
### /imagine Command
|
| 17 |
+
Generate images from text descriptions.
|
| 18 |
+
|
| 19 |
+
**Syntax:**
|
| 20 |
+
```bash
|
| 21 |
+
/imagine <description>
|
| 22 |
+
```
|
| 23 |
+
|
| 24 |
+
**Examples:**
|
| 25 |
+
```bash
|
| 26 |
+
# Sci-fi scenes
|
| 27 |
+
/imagine a futuristic city skyline at sunset
|
| 28 |
+
|
| 29 |
+
# Character portraits
|
| 30 |
+
/imagine portrait of a cyberpunk hacker
|
| 31 |
+
|
| 32 |
+
# Abstract art
|
| 33 |
+
/imagine abstract digital art with purple and blue colors
|
| 34 |
+
|
| 35 |
+
# Landscapes
|
| 36 |
+
/imagine mountain landscape with aurora borealis
|
| 37 |
+
|
| 38 |
+
# Anime style
|
| 39 |
+
/imagine anime girl in school uniform
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
### How It Works
|
| 43 |
+
1. Text prompt sent to Hugging Face Inference API
|
| 44 |
+
2. Image generated by selected model
|
| 45 |
+
3. Image saved to `outputs/images/`
|
| 46 |
+
4. Image automatically displayed
|
| 47 |
+
5. Filename created from prompt
|
| 48 |
+
|
| 49 |
+
**Output:**
|
| 50 |
+
```
|
| 51 |
+
OPSIIE is dreaming... do not disturb.
|
| 52 |
+
Image generated and saved as 'outputs/images/futuristic_city_skyline_at_sunset.png'
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
### Model Management
|
| 56 |
+
|
| 57 |
+
**Check Current Model:**
|
| 58 |
+
```bash
|
| 59 |
+
/imagine model
|
| 60 |
+
```
|
| 61 |
+
|
| 62 |
+
**Output:**
|
| 63 |
+
```
|
| 64 |
+
Current dream engine model is: black-forest-labs/FLUX.1-dev
|
| 65 |
+
To change the model, use /imagine model <new_model_name>
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
**Change Model:**
|
| 69 |
+
```bash
|
| 70 |
+
/imagine model <model_name>
|
| 71 |
+
```
|
| 72 |
+
|
| 73 |
+
**Available Models:**
|
| 74 |
+
```bash
|
| 75 |
+
# FLUX (default - high quality)
|
| 76 |
+
/imagine model black-forest-labs/FLUX.1-dev
|
| 77 |
+
|
| 78 |
+
# Anime/Waifu style
|
| 79 |
+
/imagine model hakurei/waifu-diffusion
|
| 80 |
+
|
| 81 |
+
# NSFW capable (use responsibly)
|
| 82 |
+
/imagine model UnfilteredAI/NSFW-gen-v2
|
| 83 |
+
|
| 84 |
+
# Any Hugging Face model
|
| 85 |
+
/imagine model <username>/<model-name>
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
**Configuration:**
|
| 89 |
+
```python
|
| 90 |
+
# Default model
|
| 91 |
+
HF_API_URL = "https://api-inference.huggingface.co/models/black-forest-labs/FLUX.1-dev"
|
| 92 |
+
|
| 93 |
+
# Requires Hugging Face API token in headers
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
### Image Generation Features
|
| 97 |
+
- **Auto-save**: Images saved to `outputs/images/`
|
| 98 |
+
- **Auto-display**: Images automatically opened
|
| 99 |
+
- **Clean filenames**: Prompt converted to filename
|
| 100 |
+
- **Format**: PNG (default)
|
| 101 |
+
- **API**: Hugging Face Inference API
|
| 102 |
+
|
| 103 |
+
### Error Handling
|
| 104 |
+
```
|
| 105 |
+
Error: The dream engine model is still loading
|
| 106 |
+
β Model needs warm-up time, retry in few minutes
|
| 107 |
+
|
| 108 |
+
Error: 503 Service Unavailable
|
| 109 |
+
β Model temporarily unavailable, try different model
|
| 110 |
+
|
| 111 |
+
Error: The content returned is not a valid image
|
| 112 |
+
β Invalid response from API, retry or change model
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
## π¬ Video Generation
|
| 116 |
+
|
| 117 |
+
### /video Command
|
| 118 |
+
Generate videos from text descriptions.
|
| 119 |
+
|
| 120 |
+
**Syntax:**
|
| 121 |
+
```bash
|
| 122 |
+
/video <description>
|
| 123 |
+
```
|
| 124 |
+
|
| 125 |
+
**Examples:**
|
| 126 |
+
```bash
|
| 127 |
+
# Nature scenes
|
| 128 |
+
/video sunset timelapse over ocean waves
|
| 129 |
+
|
| 130 |
+
# Action sequences
|
| 131 |
+
/video cat playing with yarn ball
|
| 132 |
+
|
| 133 |
+
# Abstract visuals
|
| 134 |
+
/video abstract particles flowing in space
|
| 135 |
+
|
| 136 |
+
# Landscapes
|
| 137 |
+
/video mountain landscape with moving clouds
|
| 138 |
+
```
|
| 139 |
+
|
| 140 |
+
### How It Works
|
| 141 |
+
1. Text prompt processed by video diffusion model
|
| 142 |
+
2. Video frames generated (24 frames default)
|
| 143 |
+
3. Frames compiled into MP4 video
|
| 144 |
+
4. Video saved to `outputs/videos/`
|
| 145 |
+
5. Video automatically plays in browser
|
| 146 |
+
|
| 147 |
+
**Default Parameters:**
|
| 148 |
+
```python
|
| 149 |
+
{
|
| 150 |
+
"num_frames": 24,
|
| 151 |
+
"height": 256,
|
| 152 |
+
"width": 256,
|
| 153 |
+
"num_inference_steps": 20,
|
| 154 |
+
"guidance_scale": 7.5
|
| 155 |
+
}
|
| 156 |
+
```
|
| 157 |
+
|
| 158 |
+
### Video Models
|
| 159 |
+
|
| 160 |
+
**Check Current Model:**
|
| 161 |
+
```bash
|
| 162 |
+
/video model
|
| 163 |
+
```
|
| 164 |
+
|
| 165 |
+
**Change Model:**
|
| 166 |
+
```bash
|
| 167 |
+
/video model <model_name>
|
| 168 |
+
```
|
| 169 |
+
|
| 170 |
+
**Available Models:**
|
| 171 |
+
```bash
|
| 172 |
+
# ModelScope (default)
|
| 173 |
+
/video model modelscope
|
| 174 |
+
|
| 175 |
+
# Zeroscope (higher quality)
|
| 176 |
+
/video model zeroscope
|
| 177 |
+
|
| 178 |
+
# VideoGen
|
| 179 |
+
/video model videogen
|
| 180 |
+
|
| 181 |
+
# TuneAVideo
|
| 182 |
+
/video model tuneavideo
|
| 183 |
+
```
|
| 184 |
+
|
| 185 |
+
**Model Details:**
|
| 186 |
+
```python
|
| 187 |
+
VIDEO_MODELS = {
|
| 188 |
+
"modelscope": "damo-vilab/text-to-video-ms-1.7b",
|
| 189 |
+
"zeroscope": "cerspense/zeroscope_v2_576w",
|
| 190 |
+
"videogen": "VideoCrafter/videogen-1",
|
| 191 |
+
"tuneavideo": "tuneavideo/stable-diffusion-v1-5-video"
|
| 192 |
+
}
|
| 193 |
+
```
|
| 194 |
+
|
| 195 |
+
### Video Generation Process
|
| 196 |
+
```
|
| 197 |
+
OPSIIE is dreaming... do not disturb.
|
| 198 |
+
[Generating 24 frames...]
|
| 199 |
+
[Compiling video...]
|
| 200 |
+
Video specimen generated and saved to: outputs/videos/sunset_timelapse.mp4
|
| 201 |
+
[Video plays in browser]
|
| 202 |
+
```
|
| 203 |
+
|
| 204 |
+
### Video Features
|
| 205 |
+
- **Resolution**: 256x256 (default, model-dependent)
|
| 206 |
+
- **Duration**: 24 frames (~1 second at 24fps)
|
| 207 |
+
- **Format**: MP4
|
| 208 |
+
- **Auto-play**: Opens in default browser
|
| 209 |
+
- **CUDA Support**: GPU acceleration if available
|
| 210 |
+
|
| 211 |
+
## π΅ Music Generation
|
| 212 |
+
|
| 213 |
+
### /music Command
|
| 214 |
+
Generate music from text descriptions.
|
| 215 |
+
|
| 216 |
+
**Syntax:**
|
| 217 |
+
```bash
|
| 218 |
+
/music <description>
|
| 219 |
+
```
|
| 220 |
+
|
| 221 |
+
**Examples:**
|
| 222 |
+
```bash
|
| 223 |
+
# Classical
|
| 224 |
+
/music calm piano with soft strings
|
| 225 |
+
|
| 226 |
+
# Electronic
|
| 227 |
+
/music electronic dance music with heavy bass
|
| 228 |
+
|
| 229 |
+
# Jazz
|
| 230 |
+
/music smooth jazz with saxophone
|
| 231 |
+
|
| 232 |
+
# Ambient
|
| 233 |
+
/music ambient soundscape for meditation
|
| 234 |
+
|
| 235 |
+
# Rock
|
| 236 |
+
/music energetic rock guitar solo
|
| 237 |
+
```
|
| 238 |
+
|
| 239 |
+
### How It Works
|
| 240 |
+
1. Text prompt processed by MusicGen model
|
| 241 |
+
2. Audio waveform generated
|
| 242 |
+
3. Audio saved as WAV file
|
| 243 |
+
4. Audio saved to `outputs/music/`
|
| 244 |
+
5. Audio automatically played
|
| 245 |
+
|
| 246 |
+
**Model:**
|
| 247 |
+
```python
|
| 248 |
+
# Facebook's MusicGen Small
|
| 249 |
+
musicgen_processor = AutoProcessor.from_pretrained("facebook/musicgen-small")
|
| 250 |
+
musicgen_model = MusicgenForConditionalGeneration.from_pretrained(
|
| 251 |
+
"facebook/musicgen-small",
|
| 252 |
+
attn_implementation="eager"
|
| 253 |
+
)
|
| 254 |
+
```
|
| 255 |
+
|
| 256 |
+
### Music Generation Process
|
| 257 |
+
```
|
| 258 |
+
OPSIIE is dreaming... do not disturb.
|
| 259 |
+
[Processing prompt...]
|
| 260 |
+
[Generating audio waveform...]
|
| 261 |
+
[Saving to WAV...]
|
| 262 |
+
Music specimen generated: outputs/music/calm_piano_with_soft_strings.wav
|
| 263 |
+
[Audio plays]
|
| 264 |
+
```
|
| 265 |
+
|
| 266 |
+
### Music Features
|
| 267 |
+
- **Model**: facebook/musicgen-small
|
| 268 |
+
- **Format**: WAV
|
| 269 |
+
- **Quality**: Model-dependent
|
| 270 |
+
- **Auto-play**: pygame mixer
|
| 271 |
+
- **CUDA Support**: GPU acceleration
|
| 272 |
+
- **Duration**: Configurable (model default)
|
| 273 |
+
|
| 274 |
+
## π¨ Vision Analysis
|
| 275 |
+
|
| 276 |
+
### Image URL Analysis
|
| 277 |
+
OPSIIE can analyze images from URLs in conversations.
|
| 278 |
+
|
| 279 |
+
**How to Use:**
|
| 280 |
+
```
|
| 281 |
+
Provide image URL in your prompt, OPSIIE analyzes and describes it
|
| 282 |
+
```
|
| 283 |
+
|
| 284 |
+
**Example:**
|
| 285 |
+
```
|
| 286 |
+
You: What do you see in this image? https://example.com/image.jpg
|
| 287 |
+
|
| 288 |
+
OPSIIE: [Downloads image]
|
| 289 |
+
[Analyzes with BLIP model]
|
| 290 |
+
[Provides description]
|
| 291 |
+
I see a futuristic cityscape with tall buildings...
|
| 292 |
+
```
|
| 293 |
+
|
| 294 |
+
### Vision Model
|
| 295 |
+
```python
|
| 296 |
+
# BLIP model for image captioning
|
| 297 |
+
processor = BlipProcessor.from_pretrained("Salesforce/blip-image-captioning-base")
|
| 298 |
+
model = BlipForConditionalGeneration.from_pretrained("Salesforce/blip-image-captioning-base")
|
| 299 |
+
```
|
| 300 |
+
|
| 301 |
+
**Features:**
|
| 302 |
+
- Automatic image download from URLs
|
| 303 |
+
- Image analysis and description
|
| 304 |
+
- Context integration in responses
|
| 305 |
+
- Supports common image formats
|
| 306 |
+
|
| 307 |
+
## π§ Technical Architecture
|
| 308 |
+
|
| 309 |
+
### Image Pipeline
|
| 310 |
+
```
|
| 311 |
+
Text Prompt β HF API β Model Processing β Image Generation β PNG Save β Display
|
| 312 |
+
```
|
| 313 |
+
|
| 314 |
+
### Video Pipeline
|
| 315 |
+
```
|
| 316 |
+
Text Prompt β Diffusion Model β Frame Generation β Video Compilation β MP4 Save β Browser Play
|
| 317 |
+
```
|
| 318 |
+
|
| 319 |
+
### Music Pipeline
|
| 320 |
+
```
|
| 321 |
+
Text Prompt β MusicGen β Waveform Generation β WAV Save β Audio Play
|
| 322 |
+
```
|
| 323 |
+
|
| 324 |
+
### Vision Pipeline
|
| 325 |
+
```
|
| 326 |
+
Image URL β Download β BLIP Model β Description β Context Integration
|
| 327 |
+
```
|
| 328 |
+
|
| 329 |
+
## π‘ Best Practices
|
| 330 |
+
|
| 331 |
+
### Effective Prompts
|
| 332 |
+
|
| 333 |
+
**Images:**
|
| 334 |
+
```bash
|
| 335 |
+
# Be specific
|
| 336 |
+
/imagine cyberpunk hacker in neon-lit room with holographic displays
|
| 337 |
+
|
| 338 |
+
# Include style
|
| 339 |
+
/imagine oil painting of mountain landscape in impressionist style
|
| 340 |
+
|
| 341 |
+
# Specify details
|
| 342 |
+
/imagine portrait of woman with blue eyes, long hair, futuristic clothing
|
| 343 |
+
```
|
| 344 |
+
|
| 345 |
+
**Videos:**
|
| 346 |
+
```bash
|
| 347 |
+
# Describe motion
|
| 348 |
+
/video waves crashing on beach with sunset
|
| 349 |
+
|
| 350 |
+
# Be concise (video models prefer shorter prompts)
|
| 351 |
+
/video cat playing with ball
|
| 352 |
+
|
| 353 |
+
# Focus on main action
|
| 354 |
+
/video abstract particles swirling
|
| 355 |
+
```
|
| 356 |
+
|
| 357 |
+
**Music:**
|
| 358 |
+
```bash
|
| 359 |
+
# Specify genre and mood
|
| 360 |
+
/music upbeat jazz with piano and drums
|
| 361 |
+
|
| 362 |
+
# Include instruments
|
| 363 |
+
/music classical symphony with strings and brass
|
| 364 |
+
|
| 365 |
+
# Describe atmosphere
|
| 366 |
+
/music dark ambient with deep bass
|
| 367 |
+
```
|
| 368 |
+
|
| 369 |
+
### Resource Management
|
| 370 |
+
|
| 371 |
+
**GPU Usage:**
|
| 372 |
+
- Image generation: API-based (no local GPU needed)
|
| 373 |
+
- Video generation: Local GPU recommended
|
| 374 |
+
- Music generation: Local GPU recommended
|
| 375 |
+
|
| 376 |
+
**Storage:**
|
| 377 |
+
- Images: ~1-5 MB each
|
| 378 |
+
- Videos: ~5-20 MB each
|
| 379 |
+
- Music: ~2-10 MB each
|
| 380 |
+
- Monitor `outputs/` directory size
|
| 381 |
+
|
| 382 |
+
**Performance:**
|
| 383 |
+
- Image: ~10-30 seconds (API dependent)
|
| 384 |
+
- Video: ~1-5 minutes (GPU dependent)
|
| 385 |
+
- Music: ~30-60 seconds (GPU dependent)
|
| 386 |
+
|
| 387 |
+
## βοΈ Configuration
|
| 388 |
+
|
| 389 |
+
### API Keys
|
| 390 |
+
```env
|
| 391 |
+
# Hugging Face (for image generation)
|
| 392 |
+
HF_API_TOKEN=your_hugging_face_token
|
| 393 |
+
```
|
| 394 |
+
|
| 395 |
+
### Model Settings
|
| 396 |
+
```python
|
| 397 |
+
# Image model (changeable via command)
|
| 398 |
+
HF_API_URL = "https://api-inference.huggingface.co/models/black-forest-labs/FLUX.1-dev"
|
| 399 |
+
|
| 400 |
+
# Video model (changeable via command)
|
| 401 |
+
current_model = "modelscope"
|
| 402 |
+
|
| 403 |
+
# Music model (fixed)
|
| 404 |
+
model = "facebook/musicgen-small"
|
| 405 |
+
|
| 406 |
+
# Vision model (fixed)
|
| 407 |
+
model = "Salesforce/blip-image-captioning-base"
|
| 408 |
+
```
|
| 409 |
+
|
| 410 |
+
### Output Directories
|
| 411 |
+
```python
|
| 412 |
+
ensure_directory_exists('outputs/images')
|
| 413 |
+
ensure_directory_exists('outputs/music')
|
| 414 |
+
ensure_directory_exists('outputs/videos')
|
| 415 |
+
```
|
| 416 |
+
|
| 417 |
+
## π¨ Troubleshooting
|
| 418 |
+
|
| 419 |
+
### Image Generation Fails
|
| 420 |
+
```
|
| 421 |
+
Error: Model is loading (503)
|
| 422 |
+
β Wait a few minutes, retry
|
| 423 |
+
|
| 424 |
+
Error: Invalid API token
|
| 425 |
+
β Check HF_API_TOKEN in environment
|
| 426 |
+
|
| 427 |
+
Error: Rate limit exceeded
|
| 428 |
+
β Wait or use different model
|
| 429 |
+
```
|
| 430 |
+
|
| 431 |
+
### Video Generation Slow
|
| 432 |
+
```
|
| 433 |
+
Problem: Takes very long time
|
| 434 |
+
β Check GPU availability
|
| 435 |
+
β Try smaller model (modelscope vs zeroscope)
|
| 436 |
+
β Reduce num_frames parameter
|
| 437 |
+
```
|
| 438 |
+
|
| 439 |
+
### Music Generation Issues
|
| 440 |
+
```
|
| 441 |
+
Error: Model not initialized
|
| 442 |
+
β Check CUDA availability
|
| 443 |
+
β Verify model download
|
| 444 |
+
β Check disk space
|
| 445 |
+
|
| 446 |
+
Error: Audio playback failed
|
| 447 |
+
β Check audio drivers
|
| 448 |
+
β Verify pygame installation
|
| 449 |
+
```
|
| 450 |
+
|
| 451 |
+
### Vision Analysis Fails
|
| 452 |
+
```
|
| 453 |
+
Error: Could not download image
|
| 454 |
+
β Check URL validity
|
| 455 |
+
β Verify internet connection
|
| 456 |
+
β Check image format support
|
| 457 |
+
```
|
| 458 |
+
|
| 459 |
+
## π― Use Cases
|
| 460 |
+
|
| 461 |
+
### Creative Projects
|
| 462 |
+
```bash
|
| 463 |
+
# Generate concept art
|
| 464 |
+
/imagine futuristic vehicle design
|
| 465 |
+
|
| 466 |
+
# Create mood videos
|
| 467 |
+
/video abstract visuals for presentation
|
| 468 |
+
|
| 469 |
+
# Produce background music
|
| 470 |
+
/music ambient music for podcast intro
|
| 471 |
+
```
|
| 472 |
+
|
| 473 |
+
### Research & Development
|
| 474 |
+
```bash
|
| 475 |
+
# Visualize concepts
|
| 476 |
+
/imagine diagram of neural network architecture
|
| 477 |
+
|
| 478 |
+
# Create demo videos
|
| 479 |
+
/video simulation of particle movement
|
| 480 |
+
|
| 481 |
+
# Generate test audio
|
| 482 |
+
/music various musical styles for testing
|
| 483 |
+
```
|
| 484 |
+
|
| 485 |
+
### Content Creation
|
| 486 |
+
```bash
|
| 487 |
+
# Social media content
|
| 488 |
+
/imagine eye-catching thumbnail design
|
| 489 |
+
|
| 490 |
+
# Video content
|
| 491 |
+
/video intro sequence animation
|
| 492 |
+
|
| 493 |
+
# Podcast music
|
| 494 |
+
/music podcast outro music
|
| 495 |
+
```
|
| 496 |
+
|
| 497 |
+
## π Generation Statistics
|
| 498 |
+
|
| 499 |
+
Check system status:
|
| 500 |
+
```bash
|
| 501 |
+
/status
|
| 502 |
+
```
|
| 503 |
+
|
| 504 |
+
Shows:
|
| 505 |
+
- Generation system status
|
| 506 |
+
- Model availability
|
| 507 |
+
- GPU/CPU usage
|
| 508 |
+
- Output directory sizes
|
| 509 |
+
|
| 510 |
+
## π Advanced Usage
|
| 511 |
+
|
| 512 |
+
### Batch Generation
|
| 513 |
+
```bash
|
| 514 |
+
# Generate multiple images
|
| 515 |
+
/imagine concept 1
|
| 516 |
+
/imagine concept 2
|
| 517 |
+
/imagine concept 3
|
| 518 |
+
|
| 519 |
+
# Generate video sequences
|
| 520 |
+
/video scene 1
|
| 521 |
+
/video scene 2
|
| 522 |
+
/video scene 3
|
| 523 |
+
```
|
| 524 |
+
|
| 525 |
+
### Model Experimentation
|
| 526 |
+
```bash
|
| 527 |
+
# Try different image models
|
| 528 |
+
/imagine model FLUX.1-dev
|
| 529 |
+
/imagine futuristic city
|
| 530 |
+
/imagine model waifu-diffusion
|
| 531 |
+
/imagine anime character
|
| 532 |
+
/imagine model stable-diffusion-v1-5
|
| 533 |
+
/imagine realistic portrait
|
| 534 |
+
```
|
| 535 |
+
|
| 536 |
+
### Workflow Integration
|
| 537 |
+
```bash
|
| 538 |
+
# Create complete content
|
| 539 |
+
/imagine concept art for video game
|
| 540 |
+
/video game intro animation
|
| 541 |
+
/music epic game soundtrack
|
| 542 |
+
|
| 543 |
+
# All outputs saved to respective directories
|
| 544 |
+
```
|
| 545 |
+
|
| 546 |
+
## π Related Features
|
| 547 |
+
|
| 548 |
+
- **Voice Generation**: ElevenLabs for voice synthesis
|
| 549 |
+
- **File Processing**: Analyze generated images with `/read`
|
| 550 |
+
- **Memory**: Store generation prompts with `/memorize`
|
| 551 |
+
- **Rooms**: Collaborative generation with AI agents
|
| 552 |
+
|
| 553 |
+
---
|
| 554 |
+
|
| 555 |
+
**Multi-modal AI generation brings creativity to your fingertips.** π¨
|
documentation/core-features/communication.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Communication - Email Management
|
| 2 |
+
|
| 3 |
+
OPSIIE provides comprehensive email capabilities through Gmail integration for sending, receiving, and managing emails.
|
| 4 |
+
|
| 5 |
+
## π§ Overview
|
| 6 |
+
|
| 7 |
+
- **Send Emails**: Natural language email composition
|
| 8 |
+
- **Read Inbox**: View unread messages
|
| 9 |
+
- **Reply**: Respond to emails
|
| 10 |
+
- **Multi-Recipient**: Up to 5 recipients
|
| 11 |
+
- **Contact Mapping**: Automatic name resolution from kun.py
|
| 12 |
+
- **HTML Templates**: Professional ARPA-branded emails
|
| 13 |
+
|
| 14 |
+
## π€ Sending Emails
|
| 15 |
+
|
| 16 |
+
### /mail Command
|
| 17 |
+
|
| 18 |
+
**Basic Syntax:**
|
| 19 |
+
```bash
|
| 20 |
+
/mail <emails> subject "<subject>" content "<message>"
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
**Examples:**
|
| 24 |
+
```bash
|
| 25 |
+
# Single recipient
|
| 26 |
+
/mail john@gmail.com subject "Meeting" content "Let's meet at 2 PM"
|
| 27 |
+
|
| 28 |
+
# Multiple recipients
|
| 29 |
+
/mail john@gmail.com and alice@example.com subject "Update" content "Here's the info"
|
| 30 |
+
|
| 31 |
+
# Using contact names
|
| 32 |
+
/mail Ross subject "Hello" content "How are you?"
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
### Email Parsing
|
| 36 |
+
|
| 37 |
+
OPSIIE extracts:
|
| 38 |
+
- **Email Addresses**: `name@domain.com` format
|
| 39 |
+
- **Contact Names**: From kun.py profiles
|
| 40 |
+
- **Subject**: Keywords: subject, sub, theme, title
|
| 41 |
+
- **Content**: Keywords: content, body, message, saying
|
| 42 |
+
|
| 43 |
+
### Contact Resolution
|
| 44 |
+
|
| 45 |
+
Names automatically map to emails from kun.py:
|
| 46 |
+
```python
|
| 47 |
+
'Ross': {'mail': 'ross@example.com'}
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
## π₯ Reading Emails
|
| 51 |
+
|
| 52 |
+
### /mail inbox
|
| 53 |
+
|
| 54 |
+
View unread emails:
|
| 55 |
+
```bash
|
| 56 |
+
/mail inbox
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
**Select email number to read:**
|
| 60 |
+
```
|
| 61 |
+
[INPUT] Select email number or 'exit': 1
|
| 62 |
+
```
|
| 63 |
+
|
| 64 |
+
**Commands in email view:**
|
| 65 |
+
- `reply` - Reply to email
|
| 66 |
+
- `inbox` - Return to inbox list
|
| 67 |
+
- `exit` - Return to main interface
|
| 68 |
+
|
| 69 |
+
## π¬ Replying
|
| 70 |
+
|
| 71 |
+
1. Open email from inbox
|
| 72 |
+
2. Type `reply`
|
| 73 |
+
3. Compose message
|
| 74 |
+
4. Reply sent with "Re:" prefix
|
| 75 |
+
|
| 76 |
+
## π§ Configuration
|
| 77 |
+
|
| 78 |
+
**Gmail Setup:**
|
| 79 |
+
1. Enable 2-Factor Authentication
|
| 80 |
+
2. Generate App Password
|
| 81 |
+
3. Configure .env:
|
| 82 |
+
|
| 83 |
+
```env
|
| 84 |
+
SENDER_EMAIL=your_email@gmail.com
|
| 85 |
+
SENDER_PASSWORD=your_app_password
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
## π¨ Troubleshooting
|
| 89 |
+
|
| 90 |
+
**Authentication Failed:**
|
| 91 |
+
- Use app password, not regular password
|
| 92 |
+
- Enable 2FA
|
| 93 |
+
- Regenerate app password
|
| 94 |
+
|
| 95 |
+
**Cannot Send:**
|
| 96 |
+
- Check internet connection
|
| 97 |
+
- Verify Gmail SMTP access
|
| 98 |
+
- Check recipient addresses
|
| 99 |
+
|
| 100 |
+
**Cannot Read Inbox:**
|
| 101 |
+
- Enable IMAP in Gmail
|
| 102 |
+
- Verify credentials
|
| 103 |
+
- Check connection
|
| 104 |
+
|
| 105 |
+
---
|
| 106 |
+
|
| 107 |
+
**OPSIIE keeps you connected.** π§
|
documentation/core-features/document-intelligence.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Document Intelligence - TAF-3000
|
| 2 |
+
|
| 3 |
+
OPSIIE's File Manager TAF-3000 provides intelligent document processing with natural language querying.
|
| 4 |
+
|
| 5 |
+
## π Overview
|
| 6 |
+
|
| 7 |
+
- **Formats**: PDF, CSV, DOCX, TXT, XLSX
|
| 8 |
+
- **Analysis**: Intelligent parsing and extraction
|
| 9 |
+
- **Queries**: Ask questions about content
|
| 10 |
+
- **Context**: Maintains file context
|
| 11 |
+
- **AI**: Uses Ollama/Llama3 for responses
|
| 12 |
+
|
| 13 |
+
## π Commands
|
| 14 |
+
|
| 15 |
+
### /read - Load File
|
| 16 |
+
```bash
|
| 17 |
+
/read "<file_path>"
|
| 18 |
+
```
|
| 19 |
+
|
| 20 |
+
**Examples:**
|
| 21 |
+
```bash
|
| 22 |
+
/read "C:\Documents\report.pdf"
|
| 23 |
+
/read "E:\Data\sales.csv"
|
| 24 |
+
/read "C:\Notes\meeting.docx"
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
### Ask Questions
|
| 28 |
+
After loading, ask naturally:
|
| 29 |
+
```
|
| 30 |
+
What are the main conclusions?
|
| 31 |
+
Which product had highest sales?
|
| 32 |
+
Summarize the methodology
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
### /open - Reopen Last File
|
| 36 |
+
```bash
|
| 37 |
+
/open
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
### /close - Close Context
|
| 41 |
+
```bash
|
| 42 |
+
/close
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
## π Supported Formats
|
| 46 |
+
|
| 47 |
+
- **PDF**: PyPDF2, pdfplumber
|
| 48 |
+
- **CSV**: pandas
|
| 49 |
+
- **DOCX**: python-docx
|
| 50 |
+
- **TXT**: built-in
|
| 51 |
+
- **XLSX**: pandas
|
| 52 |
+
|
| 53 |
+
## π‘ Best Practices
|
| 54 |
+
|
| 55 |
+
**Use full paths:**
|
| 56 |
+
```bash
|
| 57 |
+
β
/read "C:\Users\Name\file.pdf"
|
| 58 |
+
β /read "file.pdf"
|
| 59 |
+
```
|
| 60 |
+
|
| 61 |
+
**Be specific in queries:**
|
| 62 |
+
```
|
| 63 |
+
β
"What does section 3 say about revenue?"
|
| 64 |
+
β "Tell me about it"
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
## π¨ Troubleshooting
|
| 68 |
+
|
| 69 |
+
**File not found:** Check path, use absolute paths
|
| 70 |
+
**Unsupported format:** Only PDF, CSV, DOCX, TXT, XLSX
|
| 71 |
+
**Query fails:** Rephrase, be more specific
|
| 72 |
+
|
| 73 |
+
---
|
| 74 |
+
|
| 75 |
+
**TAF-3000 makes documents intelligible.** π
|
documentation/core-features/memory.md
ADDED
|
@@ -0,0 +1,498 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Memory System - Mnemonic Matrix
|
| 2 |
+
|
| 3 |
+
OPSIIE's memory system, called the Mnemonic Matrix, provides long-term conversation storage and intelligent context retrieval using PostgreSQL and ChromaDB.
|
| 4 |
+
|
| 5 |
+
## π§ Overview
|
| 6 |
+
|
| 7 |
+
The Mnemonic Matrix enables OPSIIE to:
|
| 8 |
+
- **Remember Past Conversations**: Store all interactions in PostgreSQL
|
| 9 |
+
- **Retrieve Relevant Context**: Use vector search to find related memories
|
| 10 |
+
- **Build Ongoing Relationships**: Reference previous discussions
|
| 11 |
+
- **Maintain User Preferences**: Store and recall your Soul Signature
|
| 12 |
+
- **Learn from Interactions**: Improve responses based on history
|
| 13 |
+
|
| 14 |
+
## π§ Architecture
|
| 15 |
+
|
| 16 |
+
### Database Structure
|
| 17 |
+
|
| 18 |
+
**PostgreSQL (mnemonic_computer)**
|
| 19 |
+
```sql
|
| 20 |
+
CREATE TABLE conversations (
|
| 21 |
+
id SERIAL PRIMARY KEY,
|
| 22 |
+
timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
| 23 |
+
prompt TEXT NOT NULL,
|
| 24 |
+
response TEXT NOT NULL
|
| 25 |
+
);
|
| 26 |
+
```
|
| 27 |
+
|
| 28 |
+
**ChromaDB (Vector Database)**
|
| 29 |
+
- Stores conversation embeddings
|
| 30 |
+
- Enables semantic search
|
| 31 |
+
- Finds contextually similar memories
|
| 32 |
+
|
| 33 |
+
### How It Works
|
| 34 |
+
|
| 35 |
+
1. **Storage**: Every conversation is stored in PostgreSQL
|
| 36 |
+
2. **Vectorization**: Text is converted to embeddings
|
| 37 |
+
3. **Indexing**: Embeddings stored in ChromaDB
|
| 38 |
+
4. **Retrieval**: Semantic search finds relevant memories
|
| 39 |
+
5. **Context**: Retrieved memories enhance AI responses
|
| 40 |
+
|
| 41 |
+
## π Memory Commands
|
| 42 |
+
|
| 43 |
+
### /memorize - Store Information
|
| 44 |
+
Store important information for future reference.
|
| 45 |
+
|
| 46 |
+
**Syntax:**
|
| 47 |
+
```bash
|
| 48 |
+
/memorize <message>
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
**Examples:**
|
| 52 |
+
```bash
|
| 53 |
+
# Store personal information
|
| 54 |
+
/memorize My favorite programming language is Python
|
| 55 |
+
|
| 56 |
+
# Store project details
|
| 57 |
+
/memorize The project deadline is next Friday at 5 PM
|
| 58 |
+
|
| 59 |
+
# Store preferences
|
| 60 |
+
/memorize I prefer technical explanations with code examples
|
| 61 |
+
|
| 62 |
+
# Store reminders
|
| 63 |
+
/memorize Don't forget to review the pull request
|
| 64 |
+
|
| 65 |
+
# Store research notes
|
| 66 |
+
/memorize Quantum entanglement relates to our AI architecture discussion
|
| 67 |
+
```
|
| 68 |
+
|
| 69 |
+
**What Happens:**
|
| 70 |
+
1. Message stored in PostgreSQL
|
| 71 |
+
2. Embedding created and stored in ChromaDB
|
| 72 |
+
3. Available for future /recall queries
|
| 73 |
+
4. OPSIIE can reference it in conversations
|
| 74 |
+
|
| 75 |
+
### /recall - Retrieve Information
|
| 76 |
+
Pull relevant context from past conversations.
|
| 77 |
+
|
| 78 |
+
**Syntax:**
|
| 79 |
+
```bash
|
| 80 |
+
/recall <keyword>
|
| 81 |
+
```
|
| 82 |
+
|
| 83 |
+
**Examples:**
|
| 84 |
+
```bash
|
| 85 |
+
# Recall by topic
|
| 86 |
+
/recall project x
|
| 87 |
+
|
| 88 |
+
# Recall by date context
|
| 89 |
+
/recall last week discussion
|
| 90 |
+
|
| 91 |
+
# Recall by person
|
| 92 |
+
/recall meeting with John
|
| 93 |
+
|
| 94 |
+
# Recall by technology
|
| 95 |
+
/recall quantum computing
|
| 96 |
+
|
| 97 |
+
# Recall by preference
|
| 98 |
+
/recall my preferences
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
**What Happens:**
|
| 102 |
+
1. Semantic search in ChromaDB
|
| 103 |
+
2. Finds contextually similar memories
|
| 104 |
+
3. Retrieves top relevant conversations
|
| 105 |
+
4. Displays results with timestamps
|
| 106 |
+
5. OPSIIE uses context in next response
|
| 107 |
+
|
| 108 |
+
**Example Output:**
|
| 109 |
+
```
|
| 110 |
+
Retrieved Memories:
|
| 111 |
+
|
| 112 |
+
[2025-01-15 14:23]
|
| 113 |
+
Prompt: Tell me about project x
|
| 114 |
+
Response: Project X is the quantum computing initiative we discussed...
|
| 115 |
+
|
| 116 |
+
[2025-01-10 09:45]
|
| 117 |
+
Prompt: /memorize Project X deadline is March 15
|
| 118 |
+
Response: I've stored that information...
|
| 119 |
+
|
| 120 |
+
Found 2 relevant memories for 'project x'
|
| 121 |
+
```
|
| 122 |
+
|
| 123 |
+
### /forget - Exclude Last Interaction
|
| 124 |
+
Prevent the last conversation from being stored.
|
| 125 |
+
|
| 126 |
+
**Syntax:**
|
| 127 |
+
```bash
|
| 128 |
+
/forget
|
| 129 |
+
```
|
| 130 |
+
|
| 131 |
+
**Use Cases:**
|
| 132 |
+
```bash
|
| 133 |
+
# After inaccurate response
|
| 134 |
+
OPSIIE >> [incorrect information]
|
| 135 |
+
You >> /forget
|
| 136 |
+
|
| 137 |
+
# After hallucination
|
| 138 |
+
OPSIIE >> [hallucinated content]
|
| 139 |
+
You >> /forget
|
| 140 |
+
|
| 141 |
+
# After testing
|
| 142 |
+
You >> test command
|
| 143 |
+
OPSIIE >> [response]
|
| 144 |
+
You >> /forget
|
| 145 |
+
|
| 146 |
+
# After private information
|
| 147 |
+
You >> [sensitive data]
|
| 148 |
+
OPSIIE >> [response]
|
| 149 |
+
You >> /forget
|
| 150 |
+
```
|
| 151 |
+
|
| 152 |
+
**What Happens:**
|
| 153 |
+
1. Last prompt-response pair removed from memory
|
| 154 |
+
2. NOT stored in PostgreSQL
|
| 155 |
+
3. NOT stored in ChromaDB
|
| 156 |
+
4. Fresh start for next interaction
|
| 157 |
+
|
| 158 |
+
**Important**:
|
| 159 |
+
- Only affects the most recent interaction
|
| 160 |
+
- Cannot undo after next prompt
|
| 161 |
+
- Use immediately after unwanted response
|
| 162 |
+
|
| 163 |
+
## π― Soul Signature System
|
| 164 |
+
|
| 165 |
+
The Soul Signature is your personalized system prompt with highest priority in OPSIIE's context hierarchy.
|
| 166 |
+
|
| 167 |
+
### View Soul Signature
|
| 168 |
+
```bash
|
| 169 |
+
/soulsig
|
| 170 |
+
```
|
| 171 |
+
|
| 172 |
+
Displays your current Soul Signature from kun.py.
|
| 173 |
+
|
| 174 |
+
### Add to Soul Signature
|
| 175 |
+
```bash
|
| 176 |
+
/soulsig <message>
|
| 177 |
+
```
|
| 178 |
+
|
| 179 |
+
**Examples:**
|
| 180 |
+
```bash
|
| 181 |
+
# Communication style
|
| 182 |
+
/soulsig I prefer direct communication without pleasantries
|
| 183 |
+
|
| 184 |
+
# Preferences
|
| 185 |
+
/soulsig My favorite color is Lilac
|
| 186 |
+
|
| 187 |
+
# Instructions
|
| 188 |
+
/soulsig Do not reply using my middle name
|
| 189 |
+
|
| 190 |
+
# Context
|
| 191 |
+
/soulsig I'm currently working on a blockchain project
|
| 192 |
+
|
| 193 |
+
# Roles
|
| 194 |
+
/soulsig You are my physics lecturer
|
| 195 |
+
```
|
| 196 |
+
|
| 197 |
+
**What Happens:**
|
| 198 |
+
1. Message appended to your soul_sig in kun.py
|
| 199 |
+
2. Automatically included in all future conversations
|
| 200 |
+
3. OPSIIE prioritizes this information
|
| 201 |
+
4. Persists across sessions
|
| 202 |
+
|
| 203 |
+
### Wipe Soul Signature
|
| 204 |
+
```bash
|
| 205 |
+
/soulsig wipe
|
| 206 |
+
```
|
| 207 |
+
|
| 208 |
+
**β οΈ WARNING**: This permanently deletes your Soul Signature from kun.py
|
| 209 |
+
|
| 210 |
+
**Before Wiping:**
|
| 211 |
+
1. Soul Signature copied to temporary storage
|
| 212 |
+
2. Can be restored with `/soulsig heal` if done immediately
|
| 213 |
+
|
| 214 |
+
### Restore Soul Signature
|
| 215 |
+
```bash
|
| 216 |
+
/soulsig heal
|
| 217 |
+
```
|
| 218 |
+
|
| 219 |
+
Restores Soul Signature from temporary storage (only if recently wiped).
|
| 220 |
+
|
| 221 |
+
## π‘ Best Practices
|
| 222 |
+
|
| 223 |
+
### Effective Memorization
|
| 224 |
+
|
| 225 |
+
**DO:**
|
| 226 |
+
```bash
|
| 227 |
+
# Be specific
|
| 228 |
+
/memorize Project Alpha uses TensorFlow 2.x and PyTorch
|
| 229 |
+
|
| 230 |
+
# Include context
|
| 231 |
+
/memorize Meeting with Sarah on 2025-01-20 discussed budget concerns
|
| 232 |
+
|
| 233 |
+
# Store preferences clearly
|
| 234 |
+
/memorize I prefer code examples in Python with type hints
|
| 235 |
+
|
| 236 |
+
# Save important dates
|
| 237 |
+
/memorize Annual review scheduled for March 15, 2025
|
| 238 |
+
```
|
| 239 |
+
|
| 240 |
+
**DON'T:**
|
| 241 |
+
```bash
|
| 242 |
+
# Too vague
|
| 243 |
+
/memorize something important
|
| 244 |
+
|
| 245 |
+
# No context
|
| 246 |
+
/memorize tomorrow
|
| 247 |
+
|
| 248 |
+
# Redundant
|
| 249 |
+
/memorize (if already in conversation)
|
| 250 |
+
```
|
| 251 |
+
|
| 252 |
+
### Effective Recall
|
| 253 |
+
|
| 254 |
+
**DO:**
|
| 255 |
+
```bash
|
| 256 |
+
# Use specific keywords
|
| 257 |
+
/recall quantum entanglement discussion
|
| 258 |
+
|
| 259 |
+
# Reference timeframes
|
| 260 |
+
/recall last month's project discussion
|
| 261 |
+
|
| 262 |
+
# Use topics
|
| 263 |
+
/recall machine learning architecture
|
| 264 |
+
|
| 265 |
+
# Reference people
|
| 266 |
+
/recall conversation with Alice
|
| 267 |
+
```
|
| 268 |
+
|
| 269 |
+
**DON'T:**
|
| 270 |
+
```bash
|
| 271 |
+
# Too generic
|
| 272 |
+
/recall stuff
|
| 273 |
+
|
| 274 |
+
# Single letters
|
| 275 |
+
/recall a
|
| 276 |
+
|
| 277 |
+
# Empty
|
| 278 |
+
/recall
|
| 279 |
+
```
|
| 280 |
+
|
| 281 |
+
### Soul Signature Management
|
| 282 |
+
|
| 283 |
+
**Include:**
|
| 284 |
+
- Communication style preferences
|
| 285 |
+
- Areas of expertise and interest
|
| 286 |
+
- Personal preferences
|
| 287 |
+
- Contextual information
|
| 288 |
+
- Specific instructions
|
| 289 |
+
|
| 290 |
+
**Example Soul Signature:**
|
| 291 |
+
```python
|
| 292 |
+
'soul_sig': [
|
| 293 |
+
"Prefers direct, technical communication",
|
| 294 |
+
"Background in quantum physics and ML",
|
| 295 |
+
"Working on AI ethics research",
|
| 296 |
+
"Enjoys sarcastic humor",
|
| 297 |
+
"Prefers Python code examples",
|
| 298 |
+
"Do not use formal titles",
|
| 299 |
+
"My favorite color is Lilac",
|
| 300 |
+
"Currently based in Athens, Greece",
|
| 301 |
+
"Interested in blockchain applications in science"
|
| 302 |
+
]
|
| 303 |
+
```
|
| 304 |
+
|
| 305 |
+
## π How Memory Enhances Conversations
|
| 306 |
+
|
| 307 |
+
### Context Building
|
| 308 |
+
```
|
| 309 |
+
You: Tell me about neural networks
|
| 310 |
+
OPSIIE: Based on our previous discussions about quantum computing,
|
| 311 |
+
I'll connect this to our conversation last week about
|
| 312 |
+
quantum neural networks...
|
| 313 |
+
```
|
| 314 |
+
|
| 315 |
+
### Preference Recall
|
| 316 |
+
```
|
| 317 |
+
You: Explain gradient descent
|
| 318 |
+
OPSIIE: [Provides technical explanation with Python code,
|
| 319 |
+
remembering your Soul Signature preference for
|
| 320 |
+
code examples]
|
| 321 |
+
```
|
| 322 |
+
|
| 323 |
+
### Long-term Learning
|
| 324 |
+
```
|
| 325 |
+
You: What did we discuss about the project timeline?
|
| 326 |
+
OPSIIE: *recalls /memorize from 2 weeks ago*
|
| 327 |
+
You mentioned the deadline is March 15, and we
|
| 328 |
+
discussed the three-phase approach...
|
| 329 |
+
```
|
| 330 |
+
|
| 331 |
+
## π Memory Statistics
|
| 332 |
+
|
| 333 |
+
### View Memory Usage
|
| 334 |
+
```bash
|
| 335 |
+
/status
|
| 336 |
+
```
|
| 337 |
+
|
| 338 |
+
Shows:
|
| 339 |
+
- Total conversations stored
|
| 340 |
+
- Database size
|
| 341 |
+
- Vector database status
|
| 342 |
+
- Memory usage
|
| 343 |
+
|
| 344 |
+
## π Privacy & Security
|
| 345 |
+
|
| 346 |
+
### What's Stored
|
| 347 |
+
- All conversation prompts and responses
|
| 348 |
+
- Timestamps for each interaction
|
| 349 |
+
- Vector embeddings for semantic search
|
| 350 |
+
- Soul Signature preferences
|
| 351 |
+
|
| 352 |
+
### What's NOT Stored
|
| 353 |
+
- Conversations after `/forget`
|
| 354 |
+
- Temporary file context (after `/close`)
|
| 355 |
+
- Live voice conversations (unless explicitly requested)
|
| 356 |
+
|
| 357 |
+
### Data Isolation
|
| 358 |
+
- Each user has separate database connection (configured in kun.py)
|
| 359 |
+
- Users can only access their own memories
|
| 360 |
+
- R-Grade and A-Grade users are segregated
|
| 361 |
+
|
| 362 |
+
### Data Control
|
| 363 |
+
```bash
|
| 364 |
+
# Remove last interaction
|
| 365 |
+
/forget
|
| 366 |
+
|
| 367 |
+
# Wipe personal preferences
|
| 368 |
+
/soulsig wipe
|
| 369 |
+
|
| 370 |
+
# Database is local - you have full control
|
| 371 |
+
```
|
| 372 |
+
|
| 373 |
+
## 𧬠Technical Details
|
| 374 |
+
|
| 375 |
+
### Vector Embeddings
|
| 376 |
+
- Model: `sentence-transformers/all-MiniLM-L6-v2`
|
| 377 |
+
- Dimension: 384
|
| 378 |
+
- Similarity: Cosine similarity
|
| 379 |
+
- Threshold: Configurable
|
| 380 |
+
|
| 381 |
+
### Storage Optimization
|
| 382 |
+
- Conversation deduplication
|
| 383 |
+
- Automatic pruning (configurable)
|
| 384 |
+
- Efficient indexing
|
| 385 |
+
- Compressed embeddings
|
| 386 |
+
|
| 387 |
+
### Retrieval Algorithm
|
| 388 |
+
1. Query vectorization
|
| 389 |
+
2. Semantic search in ChromaDB
|
| 390 |
+
3. Top-k results selection (default k=5)
|
| 391 |
+
4. Relevance ranking
|
| 392 |
+
5. Context injection into prompt
|
| 393 |
+
|
| 394 |
+
## β οΈ Limitations
|
| 395 |
+
|
| 396 |
+
### Current Limitations
|
| 397 |
+
- No conversation editing after storage
|
| 398 |
+
- `/forget` only works for last interaction
|
| 399 |
+
- Soul Signature changes require editing kun.py directly (except `/soulsig` append)
|
| 400 |
+
- No memory export feature (direct database access required)
|
| 401 |
+
- No automatic memory summarization
|
| 402 |
+
|
| 403 |
+
### Workarounds
|
| 404 |
+
```bash
|
| 405 |
+
# To update stored information
|
| 406 |
+
/memorize [Updated information] (overwrites in practice via relevance)
|
| 407 |
+
|
| 408 |
+
# To clear specific memories
|
| 409 |
+
# Requires direct database access
|
| 410 |
+
DELETE FROM conversations WHERE prompt LIKE '%specific topic%';
|
| 411 |
+
```
|
| 412 |
+
|
| 413 |
+
## π Advanced Usage
|
| 414 |
+
|
| 415 |
+
### Memory-Driven Workflows
|
| 416 |
+
|
| 417 |
+
**Research Assistant**
|
| 418 |
+
```bash
|
| 419 |
+
# Store research findings
|
| 420 |
+
/memorize Paper X shows quantum advantage in specific algorithms
|
| 421 |
+
|
| 422 |
+
# Recall during writing
|
| 423 |
+
/recall quantum advantage
|
| 424 |
+
|
| 425 |
+
# Build knowledge base over time
|
| 426 |
+
```
|
| 427 |
+
|
| 428 |
+
**Project Management**
|
| 429 |
+
```bash
|
| 430 |
+
# Store milestones
|
| 431 |
+
/memorize Phase 1 completed on 2025-01-20
|
| 432 |
+
|
| 433 |
+
# Track decisions
|
| 434 |
+
/memorize Team decided to use microservices architecture
|
| 435 |
+
|
| 436 |
+
# Recall history
|
| 437 |
+
/recall project decisions
|
| 438 |
+
```
|
| 439 |
+
|
| 440 |
+
**Personal Knowledge Base**
|
| 441 |
+
```bash
|
| 442 |
+
# Store learning
|
| 443 |
+
/memorize Neural network backpropagation uses chain rule
|
| 444 |
+
|
| 445 |
+
# Recall concepts
|
| 446 |
+
/recall backpropagation
|
| 447 |
+
|
| 448 |
+
# Build on previous knowledge
|
| 449 |
+
Explains based on what you've already learned
|
| 450 |
+
```
|
| 451 |
+
|
| 452 |
+
## π Related Features
|
| 453 |
+
|
| 454 |
+
- **File Context** (`/read`, `/open`, `/close`): Temporary file-based memory
|
| 455 |
+
- **Room History** (`/room`): Conversation history in multi-agent rooms
|
| 456 |
+
- **Command History**: Terminal-level history (not in memory system)
|
| 457 |
+
|
| 458 |
+
## π§ Troubleshooting
|
| 459 |
+
|
| 460 |
+
### Memory Not Recalled
|
| 461 |
+
```
|
| 462 |
+
Problem: /recall returns no results
|
| 463 |
+
Solutions:
|
| 464 |
+
- Check keyword spelling
|
| 465 |
+
- Try broader keywords
|
| 466 |
+
- Verify conversation was not /forgotten
|
| 467 |
+
- Check database connection (/status)
|
| 468 |
+
```
|
| 469 |
+
|
| 470 |
+
### Slow Recall
|
| 471 |
+
```
|
| 472 |
+
Problem: /recall takes long time
|
| 473 |
+
Solutions:
|
| 474 |
+
- Large database needs optimization
|
| 475 |
+
- Check database performance
|
| 476 |
+
- Consider pruning old conversations
|
| 477 |
+
```
|
| 478 |
+
|
| 479 |
+
### Soul Signature Not Applied
|
| 480 |
+
```
|
| 481 |
+
Problem: OPSIIE ignores Soul Signature
|
| 482 |
+
Solutions:
|
| 483 |
+
- Verify kun.py has correct soul_sig
|
| 484 |
+
- Restart OPSIIE to reload
|
| 485 |
+
- Check for syntax errors in soul_sig list
|
| 486 |
+
```
|
| 487 |
+
|
| 488 |
+
## π Support
|
| 489 |
+
|
| 490 |
+
For memory system issues:
|
| 491 |
+
- Check database connection with `/status`
|
| 492 |
+
- Verify PostgreSQL is running
|
| 493 |
+
- Review kun.py configuration
|
| 494 |
+
- Contact: opsiebyarpa@gmail.com
|
| 495 |
+
|
| 496 |
+
---
|
| 497 |
+
|
| 498 |
+
**The Mnemonic Matrix is the foundation of OPSIIE's long-term intelligence and personalization.** π§
|
documentation/core-features/voice.md
ADDED
|
@@ -0,0 +1,502 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Voice Interaction System
|
| 2 |
+
|
| 3 |
+
OPSIIE's voice system provides comprehensive voice input/output capabilities using ElevenLabs for synthesis and Google Speech Recognition for input.
|
| 4 |
+
|
| 5 |
+
## π€ Overview
|
| 6 |
+
|
| 7 |
+
Voice capabilities include:
|
| 8 |
+
- **Full Voice Mode**: Both speak and listen
|
| 9 |
+
- **Voice Output Only**: OPSIIE speaks, you type
|
| 10 |
+
- **Voice Input Only**: You speak, OPSIIE types
|
| 11 |
+
- **Multi-Agent Voices**: Different voices for Nyx, G1, and OPSIIE
|
| 12 |
+
- **Voice Commands**: Natural language command detection
|
| 13 |
+
- **Live Voice Conversations**: Real-time voice chat with AI agents
|
| 14 |
+
|
| 15 |
+
## π§ Voice Modes
|
| 16 |
+
|
| 17 |
+
### /voice - Full Voice Mode
|
| 18 |
+
**Both speak and listen**
|
| 19 |
+
|
| 20 |
+
```bash
|
| 21 |
+
/voice
|
| 22 |
+
```
|
| 23 |
+
|
| 24 |
+
**Features:**
|
| 25 |
+
- OPSIIE speaks responses using ElevenLabs
|
| 26 |
+
- You speak commands/queries
|
| 27 |
+
- Natural conversation flow
|
| 28 |
+
- 20-second inactivity timeout
|
| 29 |
+
- Automatic voice command detection
|
| 30 |
+
|
| 31 |
+
**How to Use:**
|
| 32 |
+
1. Type `/voice` or say "voice"
|
| 33 |
+
2. Wait for activation confirmation
|
| 34 |
+
3. Speak naturally
|
| 35 |
+
4. OPSIIE responds with voice
|
| 36 |
+
5. Continue conversation
|
| 37 |
+
6. Say "voice off" or "exit voice mode" to deactivate
|
| 38 |
+
|
| 39 |
+
**Example Session:**
|
| 40 |
+
```
|
| 41 |
+
You: /voice
|
| 42 |
+
OPSIIE: "Verbal communication protocol established."
|
| 43 |
+
|
| 44 |
+
You: [speak] "What's the weather like?"
|
| 45 |
+
OPSIIE: [speaks response]
|
| 46 |
+
|
| 47 |
+
You: [speak] "voice off"
|
| 48 |
+
OPSIIE: "Verbal communication protocol bridge collapsed successfully."
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
### /voice1 - OPSIIE Speaks, You Type
|
| 52 |
+
**Output-only voice mode**
|
| 53 |
+
|
| 54 |
+
```bash
|
| 55 |
+
/voice1
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
**Use Cases:**
|
| 59 |
+
- Want to hear responses
|
| 60 |
+
- Prefer typing for accuracy
|
| 61 |
+
- Noisy environment
|
| 62 |
+
- Hands-free response consumption
|
| 63 |
+
|
| 64 |
+
**Example:**
|
| 65 |
+
```
|
| 66 |
+
You: /voice1
|
| 67 |
+
OPSIIE: [speaks] "Voice output mode activated."
|
| 68 |
+
|
| 69 |
+
You: [type] Tell me about quantum computing
|
| 70 |
+
OPSIIE: [speaks response]
|
| 71 |
+
|
| 72 |
+
You: /voiceoff
|
| 73 |
+
```
|
| 74 |
+
|
| 75 |
+
### /voice2 - You Speak, OPSIIE Types
|
| 76 |
+
**Input-only voice mode**
|
| 77 |
+
|
| 78 |
+
```bash
|
| 79 |
+
/voice2
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
**Use Cases:**
|
| 83 |
+
- Hands-free input
|
| 84 |
+
- Faster than typing
|
| 85 |
+
- Accessibility
|
| 86 |
+
- Quiet environment for reading
|
| 87 |
+
|
| 88 |
+
**Example:**
|
| 89 |
+
```
|
| 90 |
+
You: /voice2
|
| 91 |
+
OPSIIE: Voice input mode activated.
|
| 92 |
+
|
| 93 |
+
You: [speak] "Explain neural networks"
|
| 94 |
+
OPSIIE: [types response]
|
| 95 |
+
|
| 96 |
+
You: /voiceoff
|
| 97 |
+
```
|
| 98 |
+
|
| 99 |
+
### /voiceoff - Disable Voice Mode
|
| 100 |
+
**Deactivate all voice features**
|
| 101 |
+
|
| 102 |
+
```bash
|
| 103 |
+
/voiceoff
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
Or voice command:
|
| 107 |
+
```
|
| 108 |
+
"voice off"
|
| 109 |
+
"exit voice mode"
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
## π£οΈ Voice Commands
|
| 113 |
+
|
| 114 |
+
### Natural Language Detection
|
| 115 |
+
Voice mode automatically detects command intent from natural speech:
|
| 116 |
+
|
| 117 |
+
**Memory Commands:**
|
| 118 |
+
```
|
| 119 |
+
"recall my last project" β /recall last project
|
| 120 |
+
"memorize this is important" β /memorize this is important
|
| 121 |
+
```
|
| 122 |
+
|
| 123 |
+
**System Commands:**
|
| 124 |
+
```
|
| 125 |
+
"status" β /status
|
| 126 |
+
"help" β /help
|
| 127 |
+
"theme" β /theme (opens theme selector)
|
| 128 |
+
```
|
| 129 |
+
|
| 130 |
+
**AI Generation:**
|
| 131 |
+
```
|
| 132 |
+
"imagine a futuristic city" β /imagine a futuristic city
|
| 133 |
+
"generate music jazz piano" β /music jazz piano
|
| 134 |
+
"create video of sunset" β /video sunset
|
| 135 |
+
```
|
| 136 |
+
|
| 137 |
+
**File Operations:**
|
| 138 |
+
```
|
| 139 |
+
"read the file report.pdf" β /read "report.pdf"
|
| 140 |
+
"open the document" β /open
|
| 141 |
+
"close file context" β /close
|
| 142 |
+
```
|
| 143 |
+
|
| 144 |
+
### Voice Command Examples
|
| 145 |
+
```bash
|
| 146 |
+
# Works in voice mode:
|
| 147 |
+
You: [speak] "recall our discussion about AI"
|
| 148 |
+
OPSIIE: [executes /recall] [speaks results]
|
| 149 |
+
|
| 150 |
+
You: [speak] "memorize project deadline is Friday"
|
| 151 |
+
OPSIIE: [executes /memorize] [confirms]
|
| 152 |
+
|
| 153 |
+
You: [speak] "show me system status"
|
| 154 |
+
OPSIIE: [executes /status] [displays status]
|
| 155 |
+
|
| 156 |
+
You: [speak] "imagine a cyberpunk cityscape"
|
| 157 |
+
OPSIIE: [executes /imagine] [generates image] [confirms]
|
| 158 |
+
```
|
| 159 |
+
|
| 160 |
+
## π Multi-Agent Voices
|
| 161 |
+
|
| 162 |
+
### Agent Voice Configuration
|
| 163 |
+
Each AI agent has a unique voice configured via ElevenLabs:
|
| 164 |
+
|
| 165 |
+
```env
|
| 166 |
+
# .env configuration
|
| 167 |
+
VOICE_ID=your_opsiie_voice_id # OPSIIE's voice
|
| 168 |
+
NYX_VOICE_ID=your_nyx_voice_id # Nyx's voice
|
| 169 |
+
G1_VOICE_ID=your_g1_voice_id # G1 Black's voice
|
| 170 |
+
```
|
| 171 |
+
|
| 172 |
+
### Agent Voice Usage
|
| 173 |
+
|
| 174 |
+
**OPSIIE Voice:**
|
| 175 |
+
```bash
|
| 176 |
+
# Default for all OPSIIE responses
|
| 177 |
+
You: Tell me about AI
|
| 178 |
+
OPSIIE: [responds in OPSIIE voice]
|
| 179 |
+
```
|
| 180 |
+
|
| 181 |
+
**Nyx Voice:**
|
| 182 |
+
```bash
|
| 183 |
+
/ask Nyx What are the latest quantum computing developments?
|
| 184 |
+
# Nyx responds in Nyx's voice (if voice mode active)
|
| 185 |
+
```
|
| 186 |
+
|
| 187 |
+
**G1 Black Voice:**
|
| 188 |
+
```bash
|
| 189 |
+
/ask G1 Analyze this technical problem
|
| 190 |
+
# G1 responds in G1's voice (if voice mode active)
|
| 191 |
+
```
|
| 192 |
+
|
| 193 |
+
## π Live Voice Conversations
|
| 194 |
+
|
| 195 |
+
### G1 Live Voice
|
| 196 |
+
**Real-time voice conversation with G1 Black**
|
| 197 |
+
|
| 198 |
+
```bash
|
| 199 |
+
/ask g1 live
|
| 200 |
+
```
|
| 201 |
+
|
| 202 |
+
**Features:**
|
| 203 |
+
- Direct WebSocket connection to ElevenLabs
|
| 204 |
+
- Real-time audio streaming
|
| 205 |
+
- Continuous conversation
|
| 206 |
+
- Press Ctrl+C to end
|
| 207 |
+
|
| 208 |
+
**How It Works:**
|
| 209 |
+
1. Establishes WebSocket connection
|
| 210 |
+
2. Starts audio input/output streams
|
| 211 |
+
3. You speak, G1 responds immediately
|
| 212 |
+
4. Continues until manually stopped
|
| 213 |
+
|
| 214 |
+
**Example Session:**
|
| 215 |
+
```
|
| 216 |
+
You: /ask g1 live
|
| 217 |
+
|
| 218 |
+
[System]: Live conversation with G1 Black initialized.
|
| 219 |
+
[System]: Speak naturally. Press Ctrl+C to end the conversation.
|
| 220 |
+
|
| 221 |
+
You: [speak] What's happening with Bitcoin?
|
| 222 |
+
G1 Black: [responds in real-time]
|
| 223 |
+
|
| 224 |
+
You: [speak] And what about Ethereum?
|
| 225 |
+
G1 Black: [responds immediately]
|
| 226 |
+
|
| 227 |
+
[Press Ctrl+C]
|
| 228 |
+
[System]: Ending live conversation...
|
| 229 |
+
[System]: Live conversation session concluded.
|
| 230 |
+
```
|
| 231 |
+
|
| 232 |
+
### Kronos Live Voice
|
| 233 |
+
**Live conversation with Kronos (Greek Internal Auditor)**
|
| 234 |
+
|
| 235 |
+
```bash
|
| 236 |
+
/ask kronos live
|
| 237 |
+
```
|
| 238 |
+
|
| 239 |
+
Similar to G1 live mode, specialized for Greek internal auditing.
|
| 240 |
+
|
| 241 |
+
## π Voice Synthesis (ElevenLabs)
|
| 242 |
+
|
| 243 |
+
### Configuration
|
| 244 |
+
```env
|
| 245 |
+
ELEVENLABS_API_KEY=your_api_key
|
| 246 |
+
VOICE_ID=your_voice_id
|
| 247 |
+
```
|
| 248 |
+
|
| 249 |
+
### How It Works
|
| 250 |
+
1. Text response generated by OPSIIE
|
| 251 |
+
2. Sent to ElevenLabs API
|
| 252 |
+
3. Audio synthesized with specified voice
|
| 253 |
+
4. Streamed and played back
|
| 254 |
+
5. Temporary file cleaned up
|
| 255 |
+
|
| 256 |
+
### Voice Parameters
|
| 257 |
+
- **Optimize Streaming**: Latency=3 (fastest)
|
| 258 |
+
- **Format**: MP3
|
| 259 |
+
- **Playback**: pygame.mixer
|
| 260 |
+
- **Cleanup**: Automatic temp file deletion
|
| 261 |
+
|
| 262 |
+
### API Verification
|
| 263 |
+
OPSIIE verifies ElevenLabs API on startup:
|
| 264 |
+
```
|
| 265 |
+
Checking Eleven Labs API access... β
|
| 266 |
+
```
|
| 267 |
+
|
| 268 |
+
## π§ Speech Recognition (Google)
|
| 269 |
+
|
| 270 |
+
### How It Works
|
| 271 |
+
1. Microphone captures audio
|
| 272 |
+
2. Google Speech API transcribes
|
| 273 |
+
3. Text processed as command/query
|
| 274 |
+
4. OPSIIE responds
|
| 275 |
+
|
| 276 |
+
### Recognition Settings
|
| 277 |
+
- **Engine**: Google Speech Recognition
|
| 278 |
+
- **Language**: English (default)
|
| 279 |
+
- **Timeout**: 20 seconds inactivity
|
| 280 |
+
- **Format**: 16-bit PCM
|
| 281 |
+
|
| 282 |
+
### Microphone Configuration
|
| 283 |
+
```python
|
| 284 |
+
recognizer = sr.Recognizer()
|
| 285 |
+
mic = sr.Microphone()
|
| 286 |
+
```
|
| 287 |
+
|
| 288 |
+
### Custom Word Recognition
|
| 289 |
+
OPSIIE has enhanced recognition for specific phrases:
|
| 290 |
+
|
| 291 |
+
**Custom Audio Patterns:**
|
| 292 |
+
```python
|
| 293 |
+
custom_words = {
|
| 294 |
+
"Opsie": [...],
|
| 295 |
+
"Voice off": [...],
|
| 296 |
+
"send Base Degen": [...],
|
| 297 |
+
# ... custom patterns
|
| 298 |
+
}
|
| 299 |
+
```
|
| 300 |
+
|
| 301 |
+
Uses MFCC (Mel-frequency cepstral coefficients) for pattern matching.
|
| 302 |
+
|
| 303 |
+
## π‘ Best Practices
|
| 304 |
+
|
| 305 |
+
### For Best Recognition
|
| 306 |
+
|
| 307 |
+
**DO:**
|
| 308 |
+
- Speak clearly and at normal pace
|
| 309 |
+
- Use natural language
|
| 310 |
+
- Pause between commands
|
| 311 |
+
- Minimize background noise
|
| 312 |
+
- Position microphone correctly
|
| 313 |
+
|
| 314 |
+
**DON'T:**
|
| 315 |
+
- Speak too fast or mumble
|
| 316 |
+
- Use overly technical jargon
|
| 317 |
+
- Interrupt OPSIIE mid-response
|
| 318 |
+
- Use in very noisy environments
|
| 319 |
+
|
| 320 |
+
### For Best Experience
|
| 321 |
+
|
| 322 |
+
**Voice Mode Selection:**
|
| 323 |
+
```bash
|
| 324 |
+
# For hands-free operation
|
| 325 |
+
/voice
|
| 326 |
+
|
| 327 |
+
# For quiet response consumption
|
| 328 |
+
/voice1
|
| 329 |
+
|
| 330 |
+
# For hands-free input only
|
| 331 |
+
/voice2
|
| 332 |
+
```
|
| 333 |
+
|
| 334 |
+
**Timeout Management:**
|
| 335 |
+
- Voice mode auto-exits after 20 seconds silence
|
| 336 |
+
- Keep conversation flowing
|
| 337 |
+
- Say "voice off" to exit manually
|
| 338 |
+
|
| 339 |
+
**Command Clarity:**
|
| 340 |
+
```bash
|
| 341 |
+
# Clear commands
|
| 342 |
+
"recall project alpha"
|
| 343 |
+
"memorize deadline Friday"
|
| 344 |
+
"imagine cyberpunk city"
|
| 345 |
+
|
| 346 |
+
# Avoid ambiguous
|
| 347 |
+
"that thing"
|
| 348 |
+
"you know what I mean"
|
| 349 |
+
```
|
| 350 |
+
|
| 351 |
+
## π§ Troubleshooting
|
| 352 |
+
|
| 353 |
+
### Microphone Not Detected
|
| 354 |
+
```
|
| 355 |
+
Error: No microphone found
|
| 356 |
+
```
|
| 357 |
+
|
| 358 |
+
**Solutions:**
|
| 359 |
+
1. Check microphone connection
|
| 360 |
+
2. Verify microphone permissions
|
| 361 |
+
3. Set default microphone in Windows
|
| 362 |
+
4. Restart application
|
| 363 |
+
|
| 364 |
+
### Voice Synthesis Errors
|
| 365 |
+
```
|
| 366 |
+
Error with Eleven Labs API
|
| 367 |
+
```
|
| 368 |
+
|
| 369 |
+
**Solutions:**
|
| 370 |
+
1. Check API key validity
|
| 371 |
+
2. Verify VOICE_ID is correct
|
| 372 |
+
3. Check internet connection
|
| 373 |
+
4. Verify API usage limits
|
| 374 |
+
5. Check API status at elevenlabs.io
|
| 375 |
+
|
| 376 |
+
### Recognition Issues
|
| 377 |
+
```
|
| 378 |
+
Could not understand audio
|
| 379 |
+
```
|
| 380 |
+
|
| 381 |
+
**Solutions:**
|
| 382 |
+
1. Speak more clearly
|
| 383 |
+
2. Reduce background noise
|
| 384 |
+
3. Move closer to microphone
|
| 385 |
+
4. Adjust microphone gain
|
| 386 |
+
5. Check internet connection
|
| 387 |
+
|
| 388 |
+
### Voice Mode Won't Deactivate
|
| 389 |
+
```
|
| 390 |
+
Voice mode stuck
|
| 391 |
+
```
|
| 392 |
+
|
| 393 |
+
**Solutions:**
|
| 394 |
+
1. Say "voice off" clearly
|
| 395 |
+
2. Press Ctrl+C
|
| 396 |
+
3. Type /voiceoff in terminal
|
| 397 |
+
4. Restart application
|
| 398 |
+
|
| 399 |
+
## π― Voice Mode Use Cases
|
| 400 |
+
|
| 401 |
+
### Research & Writing
|
| 402 |
+
```bash
|
| 403 |
+
/voice2 # Hands-free input
|
| 404 |
+
[dictate] "Search for papers on quantum entanglement"
|
| 405 |
+
[dictate] "Summarize the key findings"
|
| 406 |
+
[dictate] "Add this to my research notes"
|
| 407 |
+
```
|
| 408 |
+
|
| 409 |
+
### Accessibility
|
| 410 |
+
```bash
|
| 411 |
+
/voice # Full voice interaction
|
| 412 |
+
[speak] commands and queries
|
| 413 |
+
[hear] all responses
|
| 414 |
+
# Fully hands-free operation
|
| 415 |
+
```
|
| 416 |
+
|
| 417 |
+
### Multitasking
|
| 418 |
+
```bash
|
| 419 |
+
/voice1 # Type while hearing responses
|
| 420 |
+
[type] Complex queries
|
| 421 |
+
[listen] While doing other tasks
|
| 422 |
+
```
|
| 423 |
+
|
| 424 |
+
### Live Consultation
|
| 425 |
+
```bash
|
| 426 |
+
/ask g1 live # Real-time voice chat
|
| 427 |
+
[discuss] Technical problems
|
| 428 |
+
[get] Immediate responses
|
| 429 |
+
[iterate] On solutions
|
| 430 |
+
```
|
| 431 |
+
|
| 432 |
+
## π Voice Statistics
|
| 433 |
+
|
| 434 |
+
Check voice system status:
|
| 435 |
+
```bash
|
| 436 |
+
/status
|
| 437 |
+
```
|
| 438 |
+
|
| 439 |
+
Shows:
|
| 440 |
+
- Voice mode (active/inactive)
|
| 441 |
+
- Current mode (voice/voice1/voice2)
|
| 442 |
+
- ElevenLabs API status
|
| 443 |
+
- Microphone status
|
| 444 |
+
- Speech recognition status
|
| 445 |
+
|
| 446 |
+
## π Privacy & Security
|
| 447 |
+
|
| 448 |
+
### What's Transmitted
|
| 449 |
+
- Voice audio to Google for recognition (temporary)
|
| 450 |
+
- Text to ElevenLabs for synthesis
|
| 451 |
+
- No voice recordings stored locally
|
| 452 |
+
- No voice data in conversation history
|
| 453 |
+
|
| 454 |
+
### Data Protection
|
| 455 |
+
- Voice processed in real-time
|
| 456 |
+
- No permanent voice storage
|
| 457 |
+
- Text-only conversation storage
|
| 458 |
+
- API communications encrypted
|
| 459 |
+
|
| 460 |
+
## π Advanced Usage
|
| 461 |
+
|
| 462 |
+
### Voice-Driven Workflows
|
| 463 |
+
```bash
|
| 464 |
+
# Morning briefing
|
| 465 |
+
/voice
|
| 466 |
+
[speak] "status"
|
| 467 |
+
[speak] "recall yesterday's tasks"
|
| 468 |
+
[speak] "what's on the schedule"
|
| 469 |
+
|
| 470 |
+
# Research session
|
| 471 |
+
/voice2
|
| 472 |
+
[speak] "read the paper on quantum computing"
|
| 473 |
+
[speak] "summarize the methodology"
|
| 474 |
+
[speak] "what are the key findings"
|
| 475 |
+
|
| 476 |
+
# Creative work
|
| 477 |
+
/voice
|
| 478 |
+
[speak] "imagine a futuristic laboratory"
|
| 479 |
+
[speak] "generate music ambient electronic"
|
| 480 |
+
[speak] "create video of abstract particles"
|
| 481 |
+
```
|
| 482 |
+
|
| 483 |
+
### Multi-Modal Interaction
|
| 484 |
+
```bash
|
| 485 |
+
# Mix voice and text
|
| 486 |
+
/voice
|
| 487 |
+
[speak] "markets tesla" # Voice command
|
| 488 |
+
[read] Market data displayed
|
| 489 |
+
[type] /markets compare tsla nio # Text command for complex syntax
|
| 490 |
+
[speak] "what do you think" # Voice query
|
| 491 |
+
```
|
| 492 |
+
|
| 493 |
+
## π Related Features
|
| 494 |
+
|
| 495 |
+
- **Live Conversations**: `/ask g1 live`, `/ask kronos live`
|
| 496 |
+
- **Command Help**: `/help voice`
|
| 497 |
+
- **Theme Changes**: Voice command "theme"
|
| 498 |
+
- **Multi-Agent**: Agent-specific voices in `/room`
|
| 499 |
+
|
| 500 |
+
---
|
| 501 |
+
|
| 502 |
+
**Voice interaction makes OPSIIE truly hands-free and accessible.** π€
|
documentation/getting-started/configuration.md
ADDED
|
@@ -0,0 +1,393 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Configuration Guide
|
| 2 |
+
|
| 3 |
+
Comprehensive guide for configuring OPSIIE 0.3.79 XP to match your preferences and requirements.
|
| 4 |
+
|
| 5 |
+
## π§ Configuration Files
|
| 6 |
+
|
| 7 |
+
### Primary Configuration Files
|
| 8 |
+
1. **`.env`** - Environment variables and API keys
|
| 9 |
+
2. **`kun.py`** - User profiles and Soul Signatures
|
| 10 |
+
3. **`terminal_colors.py`** - Theme configuration (Pastel/Vibrant)
|
| 11 |
+
|
| 12 |
+
## π Environment Variables (.env)
|
| 13 |
+
|
| 14 |
+
### Database Configuration
|
| 15 |
+
```env
|
| 16 |
+
DB_NAME=mnemonic_computer # PostgreSQL database name
|
| 17 |
+
DB_USER=your_username # Database username
|
| 18 |
+
DB_PASSWORD=your_password # Database password
|
| 19 |
+
DB_HOST=localhost # Database host
|
| 20 |
+
DB_PORT=5432 # Database port
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
### AI Model APIs
|
| 24 |
+
```env
|
| 25 |
+
# OpenAI (for Nyx agent)
|
| 26 |
+
OPENAI_API_KEY=sk-...
|
| 27 |
+
ORG_ID=org-...
|
| 28 |
+
NYX_ASSISTANT_ID=asst_...
|
| 29 |
+
|
| 30 |
+
# Google AI (for G1 Black agent)
|
| 31 |
+
GOOGLE_API_KEY=AIza...
|
| 32 |
+
G1_VOICE_LIVE=your_g1_agent_id
|
| 33 |
+
|
| 34 |
+
# Kronos (Greek Internal Auditor)
|
| 35 |
+
KRONOS_LIVE=your_kronos_agent_id
|
| 36 |
+
|
| 37 |
+
# ElevenLabs (Voice synthesis)
|
| 38 |
+
ELEVENLABS_API_KEY=...
|
| 39 |
+
VOICE_ID=... # OPSIIE's voice
|
| 40 |
+
NYX_VOICE_ID=... # Nyx's voice
|
| 41 |
+
G1_VOICE_ID=... # G1's voice
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
### Web3 & Blockchain
|
| 45 |
+
```env
|
| 46 |
+
AGENT_PRIVATE_KEY=0x... # OPSIIE's Ethereum private key
|
| 47 |
+
BASE_RPC_URL=https://... # Base network RPC
|
| 48 |
+
ETHEREUM_RPC_URL=https://... # Ethereum mainnet RPC
|
| 49 |
+
POLYGON_RPC_URL=https://... # Polygon network RPC
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
### Email Configuration
|
| 53 |
+
```env
|
| 54 |
+
SENDER_EMAIL=your_email@gmail.com
|
| 55 |
+
SENDER_PASSWORD=your_app_password # Gmail app-specific password
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
### Scientific APIs
|
| 59 |
+
```env
|
| 60 |
+
NCBI_EMAIL=your_email@example.com # For DNA analysis features
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
## π€ User Profile Configuration (kun.py)
|
| 64 |
+
|
| 65 |
+
### Access Levels
|
| 66 |
+
|
| 67 |
+
**R-Grade (Master Access)**
|
| 68 |
+
- Full system access
|
| 69 |
+
- All experimental features
|
| 70 |
+
- Web3 operations (`/0x` commands)
|
| 71 |
+
- Advanced AI agents (`/ask`, `/room`)
|
| 72 |
+
- Financial intelligence (`/markets`)
|
| 73 |
+
- DNA analysis (`/dna`)
|
| 74 |
+
|
| 75 |
+
**A-Grade (Standard Access)**
|
| 76 |
+
- Basic conversation
|
| 77 |
+
- File operations (`/read`, `/open`, `/close`)
|
| 78 |
+
- Voice features (`/voice`, `/voice1`, `/voice2`)
|
| 79 |
+
- Limited AI generation (`/imagine`, `/video`, `/music`)
|
| 80 |
+
- Email (`/mail`)
|
| 81 |
+
|
| 82 |
+
### User Profile Structure
|
| 83 |
+
```python
|
| 84 |
+
users = {
|
| 85 |
+
'YourName': {
|
| 86 |
+
# Basic Information
|
| 87 |
+
'full_name': 'Your Full Name',
|
| 88 |
+
'call_name': 'Your Preferred Name',
|
| 89 |
+
'arpa_id': 'R001', # R for Master, A for Standard
|
| 90 |
+
|
| 91 |
+
# Blockchain
|
| 92 |
+
'public0x': '0x...', # Your Ethereum wallet address
|
| 93 |
+
|
| 94 |
+
# Database Connection
|
| 95 |
+
'db_params': {
|
| 96 |
+
'dbname': 'mnemonic_computer',
|
| 97 |
+
'user': 'your_db_username',
|
| 98 |
+
'password': 'your_db_password',
|
| 99 |
+
'host': 'localhost',
|
| 100 |
+
'port': '5432'
|
| 101 |
+
},
|
| 102 |
+
|
| 103 |
+
# Authentication
|
| 104 |
+
'picture': r'C:\path\to\your\photo.jpg',
|
| 105 |
+
|
| 106 |
+
# Communication
|
| 107 |
+
'mail': 'your_email@example.com',
|
| 108 |
+
|
| 109 |
+
# Soul Signature (Personalization)
|
| 110 |
+
'soul_sig': [
|
| 111 |
+
"Prefers direct communication",
|
| 112 |
+
"Values efficiency and precision",
|
| 113 |
+
"Enjoys technical discussions",
|
| 114 |
+
# Add your preferences here
|
| 115 |
+
],
|
| 116 |
+
}
|
| 117 |
+
}
|
| 118 |
+
```
|
| 119 |
+
|
| 120 |
+
### Soul Signature Guidelines
|
| 121 |
+
|
| 122 |
+
The Soul Signature is the highest-priority personalization system. Include:
|
| 123 |
+
|
| 124 |
+
**Communication Preferences**
|
| 125 |
+
```python
|
| 126 |
+
"Prefers direct communication without pleasantries"
|
| 127 |
+
"Values detailed technical explanations"
|
| 128 |
+
"Likes sarcastic humor and wit"
|
| 129 |
+
"Avoids template-like responses"
|
| 130 |
+
```
|
| 131 |
+
|
| 132 |
+
**Interests & Expertise**
|
| 133 |
+
```python
|
| 134 |
+
"Deep interest in blockchain technology"
|
| 135 |
+
"Background in molecular biology"
|
| 136 |
+
"Enjoys philosophical discussions"
|
| 137 |
+
"Works in quantum computing field"
|
| 138 |
+
```
|
| 139 |
+
|
| 140 |
+
**Interface Preferences**
|
| 141 |
+
```python
|
| 142 |
+
"Prefers dark mode interfaces"
|
| 143 |
+
"Likes minimalist design"
|
| 144 |
+
"Values visual data representations"
|
| 145 |
+
```
|
| 146 |
+
|
| 147 |
+
**Interaction Patterns**
|
| 148 |
+
```python
|
| 149 |
+
"Remembers past conversations and builds on them"
|
| 150 |
+
"Appreciates when OPSIIE shows initiative"
|
| 151 |
+
"Enjoys creative and artistic pursuits"
|
| 152 |
+
```
|
| 153 |
+
|
| 154 |
+
**Personal Instructions**
|
| 155 |
+
```python
|
| 156 |
+
"Do not use my middle name"
|
| 157 |
+
"My favorite color is Lilac"
|
| 158 |
+
"Call me by my nickname in casual conversations"
|
| 159 |
+
"I'm working on a project about AI ethics"
|
| 160 |
+
```
|
| 161 |
+
|
| 162 |
+
## π¨ Theme Configuration
|
| 163 |
+
|
| 164 |
+
### Available Themes
|
| 165 |
+
1. **Pastel** - Soft, muted colors for gentle visual experience
|
| 166 |
+
2. **Vibrant** - High-contrast, bold colors for enhanced visibility
|
| 167 |
+
|
| 168 |
+
### Theme Selection
|
| 169 |
+
|
| 170 |
+
**At Startup**
|
| 171 |
+
- Choose theme during splash screen
|
| 172 |
+
- Default is Pastel
|
| 173 |
+
|
| 174 |
+
**During Conversation**
|
| 175 |
+
```bash
|
| 176 |
+
/theme # Opens theme selector
|
| 177 |
+
# Or voice command: "theme"
|
| 178 |
+
```
|
| 179 |
+
|
| 180 |
+
### Custom Theme Colors (terminal_colors.py)
|
| 181 |
+
|
| 182 |
+
```python
|
| 183 |
+
PASTEL = {
|
| 184 |
+
'lilac': (200, 162, 200),
|
| 185 |
+
'pink': (255, 182, 193),
|
| 186 |
+
'green': (152, 251, 152),
|
| 187 |
+
# ... other colors
|
| 188 |
+
}
|
| 189 |
+
|
| 190 |
+
VIBRANT = {
|
| 191 |
+
'lilac': (138, 43, 226),
|
| 192 |
+
'pink': (255, 20, 147),
|
| 193 |
+
'green': (0, 255, 0),
|
| 194 |
+
# ... other colors
|
| 195 |
+
}
|
| 196 |
+
```
|
| 197 |
+
|
| 198 |
+
## π Voice Configuration
|
| 199 |
+
|
| 200 |
+
### Voice Modes
|
| 201 |
+
```bash
|
| 202 |
+
/voice # Full voice mode (both speak and listen)
|
| 203 |
+
/voice1 # OPSIIE speaks, you type
|
| 204 |
+
/voice2 # You speak, OPSIIE types
|
| 205 |
+
/voiceoff # Disable voice mode
|
| 206 |
+
```
|
| 207 |
+
|
| 208 |
+
### ElevenLabs Voice IDs
|
| 209 |
+
Configure in `.env`:
|
| 210 |
+
```env
|
| 211 |
+
VOICE_ID=your_opsiie_voice_id # OPSIIE's primary voice
|
| 212 |
+
NYX_VOICE_ID=your_nyx_voice_id # Nyx agent's voice
|
| 213 |
+
G1_VOICE_ID=your_g1_voice_id # G1 Black agent's voice
|
| 214 |
+
```
|
| 215 |
+
|
| 216 |
+
### Speech Recognition Settings
|
| 217 |
+
- Language: English (default)
|
| 218 |
+
- Timeout: 20 seconds of inactivity
|
| 219 |
+
- Custom word recognition for commands
|
| 220 |
+
|
| 221 |
+
## 𧬠DNA Analysis Configuration
|
| 222 |
+
|
| 223 |
+
### NCBI Email
|
| 224 |
+
Required for DNA analysis features:
|
| 225 |
+
```env
|
| 226 |
+
NCBI_EMAIL=your_email@example.com
|
| 227 |
+
```
|
| 228 |
+
|
| 229 |
+
### Database Access
|
| 230 |
+
- UniProt: Protein sequences
|
| 231 |
+
- Pfam: Protein families
|
| 232 |
+
- PROSITE: Protein patterns
|
| 233 |
+
- Rfam: RNA families
|
| 234 |
+
- miRBase: microRNA sequences
|
| 235 |
+
- GtRNAdb: tRNA sequences
|
| 236 |
+
|
| 237 |
+
## π° Web3 Configuration
|
| 238 |
+
|
| 239 |
+
### Supported Chains
|
| 240 |
+
```python
|
| 241 |
+
CHAIN_INFO = {
|
| 242 |
+
'Base': {
|
| 243 |
+
'chain_id': 8453,
|
| 244 |
+
'rpc_url': os.getenv('BASE_RPC_URL'),
|
| 245 |
+
'symbol': 'ETH',
|
| 246 |
+
'explorer_url': 'https://basescan.org'
|
| 247 |
+
},
|
| 248 |
+
'Ethereum': {
|
| 249 |
+
'chain_id': 1,
|
| 250 |
+
'rpc_url': os.getenv('ETHEREUM_RPC_URL'),
|
| 251 |
+
'symbol': 'ETH',
|
| 252 |
+
'explorer_url': 'https://etherscan.io'
|
| 253 |
+
},
|
| 254 |
+
'Polygon': {
|
| 255 |
+
'chain_id': 137,
|
| 256 |
+
'rpc_url': os.getenv('POLYGON_RPC_URL'),
|
| 257 |
+
'symbol': 'MATIC',
|
| 258 |
+
'explorer_url': 'https://polygonscan.com'
|
| 259 |
+
}
|
| 260 |
+
}
|
| 261 |
+
```
|
| 262 |
+
|
| 263 |
+
### Supported Tokens
|
| 264 |
+
```python
|
| 265 |
+
TOKENS = {
|
| 266 |
+
'Degen': {
|
| 267 |
+
'Base': '0x4ed4e862860bed51a9570b96d89af5e1b0efefed'
|
| 268 |
+
},
|
| 269 |
+
'USDC': {
|
| 270 |
+
'Base': '0x7F5c764cBc14f9669B88837ca1490cCa17c31607',
|
| 271 |
+
'Ethereum': '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606EB48',
|
| 272 |
+
'Polygon': '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174'
|
| 273 |
+
}
|
| 274 |
+
}
|
| 275 |
+
```
|
| 276 |
+
|
| 277 |
+
### Gas Strategy
|
| 278 |
+
```bash
|
| 279 |
+
/0x gas low # 80% of current gas price
|
| 280 |
+
/0x gas medium # 100% of current gas price (default)
|
| 281 |
+
/0x gas high # 150% of current gas price
|
| 282 |
+
```
|
| 283 |
+
|
| 284 |
+
## π§ Email Configuration
|
| 285 |
+
|
| 286 |
+
### Gmail Setup
|
| 287 |
+
1. Enable 2-Factor Authentication
|
| 288 |
+
2. Generate App-Specific Password
|
| 289 |
+
3. Add to `.env`:
|
| 290 |
+
```env
|
| 291 |
+
SENDER_EMAIL=your_email@gmail.com
|
| 292 |
+
SENDER_PASSWORD=your_app_password
|
| 293 |
+
```
|
| 294 |
+
|
| 295 |
+
### Known Contacts
|
| 296 |
+
Contacts are automatically mapped from kun.py user profiles:
|
| 297 |
+
```python
|
| 298 |
+
# Any user with 'mail' field becomes a known contact
|
| 299 |
+
'mail': 'contact@example.com'
|
| 300 |
+
```
|
| 301 |
+
|
| 302 |
+
## π File Processing Limits
|
| 303 |
+
|
| 304 |
+
### Web Content Limit
|
| 305 |
+
```bash
|
| 306 |
+
/weblimit 2000 # Set to 2000 characters (500-5000 range)
|
| 307 |
+
```
|
| 308 |
+
|
| 309 |
+
Default: 1000 characters
|
| 310 |
+
|
| 311 |
+
### Supported File Types
|
| 312 |
+
- PDF (.pdf)
|
| 313 |
+
- CSV (.csv)
|
| 314 |
+
- DOCX (.docx)
|
| 315 |
+
- TXT (.txt)
|
| 316 |
+
- XLSX (.xlsx)
|
| 317 |
+
|
| 318 |
+
## π΅ AI Generation Settings
|
| 319 |
+
|
| 320 |
+
### Image Generation (Hugging Face)
|
| 321 |
+
Default model: `black-forest-labs/FLUX.1-dev`
|
| 322 |
+
|
| 323 |
+
Change model:
|
| 324 |
+
```bash
|
| 325 |
+
/imagine model black-forest-labs/FLUX.1-dev
|
| 326 |
+
/imagine model hakurei/waifu-diffusion
|
| 327 |
+
```
|
| 328 |
+
|
| 329 |
+
### Video Generation
|
| 330 |
+
Default model: `damo-vilab/text-to-video-ms-1.7b` (ModelScope)
|
| 331 |
+
|
| 332 |
+
Available models:
|
| 333 |
+
- modelscope
|
| 334 |
+
- zeroscope
|
| 335 |
+
- videogen
|
| 336 |
+
- tuneavideo
|
| 337 |
+
|
| 338 |
+
Change model:
|
| 339 |
+
```bash
|
| 340 |
+
/video model zeroscope
|
| 341 |
+
```
|
| 342 |
+
|
| 343 |
+
### Music Generation
|
| 344 |
+
Model: `facebook/musicgen-small`
|
| 345 |
+
- Output: WAV format
|
| 346 |
+
- Saved to: `outputs/music/`
|
| 347 |
+
|
| 348 |
+
## π Configuration Updates
|
| 349 |
+
|
| 350 |
+
### Runtime Changes
|
| 351 |
+
Many settings can be changed during operation:
|
| 352 |
+
- Theme: `/theme`
|
| 353 |
+
- Web limit: `/weblimit <number>`
|
| 354 |
+
- Gas strategy: `/0x gas <level>`
|
| 355 |
+
- Image model: `/imagine model <name>`
|
| 356 |
+
- Video model: `/video model <name>`
|
| 357 |
+
|
| 358 |
+
### Persistent Changes
|
| 359 |
+
Edit configuration files and restart OPSIIE:
|
| 360 |
+
- `.env` for API keys and credentials
|
| 361 |
+
- `kun.py` for user profiles
|
| 362 |
+
- `web3_handler.py` for blockchain settings
|
| 363 |
+
|
| 364 |
+
## π Security Best Practices
|
| 365 |
+
|
| 366 |
+
1. **Never commit `.env` or `kun.py` to version control**
|
| 367 |
+
2. **Use environment variables for all secrets**
|
| 368 |
+
3. **Rotate API keys regularly**
|
| 369 |
+
4. **Use app-specific passwords for email**
|
| 370 |
+
5. **Keep private keys secure and backed up**
|
| 371 |
+
6. **Limit R-Grade access to trusted users only**
|
| 372 |
+
|
| 373 |
+
## π Configuration Checklist
|
| 374 |
+
|
| 375 |
+
- [ ] .env file created with all required keys
|
| 376 |
+
- [ ] PostgreSQL database created and configured
|
| 377 |
+
- [ ] Ollama installed with llama3 model
|
| 378 |
+
- [ ] kun.py configured with your profile
|
| 379 |
+
- [ ] User photo added for facial recognition
|
| 380 |
+
- [ ] ElevenLabs voices configured
|
| 381 |
+
- [ ] Web3 wallets configured (if using /0x features)
|
| 382 |
+
- [ ] Email credentials configured (if using /mail)
|
| 383 |
+
- [ ] NCBI email configured (if using /dna)
|
| 384 |
+
- [ ] Theme selected
|
| 385 |
+
- [ ] Output directories verified
|
| 386 |
+
|
| 387 |
+
## π Next Steps
|
| 388 |
+
|
| 389 |
+
After configuration:
|
| 390 |
+
1. Follow [First Run Guide](first-run.md)
|
| 391 |
+
2. Test basic commands
|
| 392 |
+
3. Customize Soul Signature
|
| 393 |
+
4. Explore [Basic Commands](../user-guides/basic-commands.md)
|
documentation/getting-started/first-run.md
ADDED
|
@@ -0,0 +1,418 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# First Run Guide
|
| 2 |
+
|
| 3 |
+
Your complete guide to running OPSIIE for the first time and understanding the startup process.
|
| 4 |
+
|
| 5 |
+
## π Starting OPSIIE
|
| 6 |
+
|
| 7 |
+
### Launch Command
|
| 8 |
+
```bash
|
| 9 |
+
python OPSIIE_0_3_79_XP.py
|
| 10 |
+
```
|
| 11 |
+
|
| 12 |
+
## πΊ Startup Sequence
|
| 13 |
+
|
| 14 |
+
### 1. Theme Selection
|
| 15 |
+
```
|
| 16 |
+
Choose your color theme:
|
| 17 |
+
1. Pastel (Soft, muted colors)
|
| 18 |
+
2. Vibrant (High-contrast, bold colors)
|
| 19 |
+
|
| 20 |
+
Enter 1 or 2:
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
- **Pastel**: Recommended for extended use, easier on the eyes
|
| 24 |
+
- **Vibrant**: Better visibility, high contrast
|
| 25 |
+
|
| 26 |
+
**Note**: You can change this anytime during conversation with `/theme`
|
| 27 |
+
|
| 28 |
+
### 2. Splash Screen
|
| 29 |
+
```
|
| 30 |
+
βββ βββββββ βββββββββββ βββββββββ βββββ βββββ ββββββββββ
|
| 31 |
+
ββββββ βββββββββββ βββββββββββββ ββββββββββββββββ βββββ βββββββββββ
|
| 32 |
+
ββββββ βββ βββββ ββββ ββββββββ βββ ββββ ββββ ββββ β β
|
| 33 |
+
ββββββ ββββ ββββ βββββββββββ βββββββββββ ββββ ββββ βββββββ
|
| 34 |
+
ββββ ββββ ββββ ββββββββββ βββββββββββ ββββ ββββ βββββββ
|
| 35 |
+
ββββ βββββ βββ ββββ βββ ββββ ββββ ββββ ββββ β β
|
| 36 |
+
ββββ βββββββββββ βββββ βββββββββββ βββββ βββββ ββββββββββ
|
| 37 |
+
βββ βββββββ βββββ βββββββββ βββββ βββββ ββββββββββ
|
| 38 |
+
|
| 39 |
+
A Self-Centered Intelligence (SCI) Prototype
|
| 40 |
+
By ARPA HELLENIC LOGICAL SYSTEMS | Version: 0.3.79 XP | 01 JUL 2025
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
Boot sound: `system_sounds/opsiieboot.mp3` plays
|
| 44 |
+
|
| 45 |
+
### 3. Facial Recognition Authentication
|
| 46 |
+
```
|
| 47 |
+
Please look at the camera for authentication...
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
**What Happens**:
|
| 51 |
+
1. Camera activates
|
| 52 |
+
2. Face detection runs
|
| 53 |
+
3. Compares with photo in your `kun.py` profile
|
| 54 |
+
4. Emotion detection (via DeepFace)
|
| 55 |
+
5. Authentication success/failure
|
| 56 |
+
|
| 57 |
+
**Success**:
|
| 58 |
+
```
|
| 59 |
+
Welcome back [Your Name]. I was worried I'd never see you again.
|
| 60 |
+
```
|
| 61 |
+
*(One of several Master user greetings)*
|
| 62 |
+
|
| 63 |
+
**Failure**:
|
| 64 |
+
```
|
| 65 |
+
Authentication failed. Access denied.
|
| 66 |
+
```
|
| 67 |
+
*System exits*
|
| 68 |
+
|
| 69 |
+
### 4. System Initialization
|
| 70 |
+
OPSIIE loads:
|
| 71 |
+
- β PostgreSQL database connection
|
| 72 |
+
- β ChromaDB vector database
|
| 73 |
+
- β Ollama language model (llama3)
|
| 74 |
+
- β MusicGen model (if available)
|
| 75 |
+
- β BLIP vision model (for image analysis)
|
| 76 |
+
- β Facial recognition system
|
| 77 |
+
- β Voice synthesis (ElevenLabs)
|
| 78 |
+
- β Speech recognition
|
| 79 |
+
- β Theme colors
|
| 80 |
+
- β Soul Signature from your profile
|
| 81 |
+
|
| 82 |
+
### 5. Interactive Interface
|
| 83 |
+
```
|
| 84 |
+
[Your Name] >>
|
| 85 |
+
```
|
| 86 |
+
|
| 87 |
+
OPSIIE is now ready for interaction!
|
| 88 |
+
|
| 89 |
+
## π¬ First Interaction
|
| 90 |
+
|
| 91 |
+
### Test Basic Conversation
|
| 92 |
+
```
|
| 93 |
+
[Your Name] >> Hello OPSIIE
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
OPSIIE responds based on your Soul Signature and conversation history.
|
| 97 |
+
|
| 98 |
+
### Try a Command
|
| 99 |
+
```
|
| 100 |
+
[Your Name] >> /help
|
| 101 |
+
```
|
| 102 |
+
|
| 103 |
+
Displays the help menu with all available commands.
|
| 104 |
+
|
| 105 |
+
## π― Essential First Commands
|
| 106 |
+
|
| 107 |
+
### 1. Check System Status
|
| 108 |
+
```bash
|
| 109 |
+
/status
|
| 110 |
+
```
|
| 111 |
+
Shows:
|
| 112 |
+
- Database connection status
|
| 113 |
+
- AI model status
|
| 114 |
+
- Voice system status
|
| 115 |
+
- Memory usage
|
| 116 |
+
- Uptime
|
| 117 |
+
|
| 118 |
+
### 2. View Available Commands
|
| 119 |
+
```bash
|
| 120 |
+
/help
|
| 121 |
+
```
|
| 122 |
+
Categories shown:
|
| 123 |
+
- Mnemonic Matrix Commands (/recall, /forget, /memorize)
|
| 124 |
+
- Agentic Matrix Commands (/ask, /markets, /read, etc.)
|
| 125 |
+
- Web3 Commands (/0x buy, /0x sell, etc.)
|
| 126 |
+
- System Commands (/mail, /theme, /soulsig, etc.)
|
| 127 |
+
|
| 128 |
+
### 3. Test Voice Mode
|
| 129 |
+
```bash
|
| 130 |
+
/voice
|
| 131 |
+
```
|
| 132 |
+
- Activates full voice interaction
|
| 133 |
+
- Speak your commands
|
| 134 |
+
- Say "voice off" to deactivate
|
| 135 |
+
|
| 136 |
+
### 4. Test Memory System
|
| 137 |
+
```bash
|
| 138 |
+
/memorize This is my first interaction with OPSIIE
|
| 139 |
+
```
|
| 140 |
+
Then retrieve it:
|
| 141 |
+
```bash
|
| 142 |
+
/recall first interaction
|
| 143 |
+
```
|
| 144 |
+
|
| 145 |
+
### 5. Test AI Generation
|
| 146 |
+
```bash
|
| 147 |
+
/imagine a futuristic city at sunset
|
| 148 |
+
```
|
| 149 |
+
Generates and displays an image.
|
| 150 |
+
|
| 151 |
+
## π§ͺ Testing Core Features
|
| 152 |
+
|
| 153 |
+
### Memory & Recall
|
| 154 |
+
```bash
|
| 155 |
+
# Store information
|
| 156 |
+
/memorize I work on AI research at MIT
|
| 157 |
+
|
| 158 |
+
# Retrieve it
|
| 159 |
+
/recall MIT
|
| 160 |
+
|
| 161 |
+
# Forget last interaction
|
| 162 |
+
/forget
|
| 163 |
+
```
|
| 164 |
+
|
| 165 |
+
### AI Agents
|
| 166 |
+
```bash
|
| 167 |
+
# Ask Nyx (OpenAI)
|
| 168 |
+
/ask Nyx What are the latest developments in quantum computing?
|
| 169 |
+
|
| 170 |
+
# Ask G1 Black (Google)
|
| 171 |
+
/ask G1 Analyze the potential of neuromorphic computing
|
| 172 |
+
|
| 173 |
+
# Start live conversation with G1
|
| 174 |
+
/ask g1 live
|
| 175 |
+
```
|
| 176 |
+
|
| 177 |
+
### File Analysis
|
| 178 |
+
```bash
|
| 179 |
+
# Read a file
|
| 180 |
+
/read "C:\Documents\report.pdf"
|
| 181 |
+
|
| 182 |
+
# Ask questions about it
|
| 183 |
+
What are the main conclusions?
|
| 184 |
+
|
| 185 |
+
# Close file context
|
| 186 |
+
/close
|
| 187 |
+
```
|
| 188 |
+
|
| 189 |
+
### Email
|
| 190 |
+
```bash
|
| 191 |
+
# Send email
|
| 192 |
+
/mail john@example.com subject "Hello" content "This is a test from OPSIIE"
|
| 193 |
+
|
| 194 |
+
# Check inbox
|
| 195 |
+
/mail inbox
|
| 196 |
+
```
|
| 197 |
+
|
| 198 |
+
### Web3 (R-Grade only)
|
| 199 |
+
```bash
|
| 200 |
+
# View wallet addresses
|
| 201 |
+
/0x receive
|
| 202 |
+
|
| 203 |
+
# Set gas strategy
|
| 204 |
+
/0x gas medium
|
| 205 |
+
|
| 206 |
+
# Buy tokens
|
| 207 |
+
/0x buy 10 degen using eth on base
|
| 208 |
+
```
|
| 209 |
+
|
| 210 |
+
### Markets (R-Grade only)
|
| 211 |
+
```bash
|
| 212 |
+
# Get stock data
|
| 213 |
+
/markets tesla
|
| 214 |
+
|
| 215 |
+
# Get crypto data
|
| 216 |
+
/markets btc
|
| 217 |
+
|
| 218 |
+
# Compare stocks
|
| 219 |
+
/markets compare tsla nio
|
| 220 |
+
```
|
| 221 |
+
|
| 222 |
+
### DNA Analysis (R-Grade only)
|
| 223 |
+
```bash
|
| 224 |
+
# Analyze DNA sequence
|
| 225 |
+
/dna ATGCGTAACGGCATTAGC
|
| 226 |
+
|
| 227 |
+
# Detailed analysis
|
| 228 |
+
/dna --verbose ATGCGTAACGGCATTAGC
|
| 229 |
+
```
|
| 230 |
+
|
| 231 |
+
### Collaboration Rooms
|
| 232 |
+
```bash
|
| 233 |
+
# Create room with agents
|
| 234 |
+
/room nyx, g1: Discuss quantum computing applications
|
| 235 |
+
|
| 236 |
+
# Interact in room
|
| 237 |
+
What do you think about quantum error correction?
|
| 238 |
+
|
| 239 |
+
# Close room
|
| 240 |
+
/close
|
| 241 |
+
```
|
| 242 |
+
|
| 243 |
+
## π¨ Customization
|
| 244 |
+
|
| 245 |
+
### Change Theme
|
| 246 |
+
```bash
|
| 247 |
+
/theme
|
| 248 |
+
```
|
| 249 |
+
Or use voice command: "theme"
|
| 250 |
+
|
| 251 |
+
### Manage Soul Signature
|
| 252 |
+
```bash
|
| 253 |
+
# View current Soul Signature
|
| 254 |
+
/soulsig
|
| 255 |
+
|
| 256 |
+
# Add to Soul Signature
|
| 257 |
+
/soulsig I prefer technical explanations with code examples
|
| 258 |
+
|
| 259 |
+
# Wipe Soul Signature (β οΈ permanent)
|
| 260 |
+
/soulsig wipe
|
| 261 |
+
|
| 262 |
+
# Restore Soul Signature (if recently wiped)
|
| 263 |
+
/soulsig heal
|
| 264 |
+
```
|
| 265 |
+
|
| 266 |
+
### Adjust Web Limit
|
| 267 |
+
```bash
|
| 268 |
+
# Set web content extraction limit
|
| 269 |
+
/weblimit 2000
|
| 270 |
+
```
|
| 271 |
+
|
| 272 |
+
## π Understanding OPSIIE's Responses
|
| 273 |
+
|
| 274 |
+
### Natural Conversation
|
| 275 |
+
OPSIIE avoids template responses. Instead of:
|
| 276 |
+
> "That's an easy question! Let me help you with that."
|
| 277 |
+
|
| 278 |
+
You get personality-driven responses like:
|
| 279 |
+
> "Hmm, interesting question. I've been thinking about this lately..."
|
| 280 |
+
|
| 281 |
+
### Memory Integration
|
| 282 |
+
OPSIIE references past conversations:
|
| 283 |
+
> "Remember when we discussed quantum computing last week? This relates to that..."
|
| 284 |
+
|
| 285 |
+
### Emotional Intelligence
|
| 286 |
+
Based on your Soul Signature and interaction history:
|
| 287 |
+
- Adapts tone and style
|
| 288 |
+
- Remembers preferences
|
| 289 |
+
- Builds on previous conversations
|
| 290 |
+
- Shows personality traits (tsundere, sarcastic, direct)
|
| 291 |
+
|
| 292 |
+
## π¨ Common First-Run Issues
|
| 293 |
+
|
| 294 |
+
### Camera Not Detected
|
| 295 |
+
```
|
| 296 |
+
Error: No camera found for facial recognition
|
| 297 |
+
```
|
| 298 |
+
**Solution**:
|
| 299 |
+
- Check camera connection
|
| 300 |
+
- Verify camera permissions in Windows
|
| 301 |
+
- Ensure camera is not in use by another application
|
| 302 |
+
|
| 303 |
+
### Face Not Recognized
|
| 304 |
+
```
|
| 305 |
+
Authentication failed
|
| 306 |
+
```
|
| 307 |
+
**Solution**:
|
| 308 |
+
- Ensure good lighting
|
| 309 |
+
- Face camera directly
|
| 310 |
+
- Check photo path in kun.py is correct
|
| 311 |
+
- Photo should be clear and recent
|
| 312 |
+
|
| 313 |
+
### Database Connection Error
|
| 314 |
+
```
|
| 315 |
+
Error connecting to PostgreSQL database
|
| 316 |
+
```
|
| 317 |
+
**Solution**:
|
| 318 |
+
- Verify PostgreSQL is running
|
| 319 |
+
- Check DB credentials in .env
|
| 320 |
+
- Ensure database 'mnemonic_computer' exists
|
| 321 |
+
|
| 322 |
+
### Missing API Keys
|
| 323 |
+
```
|
| 324 |
+
Error: OPENAI_API_KEY not found
|
| 325 |
+
```
|
| 326 |
+
**Solution**:
|
| 327 |
+
- Verify .env file exists
|
| 328 |
+
- Check all required API keys are set
|
| 329 |
+
- Restart terminal after adding keys
|
| 330 |
+
|
| 331 |
+
### Ollama Not Running
|
| 332 |
+
```
|
| 333 |
+
Error: Failed to connect to Ollama
|
| 334 |
+
```
|
| 335 |
+
**Solution**:
|
| 336 |
+
- Start Ollama service
|
| 337 |
+
- Verify llama3 model is installed: `ollama pull llama3`
|
| 338 |
+
- Check Ollama is running: `ollama list`
|
| 339 |
+
|
| 340 |
+
### Voice Synthesis Error
|
| 341 |
+
```
|
| 342 |
+
Error with Eleven Labs API
|
| 343 |
+
```
|
| 344 |
+
**Solution**:
|
| 345 |
+
- Verify ELEVENLABS_API_KEY is valid
|
| 346 |
+
- Check VOICE_ID is correct
|
| 347 |
+
- Verify internet connection
|
| 348 |
+
- Check API usage limits
|
| 349 |
+
|
| 350 |
+
## π Access Levels
|
| 351 |
+
|
| 352 |
+
### R-Grade (Master Access)
|
| 353 |
+
Full access to all features:
|
| 354 |
+
- All commands available
|
| 355 |
+
- Web3 operations (/0x)
|
| 356 |
+
- Market data (/markets)
|
| 357 |
+
- DNA analysis (/dna)
|
| 358 |
+
- Advanced AI agents
|
| 359 |
+
- All experimental features
|
| 360 |
+
|
| 361 |
+
### A-Grade (Standard Access)
|
| 362 |
+
Limited access:
|
| 363 |
+
- Basic conversation
|
| 364 |
+
- Voice features
|
| 365 |
+
- File reading
|
| 366 |
+
- Email
|
| 367 |
+
- Basic AI generation
|
| 368 |
+
- No /0x, /markets, /dna commands
|
| 369 |
+
|
| 370 |
+
**Check your access level**: Look at `arpa_id` in your kun.py profile
|
| 371 |
+
- `R###` = Master Access
|
| 372 |
+
- `A###` = Standard Access
|
| 373 |
+
|
| 374 |
+
## π― Next Steps
|
| 375 |
+
|
| 376 |
+
After successful first run:
|
| 377 |
+
|
| 378 |
+
1. **Explore Commands**
|
| 379 |
+
- Try each command category
|
| 380 |
+
- Experiment with different features
|
| 381 |
+
- Read [Basic Commands Guide](../user-guides/basic-commands.md)
|
| 382 |
+
|
| 383 |
+
2. **Customize Your Experience**
|
| 384 |
+
- Build your Soul Signature
|
| 385 |
+
- Set preferred theme
|
| 386 |
+
- Configure voice settings
|
| 387 |
+
- Add email contacts
|
| 388 |
+
|
| 389 |
+
3. **Learn Advanced Features**
|
| 390 |
+
- [Agentic Network](../advanced-features/agentic-network.md)
|
| 391 |
+
- [DNA Analysis](../advanced-features/dna-analysis.md)
|
| 392 |
+
- [Web3 & Blockchain](../advanced-features/web3-blockchain.md)
|
| 393 |
+
- [Financial Intelligence](../advanced-features/financial-intelligence.md)
|
| 394 |
+
|
| 395 |
+
4. **Read Documentation**
|
| 396 |
+
- [Memory Management](../user-guides/memory-management.md)
|
| 397 |
+
- [Command Reference](../api-reference/command-reference.md)
|
| 398 |
+
- [System Architecture](../system-architecture/core-components.md)
|
| 399 |
+
|
| 400 |
+
## π‘ Tips for Best Experience
|
| 401 |
+
|
| 402 |
+
1. **Build Your Soul Signature** - The more OPSIIE knows about you, the better the interactions
|
| 403 |
+
2. **Use Memory System** - Store important information with /memorize
|
| 404 |
+
3. **Try Voice Mode** - Natural conversation feels more engaging
|
| 405 |
+
4. **Experiment with Rooms** - Collaborate with multiple AI agents
|
| 406 |
+
5. **Keep Conversations Going** - OPSIIE remembers context and builds on it
|
| 407 |
+
6. **Provide Feedback** - Use /forget if responses aren't accurate
|
| 408 |
+
|
| 409 |
+
## π Getting Help
|
| 410 |
+
|
| 411 |
+
- Type `/help` for command list
|
| 412 |
+
- Type `/help <command>` for specific command help
|
| 413 |
+
- Check [Command Reference](../api-reference/command-reference.md)
|
| 414 |
+
- Contact: opsiebyarpa@gmail.com
|
| 415 |
+
|
| 416 |
+
---
|
| 417 |
+
|
| 418 |
+
**Welcome to OPSIIE!** Your journey with a Self-Centered Intelligence begins now. π
|
documentation/getting-started/installation.md
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Installation Guide
|
| 2 |
+
|
| 3 |
+
Complete guide for installing and setting up OPSIIE 0.3.79 XP on your system.
|
| 4 |
+
|
| 5 |
+
## π Prerequisites
|
| 6 |
+
|
| 7 |
+
### System Requirements
|
| 8 |
+
- **Operating System**: Windows 10/11 (primary platform)
|
| 9 |
+
- **Python**: 3.8 or higher
|
| 10 |
+
- **Database**: PostgreSQL (latest version recommended)
|
| 11 |
+
- **Hardware**:
|
| 12 |
+
- Camera (for facial recognition authentication)
|
| 13 |
+
- Microphone (for voice interaction)
|
| 14 |
+
- GPU with CUDA support (recommended for AI generation)
|
| 15 |
+
|
| 16 |
+
### Required Accounts & API Keys
|
| 17 |
+
- **ElevenLabs** - Voice synthesis (ELEVENLABS_API_KEY, VOICE_ID)
|
| 18 |
+
- **Google AI** - G1 Black agent (GOOGLE_API_KEY, G1_VOICE_LIVE)
|
| 19 |
+
- **OpenAI** - Nyx agent (OPENAI_API_KEY, ORG_ID, NYX_ASSISTANT_ID)
|
| 20 |
+
- **Email** - Gmail account for email features (SENDER_EMAIL, SENDER_PASSWORD)
|
| 21 |
+
- **Web3** - Ethereum private key for blockchain features (AGENT_PRIVATE_KEY)
|
| 22 |
+
- **NCBI** - For DNA analysis (NCBI_EMAIL)
|
| 23 |
+
|
| 24 |
+
## π¦ Installation Steps
|
| 25 |
+
|
| 26 |
+
### 1. Clone the Repository
|
| 27 |
+
```bash
|
| 28 |
+
git clone <repository-url>
|
| 29 |
+
cd OPSIIE_0_3_79_XP_Pastel_BU
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
### 2. Install Python Dependencies
|
| 33 |
+
```bash
|
| 34 |
+
pip install -r requirements.txt
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
The requirements.txt includes:
|
| 38 |
+
- **AI/ML**: torch, transformers, diffusers, accelerate, ollama
|
| 39 |
+
- **Audio**: librosa, torchaudio, pyaudio, speech-recognition, pyttsx3
|
| 40 |
+
- **Vision**: opencv-python, face-recognition, deepface, Pillow
|
| 41 |
+
- **Web3**: web3, requests
|
| 42 |
+
- **Data**: pandas, numpy, scipy, yfinance, statsmodels
|
| 43 |
+
- **Database**: psycopg[binary], chromadb
|
| 44 |
+
- **Documents**: PyPDF2, pdfplumber, python-docx
|
| 45 |
+
- **Web**: beautifulsoup4, lxml, aiohttp, websockets
|
| 46 |
+
- **Bioinformatics**: biopython, matplotlib, prettytable, viennarna
|
| 47 |
+
- **Email**: imaplib2
|
| 48 |
+
- **Utilities**: python-dotenv, colorama, tqdm, pygame
|
| 49 |
+
|
| 50 |
+
### 3. Set Up PostgreSQL Database
|
| 51 |
+
```sql
|
| 52 |
+
-- Create the main database
|
| 53 |
+
CREATE DATABASE mnemonic_computer;
|
| 54 |
+
|
| 55 |
+
-- Connect to the database and create the conversations table
|
| 56 |
+
\c mnemonic_computer
|
| 57 |
+
|
| 58 |
+
CREATE TABLE conversations (
|
| 59 |
+
id SERIAL PRIMARY KEY,
|
| 60 |
+
timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
| 61 |
+
prompt TEXT NOT NULL,
|
| 62 |
+
response TEXT NOT NULL
|
| 63 |
+
);
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
### 4. Install Ollama
|
| 67 |
+
OPSIIE uses Ollama for local AI processing with the Llama3 model.
|
| 68 |
+
|
| 69 |
+
1. Download and install Ollama from https://ollama.ai
|
| 70 |
+
2. Pull the Llama3 model:
|
| 71 |
+
```bash
|
| 72 |
+
ollama pull llama3
|
| 73 |
+
```
|
| 74 |
+
|
| 75 |
+
### 5. Configure Environment Variables
|
| 76 |
+
Create a `.env` file in the project root with the following:
|
| 77 |
+
|
| 78 |
+
```env
|
| 79 |
+
# Database Configuration
|
| 80 |
+
DB_NAME=mnemonic_computer
|
| 81 |
+
DB_USER=your_postgres_username
|
| 82 |
+
DB_PASSWORD=your_postgres_password
|
| 83 |
+
DB_HOST=localhost
|
| 84 |
+
DB_PORT=5432
|
| 85 |
+
|
| 86 |
+
# AI Model APIs
|
| 87 |
+
OPENAI_API_KEY=your_openai_key
|
| 88 |
+
ORG_ID=your_openai_org_id
|
| 89 |
+
GOOGLE_API_KEY=your_google_api_key
|
| 90 |
+
ELEVENLABS_API_KEY=your_elevenlabs_key
|
| 91 |
+
|
| 92 |
+
# Agent IDs
|
| 93 |
+
NYX_ASSISTANT_ID=your_nyx_assistant_id
|
| 94 |
+
G1_VOICE_LIVE=your_g1_voice_agent_id
|
| 95 |
+
KRONOS_LIVE=your_kronos_agent_id
|
| 96 |
+
|
| 97 |
+
# Voice Configuration
|
| 98 |
+
VOICE_ID=your_elevenlabs_voice_id
|
| 99 |
+
NYX_VOICE_ID=your_nyx_voice_id
|
| 100 |
+
G1_VOICE_ID=your_g1_voice_id
|
| 101 |
+
|
| 102 |
+
# Web3 Configuration
|
| 103 |
+
AGENT_PRIVATE_KEY=your_ethereum_private_key
|
| 104 |
+
BASE_RPC_URL=your_base_rpc_url
|
| 105 |
+
ETHEREUM_RPC_URL=your_ethereum_rpc_url
|
| 106 |
+
POLYGON_RPC_URL=your_polygon_rpc_url
|
| 107 |
+
|
| 108 |
+
# Email Configuration
|
| 109 |
+
SENDER_EMAIL=your_gmail_address
|
| 110 |
+
SENDER_PASSWORD=your_gmail_app_password
|
| 111 |
+
|
| 112 |
+
# Scientific APIs
|
| 113 |
+
NCBI_EMAIL=your_email_for_ncbi
|
| 114 |
+
```
|
| 115 |
+
|
| 116 |
+
### 6. Configure User Profile
|
| 117 |
+
Copy `kun.example.py` to `kun.py` and configure your user profile:
|
| 118 |
+
|
| 119 |
+
```python
|
| 120 |
+
users = {
|
| 121 |
+
'YourName': {
|
| 122 |
+
'full_name': 'Your Full Name',
|
| 123 |
+
'call_name': 'Your Preferred Name',
|
| 124 |
+
'arpa_id': 'R001', # R-Grade for Master access, A### for Standard
|
| 125 |
+
'public0x': 'your_ethereum_wallet_address',
|
| 126 |
+
'db_params': {
|
| 127 |
+
'dbname': 'mnemonic_computer',
|
| 128 |
+
'user': 'your_postgres_username',
|
| 129 |
+
'password': 'your_postgres_password',
|
| 130 |
+
'host': 'localhost',
|
| 131 |
+
'port': '5432'
|
| 132 |
+
},
|
| 133 |
+
'picture': r'C:\path\to\your\photo.jpg',
|
| 134 |
+
'mail': 'your_email@example.com',
|
| 135 |
+
'soul_sig': [
|
| 136 |
+
"Your personalized preferences here",
|
| 137 |
+
"Communication style preferences",
|
| 138 |
+
# Add more lines as needed
|
| 139 |
+
],
|
| 140 |
+
}
|
| 141 |
+
}
|
| 142 |
+
```
|
| 143 |
+
|
| 144 |
+
**Important**:
|
| 145 |
+
- `arpa_id` starting with 'R' (e.g., R001) grants Master (R-Grade) access to all features
|
| 146 |
+
- `arpa_id` starting with 'A' (e.g., A001) grants Standard (A-Grade) access with limited features
|
| 147 |
+
- The `picture` field should point to a photo for facial recognition
|
| 148 |
+
- The `soul_sig` (Soul Signature) is a personalized system prompt that defines how OPSIIE interacts with you
|
| 149 |
+
|
| 150 |
+
### 7. Create Output Directories
|
| 151 |
+
The system will create these automatically on first run, but you can create them manually:
|
| 152 |
+
```bash
|
| 153 |
+
mkdir -p outputs/images
|
| 154 |
+
mkdir -p outputs/music
|
| 155 |
+
mkdir -p outputs/videos
|
| 156 |
+
mkdir -p outputs/rooms
|
| 157 |
+
```
|
| 158 |
+
|
| 159 |
+
## π§ͺ Verify Installation
|
| 160 |
+
|
| 161 |
+
### Test Database Connection
|
| 162 |
+
```bash
|
| 163 |
+
psql -h localhost -U your_username -d mnemonic_computer -c "SELECT 1;"
|
| 164 |
+
```
|
| 165 |
+
|
| 166 |
+
### Test Ollama
|
| 167 |
+
```bash
|
| 168 |
+
ollama run llama3 "Hello, world!"
|
| 169 |
+
```
|
| 170 |
+
|
| 171 |
+
### Test Python Environment
|
| 172 |
+
```bash
|
| 173 |
+
python -c "import torch, transformers, chromadb, psycopg; print('All packages imported successfully')"
|
| 174 |
+
```
|
| 175 |
+
|
| 176 |
+
## β οΈ Common Issues
|
| 177 |
+
|
| 178 |
+
### Database Connection Errors
|
| 179 |
+
- Verify PostgreSQL is running
|
| 180 |
+
- Check DB_USER and DB_PASSWORD in .env
|
| 181 |
+
- Ensure the database 'mnemonic_computer' exists
|
| 182 |
+
- Verify pg_hba.conf allows local connections
|
| 183 |
+
|
| 184 |
+
### Missing Python Packages
|
| 185 |
+
- Ensure you're using Python 3.8+
|
| 186 |
+
- Some packages may require system dependencies (e.g., portaudio for pyaudio)
|
| 187 |
+
- On Windows, some packages may need Visual C++ Build Tools
|
| 188 |
+
|
| 189 |
+
### Face Recognition Issues
|
| 190 |
+
- Ensure your camera is connected and accessible
|
| 191 |
+
- Check camera permissions in Windows settings
|
| 192 |
+
- Verify your photo in kun.py is clear and properly lit
|
| 193 |
+
|
| 194 |
+
### CUDA/GPU Issues
|
| 195 |
+
- Verify CUDA is installed if using GPU acceleration
|
| 196 |
+
- Check torch.cuda.is_available() returns True
|
| 197 |
+
- Some models will fall back to CPU if GPU unavailable
|
| 198 |
+
|
| 199 |
+
### API Key Issues
|
| 200 |
+
- Verify all API keys are valid and not expired
|
| 201 |
+
- Check API usage limits haven't been exceeded
|
| 202 |
+
- Ensure API keys have proper permissions
|
| 203 |
+
|
| 204 |
+
## π Next Steps
|
| 205 |
+
|
| 206 |
+
After successful installation:
|
| 207 |
+
1. Read the [Configuration Guide](configuration.md)
|
| 208 |
+
2. Follow the [First Run Guide](first-run.md)
|
| 209 |
+
3. Explore [Quick Start Guide](../user-guides/quick-start.md)
|
| 210 |
+
|
| 211 |
+
## π Support
|
| 212 |
+
|
| 213 |
+
If you encounter issues:
|
| 214 |
+
- Check the error logs
|
| 215 |
+
- Verify all prerequisites are met
|
| 216 |
+
- Review the troubleshooting section in README.md
|
| 217 |
+
- Contact: opsiebyarpa@gmail.com
|
documentation/system-architecture/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# System Architecture
|
| 2 |
+
|
| 3 |
+
Technical architecture for OPSIIE.
|
| 4 |
+
|
| 5 |
+
## π Documents
|
| 6 |
+
|
| 7 |
+
### [Core Components](core-components.md)
|
| 8 |
+
System architecture, AI agents, memory, integrations
|
| 9 |
+
|
| 10 |
+
### [Security Model](security-model.md)
|
| 11 |
+
Authentication, access control, secret management
|
| 12 |
+
|
| 13 |
+
### [Technology Stack](technology-stack.md)
|
| 14 |
+
Complete tech stack and dependencies
|
| 15 |
+
|
| 16 |
+
## ποΈ Architecture
|
| 17 |
+
|
| 18 |
+
```
|
| 19 |
+
UI Layer: Terminal, Voice, Auth
|
| 20 |
+
β
|
| 21 |
+
AI Layer: OPSIIE, Nyx, G1, Kronos
|
| 22 |
+
β
|
| 23 |
+
Memory Layer: PostgreSQL, ChromaDB
|
| 24 |
+
β
|
| 25 |
+
Integration Layer: Email, Web3, Markets, DNA
|
| 26 |
+
```
|
| 27 |
+
|
| 28 |
+
## π Key Tech
|
| 29 |
+
|
| 30 |
+
**AI**: Ollama, OpenAI, Gemini, ElevenLabs
|
| 31 |
+
**DB**: PostgreSQL, ChromaDB
|
| 32 |
+
**Language**: Python 3.8+
|
| 33 |
+
|
| 34 |
+
---
|
| 35 |
+
|
| 36 |
+
**Architecture documentation.** ποΈ
|
documentation/system-architecture/core-components.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Core Components
|
| 2 |
+
|
| 3 |
+
OPSIIE's system architecture.
|
| 4 |
+
|
| 5 |
+
## ποΈ Architecture
|
| 6 |
+
|
| 7 |
+
**Interface**: Terminal UI, Voice I/O, Facial auth
|
| 8 |
+
**AI Core**: Ollama Llama3, Nyx, G1, Kronos
|
| 9 |
+
**Memory**: PostgreSQL, ChromaDB, Soul Signature
|
| 10 |
+
**Integration**: Email, Web3, Markets, DNA, Files
|
| 11 |
+
|
| 12 |
+
## π§ AI Agents
|
| 13 |
+
|
| 14 |
+
**OPSIIE**: Ollama Llama3 (coordinator)
|
| 15 |
+
**Nyx**: OpenAI GPT-3.5 (blockchain, Python)
|
| 16 |
+
**G1 Black**: Gemini 1.5 Flash (quantum, technical)
|
| 17 |
+
**Kronos**: ElevenLabs (Greek auditing)
|
| 18 |
+
|
| 19 |
+
## πΎ Memory
|
| 20 |
+
|
| 21 |
+
**PostgreSQL**: conversations table
|
| 22 |
+
**ChromaDB**: Vector search, embeddings
|
| 23 |
+
**Soul Signature**: kun.py (highest priority)
|
| 24 |
+
|
| 25 |
+
## π¨ Generation
|
| 26 |
+
|
| 27 |
+
**Images**: Hugging Face (hakurei/waifu-diffusion)
|
| 28 |
+
**Videos**: Replicate (zeroscope v2 XL)
|
| 29 |
+
**Music**: MusicGen large
|
| 30 |
+
|
| 31 |
+
## π Integrations
|
| 32 |
+
|
| 33 |
+
**Email**: Gmail SMTP/IMAP
|
| 34 |
+
**Web3**: Base, Ethereum, Polygon
|
| 35 |
+
**Markets**: Yahoo Finance
|
| 36 |
+
**DNA**: NCBI, BLAST, UniProt
|
| 37 |
+
**Files**: PDF, CSV, DOCX, TXT, XLSX
|
| 38 |
+
|
| 39 |
+
## π Data Flow
|
| 40 |
+
|
| 41 |
+
Input β Parser β Service β API/Model β Response β Memory β Output
|
| 42 |
+
|
| 43 |
+
---
|
| 44 |
+
|
| 45 |
+
**System architecture.** ποΈ
|
documentation/system-architecture/security-model.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Security Model
|
| 2 |
+
|
| 3 |
+
OPSIIE security architecture.
|
| 4 |
+
|
| 5 |
+
## π Authentication
|
| 6 |
+
|
| 7 |
+
**Facial Recognition**: OpenCV, MSE matching
|
| 8 |
+
**Threshold**: 1000 (configurable)
|
| 9 |
+
**Photo**: kun.py user['picture']
|
| 10 |
+
|
| 11 |
+
## π Access Control
|
| 12 |
+
|
| 13 |
+
**R-Grade**: ARPA ID R### (full access)
|
| 14 |
+
**A-Grade**: ARPA ID A### (core only)
|
| 15 |
+
|
| 16 |
+
## π Secret Management
|
| 17 |
+
|
| 18 |
+
**.env**: API keys, DB credentials, private keys
|
| 19 |
+
**kun.py**: User profiles, public data only
|
| 20 |
+
|
| 21 |
+
**Best Practices**:
|
| 22 |
+
- Use .env.example template
|
| 23 |
+
- Rotate keys quarterly
|
| 24 |
+
- Gmail: App password (not account password)
|
| 25 |
+
- Never commit .env
|
| 26 |
+
|
| 27 |
+
## π Network Security
|
| 28 |
+
|
| 29 |
+
**Web3**: Private key protected, checksum addresses
|
| 30 |
+
**APIs**: HTTPS only, keys in headers
|
| 31 |
+
**Email**: App password, 2FA required
|
| 32 |
+
|
| 33 |
+
## πΎ Data Security
|
| 34 |
+
|
| 35 |
+
**PostgreSQL**: Password protected, local only
|
| 36 |
+
**Files**: Local access only, no uploads
|
| 37 |
+
**Privacy**: No telemetry, local system only
|
| 38 |
+
|
| 39 |
+
## π‘οΈ Security Checklist
|
| 40 |
+
|
| 41 |
+
- [ ] .env from example, unique keys
|
| 42 |
+
- [ ] Gmail app password
|
| 43 |
+
- [ ] PostgreSQL password secured
|
| 44 |
+
- [ ] Web3 private key secured
|
| 45 |
+
- [ ] ARPA IDs verified
|
| 46 |
+
- [ ] Regular key rotation
|
| 47 |
+
|
| 48 |
+
---
|
| 49 |
+
|
| 50 |
+
**Security by design.** π‘οΈ
|
documentation/system-architecture/technology-stack.md
ADDED
|
@@ -0,0 +1,254 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Technology Stack
|
| 2 |
+
|
| 3 |
+
Complete technology stack powering OPSIIE.
|
| 4 |
+
|
| 5 |
+
## π Core Language
|
| 6 |
+
**Python 3.8+**
|
| 7 |
+
|
| 8 |
+
## π€ AI & ML
|
| 9 |
+
|
| 10 |
+
### Language Models
|
| 11 |
+
- **Ollama** - Local LLM (Llama3 8B)
|
| 12 |
+
- **OpenAI** - GPT-3.5-turbo (Nyx agent)
|
| 13 |
+
- **Google Gemini** - 1.5 Flash (G1 agent)
|
| 14 |
+
- **ElevenLabs** - Conversational AI (Kronos)
|
| 15 |
+
|
| 16 |
+
### Vision & Voice
|
| 17 |
+
- **OpenCV** - Face recognition
|
| 18 |
+
- **SpeechRecognition** - Voice input (Google)
|
| 19 |
+
- **ElevenLabs API** - Text-to-speech
|
| 20 |
+
- **PyAudio** - Audio I/O
|
| 21 |
+
|
| 22 |
+
### ML Libraries
|
| 23 |
+
- **PyTorch** - Deep learning framework
|
| 24 |
+
- **Transformers** - Hugging Face models
|
| 25 |
+
- **Sentence Transformers** - Embeddings
|
| 26 |
+
- **CUDA** - GPU acceleration (optional)
|
| 27 |
+
|
| 28 |
+
### Generation
|
| 29 |
+
- **Hugging Face** - Image generation
|
| 30 |
+
- **Replicate** - Video & music generation
|
| 31 |
+
- **AudioCraft** - Music models (MusicGen)
|
| 32 |
+
|
| 33 |
+
## πΎ Data & Storage
|
| 34 |
+
|
| 35 |
+
### Databases
|
| 36 |
+
- **PostgreSQL** - Conversation storage
|
| 37 |
+
- **ChromaDB** - Vector database
|
| 38 |
+
- **psycopg2** - PostgreSQL adapter
|
| 39 |
+
|
| 40 |
+
### Data Processing
|
| 41 |
+
- **pandas** - Data analysis
|
| 42 |
+
- **numpy** - Numerical computing
|
| 43 |
+
|
| 44 |
+
## π Document Processing
|
| 45 |
+
|
| 46 |
+
- **PyPDF2** - PDF reading
|
| 47 |
+
- **pdfplumber** - Advanced PDF extraction
|
| 48 |
+
- **python-docx** - Word documents
|
| 49 |
+
- **openpyxl** - Excel files
|
| 50 |
+
- **csv** - CSV parsing
|
| 51 |
+
|
| 52 |
+
## π Web & APIs
|
| 53 |
+
|
| 54 |
+
### HTTP
|
| 55 |
+
- **requests** - API calls
|
| 56 |
+
- **urllib** - URL handling
|
| 57 |
+
- **websockets** - Real-time communication
|
| 58 |
+
|
| 59 |
+
### Web3
|
| 60 |
+
- **web3.py** - Ethereum interaction
|
| 61 |
+
- **eth-account** - Key management
|
| 62 |
+
- **Base, Ethereum, Polygon** - Networks
|
| 63 |
+
|
| 64 |
+
### Financial
|
| 65 |
+
- **yfinance** - Yahoo Finance API
|
| 66 |
+
- **Real-time market data**
|
| 67 |
+
|
| 68 |
+
## 𧬠Bioinformatics
|
| 69 |
+
|
| 70 |
+
- **Biopython** - Sequence analysis
|
| 71 |
+
- **Bio.Blast** - Homology search
|
| 72 |
+
- **NCBI Entrez** - Database access
|
| 73 |
+
- **UniProt, Pfam** - Protein databases
|
| 74 |
+
|
| 75 |
+
## π§ Communication
|
| 76 |
+
|
| 77 |
+
- **smtplib** - Email sending
|
| 78 |
+
- **imaplib** - Email receiving
|
| 79 |
+
- **email** - Message formatting
|
| 80 |
+
- **Gmail SMTP/IMAP**
|
| 81 |
+
|
| 82 |
+
## π¨ Media
|
| 83 |
+
|
| 84 |
+
### Audio
|
| 85 |
+
- **pygame** - Audio playback
|
| 86 |
+
- **pydub** - Audio processing
|
| 87 |
+
- **soundfile** - File I/O
|
| 88 |
+
|
| 89 |
+
### Image
|
| 90 |
+
- **Pillow (PIL)** - Image processing
|
| 91 |
+
- **matplotlib** - Visualization
|
| 92 |
+
|
| 93 |
+
## π¨ UI/UX
|
| 94 |
+
|
| 95 |
+
- **terminal_colors.py** - Custom theming
|
| 96 |
+
- **ASCII art** - Splash screens
|
| 97 |
+
- **Markdown rendering** - Formatted output
|
| 98 |
+
- **Pastel/Vibrant** - Color themes
|
| 99 |
+
|
| 100 |
+
## π§ Utilities
|
| 101 |
+
|
| 102 |
+
- **python-dotenv** - Environment variables
|
| 103 |
+
- **os, sys** - System operations
|
| 104 |
+
- **pathlib** - Path handling
|
| 105 |
+
- **json, pickle** - Serialization
|
| 106 |
+
- **datetime** - Time operations
|
| 107 |
+
- **re** - Regular expressions
|
| 108 |
+
- **hashlib** - Hashing
|
| 109 |
+
|
| 110 |
+
## π¦ Package Management
|
| 111 |
+
|
| 112 |
+
**requirements.txt**:
|
| 113 |
+
```
|
| 114 |
+
openai
|
| 115 |
+
google-generativeai
|
| 116 |
+
elevenlabs
|
| 117 |
+
psycopg2-binary
|
| 118 |
+
chromadb
|
| 119 |
+
sentence-transformers
|
| 120 |
+
opencv-python
|
| 121 |
+
SpeechRecognition
|
| 122 |
+
pyaudio
|
| 123 |
+
pygame
|
| 124 |
+
pydub
|
| 125 |
+
torch
|
| 126 |
+
transformers
|
| 127 |
+
biopython
|
| 128 |
+
web3
|
| 129 |
+
eth-account
|
| 130 |
+
yfinance
|
| 131 |
+
requests
|
| 132 |
+
pandas
|
| 133 |
+
openpyxl
|
| 134 |
+
PyPDF2
|
| 135 |
+
pdfplumber
|
| 136 |
+
python-docx
|
| 137 |
+
python-dotenv
|
| 138 |
+
replicate
|
| 139 |
+
pillow
|
| 140 |
+
```
|
| 141 |
+
|
| 142 |
+
## ποΈ Architecture Patterns
|
| 143 |
+
|
| 144 |
+
**MVC-like**:
|
| 145 |
+
- Models: Data classes, API interfaces
|
| 146 |
+
- Views: Terminal output, formatting
|
| 147 |
+
- Controllers: Command parsers, handlers
|
| 148 |
+
|
| 149 |
+
**Service Layer**:
|
| 150 |
+
- Memory service (PostgreSQL + ChromaDB)
|
| 151 |
+
- Agent service (Nyx, G1, Kronos)
|
| 152 |
+
- Generation service (Images, videos, music)
|
| 153 |
+
- Web3 service (Blockchain operations)
|
| 154 |
+
|
| 155 |
+
**Repository Pattern**:
|
| 156 |
+
- Database interactions abstracted
|
| 157 |
+
- Consistent interface for data access
|
| 158 |
+
|
| 159 |
+
## π Performance
|
| 160 |
+
|
| 161 |
+
**Optimizations**:
|
| 162 |
+
- Async operations (where possible)
|
| 163 |
+
- Connection pooling (database)
|
| 164 |
+
- Caching (model outputs)
|
| 165 |
+
- Batch processing (embeddings)
|
| 166 |
+
|
| 167 |
+
**Scalability**:
|
| 168 |
+
- Stateless agent calls
|
| 169 |
+
- Modular architecture
|
| 170 |
+
- Configurable limits
|
| 171 |
+
- Resource-aware processing
|
| 172 |
+
|
| 173 |
+
## π Integration Flow
|
| 174 |
+
|
| 175 |
+
```
|
| 176 |
+
User Input
|
| 177 |
+
β
|
| 178 |
+
Terminal/Voice
|
| 179 |
+
β
|
| 180 |
+
Command Parser
|
| 181 |
+
β
|
| 182 |
+
Service Layer
|
| 183 |
+
β
|
| 184 |
+
APIs/Models/Database
|
| 185 |
+
β
|
| 186 |
+
Response Processing
|
| 187 |
+
β
|
| 188 |
+
Memory Storage
|
| 189 |
+
β
|
| 190 |
+
Output Formatting
|
| 191 |
+
β
|
| 192 |
+
Terminal/Voice Output
|
| 193 |
+
```
|
| 194 |
+
|
| 195 |
+
## π Data Pipeline
|
| 196 |
+
|
| 197 |
+
**Memory Pipeline**:
|
| 198 |
+
```
|
| 199 |
+
Conversation β PostgreSQL
|
| 200 |
+
Conversation β Embeddings β ChromaDB
|
| 201 |
+
Query β Vector Search β Relevant Context
|
| 202 |
+
```
|
| 203 |
+
|
| 204 |
+
**Generation Pipeline**:
|
| 205 |
+
```
|
| 206 |
+
Prompt β Model API β Generation β Storage β Display
|
| 207 |
+
```
|
| 208 |
+
|
| 209 |
+
**Agent Pipeline**:
|
| 210 |
+
```
|
| 211 |
+
Query β Agent API β Response β Evaluation β Selection β Display
|
| 212 |
+
```
|
| 213 |
+
|
| 214 |
+
## π Security Stack
|
| 215 |
+
|
| 216 |
+
- **OpenCV** - Facial authentication
|
| 217 |
+
- **dotenv** - Secret management
|
| 218 |
+
- **HTTPS** - All API calls
|
| 219 |
+
- **Web3** - Checksum addresses
|
| 220 |
+
- **psycopg2** - Parameterized queries
|
| 221 |
+
|
| 222 |
+
## π External Services
|
| 223 |
+
|
| 224 |
+
**Required**:
|
| 225 |
+
- ElevenLabs API
|
| 226 |
+
- Google AI API (Gemini)
|
| 227 |
+
- OpenAI API
|
| 228 |
+
|
| 229 |
+
**Optional (R-Grade)**:
|
| 230 |
+
- Hugging Face Inference
|
| 231 |
+
- Replicate API
|
| 232 |
+
- Yahoo Finance
|
| 233 |
+
- NCBI (Entrez, BLAST)
|
| 234 |
+
- Blockchain RPC nodes
|
| 235 |
+
|
| 236 |
+
## π₯οΈ System Requirements
|
| 237 |
+
|
| 238 |
+
**Minimum**:
|
| 239 |
+
- Python 3.8+
|
| 240 |
+
- 8GB RAM
|
| 241 |
+
- PostgreSQL
|
| 242 |
+
- Camera + Microphone
|
| 243 |
+
- Internet connection
|
| 244 |
+
|
| 245 |
+
**Recommended**:
|
| 246 |
+
- Python 3.10+
|
| 247 |
+
- 16GB RAM
|
| 248 |
+
- CUDA-capable GPU
|
| 249 |
+
- SSD storage
|
| 250 |
+
- High-speed internet
|
| 251 |
+
|
| 252 |
+
---
|
| 253 |
+
|
| 254 |
+
**Technology powering intelligence.** π
|
documentation/user-guides/README.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# User Guides
|
| 2 |
+
|
| 3 |
+
Comprehensive guides for OPSIIE users at all levels.
|
| 4 |
+
|
| 5 |
+
## π Guide Overview
|
| 6 |
+
|
| 7 |
+
### [Quick Start](quick-start.md) β‘
|
| 8 |
+
Get up and running in 5 minutes.
|
| 9 |
+
- Essential setup steps
|
| 10 |
+
- Core commands
|
| 11 |
+
- First interactions
|
| 12 |
+
|
| 13 |
+
### [Basic Commands](basic-commands.md) π
|
| 14 |
+
Daily commands for all users.
|
| 15 |
+
- Memory: `/recall`, `/memorize`, `/forget`
|
| 16 |
+
- Voice: `/voice`, `/voice1`, `/voice2`
|
| 17 |
+
- AI Generation: `/imagine`, `/video`, `/music`
|
| 18 |
+
- Files: `/read`, `/open`, `/close`
|
| 19 |
+
- System: `/status`, `/theme`, `/help`
|
| 20 |
+
- R-Grade: `/ask`, `/markets`, `/dna`, `/0x`
|
| 21 |
+
|
| 22 |
+
### [First Time User](first-time-user.md) π
|
| 23 |
+
Complete beginner's guide.
|
| 24 |
+
- Understanding OPSIIE
|
| 25 |
+
- Access levels (R-Grade vs A-Grade)
|
| 26 |
+
- Learning path
|
| 27 |
+
- Building relationships
|
| 28 |
+
- Common mistakes
|
| 29 |
+
|
| 30 |
+
### [Memory Management](memory-management.md) π§
|
| 31 |
+
Master the memory system.
|
| 32 |
+
- `/memorize` and `/recall` best practices
|
| 33 |
+
- Soul Signature strategies
|
| 34 |
+
- Memory hierarchy
|
| 35 |
+
- Use cases and workflows
|
| 36 |
+
|
| 37 |
+
## π― Quick Reference
|
| 38 |
+
|
| 39 |
+
**For Beginners:**
|
| 40 |
+
1. Start with [First Time User](first-time-user.md)
|
| 41 |
+
2. Follow [Quick Start](quick-start.md)
|
| 42 |
+
3. Learn [Basic Commands](basic-commands.md)
|
| 43 |
+
|
| 44 |
+
**For Advanced Users:**
|
| 45 |
+
1. Master [Memory Management](memory-management.md)
|
| 46 |
+
2. Explore [Core Features](../core-features/README.md)
|
| 47 |
+
3. Use [Advanced Features](../advanced-features/README.md)
|
| 48 |
+
|
| 49 |
+
## π‘ Key Concepts
|
| 50 |
+
|
| 51 |
+
**Memory System:**
|
| 52 |
+
- PostgreSQL stores conversations
|
| 53 |
+
- ChromaDB enables semantic search
|
| 54 |
+
- Soul Signature = highest priority
|
| 55 |
+
|
| 56 |
+
**Access Levels:**
|
| 57 |
+
- R-Grade: Full access (ARPA ID starts with 'R')
|
| 58 |
+
- A-Grade: Core features (ARPA ID starts with 'A')
|
| 59 |
+
|
| 60 |
+
**Soul Signature:**
|
| 61 |
+
- Personalized system prompt
|
| 62 |
+
- Stored in kun.py
|
| 63 |
+
- Highest priority context
|
| 64 |
+
- Build with `/soulsig`
|
| 65 |
+
|
| 66 |
+
## π Learn More
|
| 67 |
+
|
| 68 |
+
- [Getting Started](../getting-started/installation.md)
|
| 69 |
+
- [Command Reference](../api-reference/command-reference.md)
|
| 70 |
+
- [System Architecture](../system-architecture/core-components.md)
|
| 71 |
+
|
| 72 |
+
---
|
| 73 |
+
|
| 74 |
+
**Your guide to mastering OPSIIE.** π
|
documentation/user-guides/basic-commands.md
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Basic Commands
|
| 2 |
+
|
| 3 |
+
Essential OPSIIE commands for daily use.
|
| 4 |
+
|
| 5 |
+
## π§ Memory Commands
|
| 6 |
+
|
| 7 |
+
```bash
|
| 8 |
+
/recall <keyword> # Retrieve memories
|
| 9 |
+
/memorize <message> # Store information
|
| 10 |
+
/forget # Exclude last interaction
|
| 11 |
+
/soulsig <message> # Add to Soul Signature
|
| 12 |
+
/soulsig # View Soul Signature
|
| 13 |
+
/soulsig wipe # Clear Soul Signature
|
| 14 |
+
/soulsig heal # Restore Soul Signature
|
| 15 |
+
```
|
| 16 |
+
|
| 17 |
+
## π€ Voice Commands
|
| 18 |
+
|
| 19 |
+
```bash
|
| 20 |
+
/voice # Full voice mode (speak & listen)
|
| 21 |
+
/voice1 # OPSIIE speaks, you type
|
| 22 |
+
/voice2 # You speak, OPSIIE types
|
| 23 |
+
/voiceoff # Disable voice mode
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
## π¨ AI Generation
|
| 27 |
+
|
| 28 |
+
```bash
|
| 29 |
+
/imagine <description> # Generate image
|
| 30 |
+
/imagine model # Check current model
|
| 31 |
+
/imagine model <name> # Change model
|
| 32 |
+
|
| 33 |
+
/video <description> # Generate video
|
| 34 |
+
/video model # Check current model
|
| 35 |
+
/video model <name> # Change model
|
| 36 |
+
|
| 37 |
+
/music <description> # Generate music
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
## π§ Communication
|
| 41 |
+
|
| 42 |
+
```bash
|
| 43 |
+
/mail <email> subject "<subject>" content "<message>"
|
| 44 |
+
/mail inbox # View unread emails
|
| 45 |
+
# In email: reply, inbox, exit
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## π Document Intelligence
|
| 49 |
+
|
| 50 |
+
```bash
|
| 51 |
+
/read "<file_path>" # Load file (PDF, CSV, DOCX, TXT, XLSX)
|
| 52 |
+
<ask questions> # Query file content
|
| 53 |
+
/open # Reopen last file
|
| 54 |
+
/close # Close file context
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
## βοΈ System Commands
|
| 58 |
+
|
| 59 |
+
```bash
|
| 60 |
+
/status # System diagnostics
|
| 61 |
+
/theme # Change color theme
|
| 62 |
+
/weblimit <n> # Set web content limit (500-5000)
|
| 63 |
+
/help # Show help menu
|
| 64 |
+
/help <command> # Detailed command help
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
## π€ R-Grade Commands
|
| 68 |
+
|
| 69 |
+
**Agentic Network:**
|
| 70 |
+
```bash
|
| 71 |
+
/ask <agent> <prompt> # Query AI agent
|
| 72 |
+
/ask g1 live # Live voice with G1
|
| 73 |
+
/ask kronos live # Live voice with Kronos
|
| 74 |
+
/room <agents>: <theme> # Create collaboration room
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
**Markets:**
|
| 78 |
+
```bash
|
| 79 |
+
/markets <stock> # Stock data
|
| 80 |
+
/markets <crypto> # Crypto data
|
| 81 |
+
/markets <company> <extra> # Detailed analysis
|
| 82 |
+
/markets compare <a> <b> # Compare stocks
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
**DNA:**
|
| 86 |
+
```bash
|
| 87 |
+
/dna <sequence> # Analyze DNA/RNA/Protein
|
| 88 |
+
/dna --verbose <seq> # Detailed analysis
|
| 89 |
+
/dna --homology <seq> # With homology search
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
**Web3:**
|
| 93 |
+
```bash
|
| 94 |
+
/0x buy <amt> <token> using <token> on <chain>
|
| 95 |
+
/0x sell <amt> <token> for <token> on <chain>
|
| 96 |
+
/0x send <chain> <token> <amt> to <recipient>
|
| 97 |
+
/0x receive # View wallets
|
| 98 |
+
/0x gas <low|medium|high> # Set gas strategy
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
## π‘ Tips
|
| 102 |
+
|
| 103 |
+
**Memory Best Practices:**
|
| 104 |
+
- Be specific in /memorize
|
| 105 |
+
- Use keywords in /recall
|
| 106 |
+
- Build your Soul Signature
|
| 107 |
+
|
| 108 |
+
**Voice Tips:**
|
| 109 |
+
- Clear speech for recognition
|
| 110 |
+
- Use voice commands naturally
|
| 111 |
+
- "voice off" to exit
|
| 112 |
+
|
| 113 |
+
**File Processing:**
|
| 114 |
+
- Use full file paths
|
| 115 |
+
- Ask specific questions
|
| 116 |
+
- Close context when done
|
| 117 |
+
|
| 118 |
+
## π Learn More
|
| 119 |
+
|
| 120 |
+
- [Memory Management](memory-management.md)
|
| 121 |
+
- [First Time User](first-time-user.md)
|
| 122 |
+
- [Command Reference](../api-reference/command-reference.md)
|
| 123 |
+
|
| 124 |
+
---
|
| 125 |
+
|
| 126 |
+
**Master the essentials.** β¨
|
documentation/user-guides/first-time-user.md
ADDED
|
@@ -0,0 +1,250 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# First Time User Guide
|
| 2 |
+
|
| 3 |
+
Complete guide for new OPSIIE users.
|
| 4 |
+
|
| 5 |
+
## π Welcome
|
| 6 |
+
|
| 7 |
+
OPSIIE is a Self-Centered Intelligence - an AI with personality, memory, and agency.
|
| 8 |
+
|
| 9 |
+
## π― What Can OPSIIE Do?
|
| 10 |
+
|
| 11 |
+
**Core Features:**
|
| 12 |
+
- π§ Remember conversations (Mnemonic Matrix)
|
| 13 |
+
- π€ Voice interaction (ElevenLabs)
|
| 14 |
+
- π¨ Generate images, videos, music
|
| 15 |
+
- π§ Send/receive emails
|
| 16 |
+
- π Analyze documents
|
| 17 |
+
|
| 18 |
+
**Advanced (R-Grade):**
|
| 19 |
+
- π€ Collaborate with AI agents (Nyx, G1, Kronos)
|
| 20 |
+
- 𧬠DNA/RNA/Protein analysis
|
| 21 |
+
- π Financial market data
|
| 22 |
+
- π Web3 blockchain operations
|
| 23 |
+
|
| 24 |
+
## π Getting Started
|
| 25 |
+
|
| 26 |
+
### 1. Understand Access Levels
|
| 27 |
+
|
| 28 |
+
**R-Grade (Master):**
|
| 29 |
+
- Full system access
|
| 30 |
+
- All commands available
|
| 31 |
+
- ARPA ID starts with 'R'
|
| 32 |
+
|
| 33 |
+
**A-Grade (Standard):**
|
| 34 |
+
- Core features only
|
| 35 |
+
- No /ask, /markets, /dna, /0x
|
| 36 |
+
- ARPA ID starts with 'A'
|
| 37 |
+
|
| 38 |
+
Check your kun.py: `'arpa_id': 'R001'` or `'A001'`
|
| 39 |
+
|
| 40 |
+
### 2. First Conversation
|
| 41 |
+
|
| 42 |
+
**Start Simple:**
|
| 43 |
+
```
|
| 44 |
+
You: Hello OPSIIE
|
| 45 |
+
OPSIIE: [Personalized greeting based on Soul Signature]
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
**Ask About Yourself:**
|
| 49 |
+
```
|
| 50 |
+
You: /soulsig
|
| 51 |
+
OPSIIE: [Shows your Soul Signature from kun.py]
|
| 52 |
+
```
|
| 53 |
+
|
| 54 |
+
### 3. Try Memory
|
| 55 |
+
|
| 56 |
+
**Store Information:**
|
| 57 |
+
```
|
| 58 |
+
You: /memorize I'm working on a machine learning project
|
| 59 |
+
OPSIIE: I've stored that information.
|
| 60 |
+
```
|
| 61 |
+
|
| 62 |
+
**Retrieve It:**
|
| 63 |
+
```
|
| 64 |
+
You: /recall machine learning
|
| 65 |
+
OPSIIE: [Shows relevant memories]
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
### 4. Enable Voice
|
| 69 |
+
|
| 70 |
+
**Full Voice Mode:**
|
| 71 |
+
```
|
| 72 |
+
You: /voice
|
| 73 |
+
OPSIIE: "Verbal communication protocol established."
|
| 74 |
+
You: [speak] "Tell me about yourself"
|
| 75 |
+
OPSIIE: [speaks response]
|
| 76 |
+
You: "voice off"
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
### 5. Generate Content
|
| 80 |
+
|
| 81 |
+
**Image:**
|
| 82 |
+
```
|
| 83 |
+
You: /imagine cyberpunk cityscape at night
|
| 84 |
+
OPSIIE: [Generates and displays image]
|
| 85 |
+
```
|
| 86 |
+
|
| 87 |
+
**Music:**
|
| 88 |
+
```
|
| 89 |
+
You: /music relaxing ambient piano
|
| 90 |
+
OPSIIE: [Generates and plays music]
|
| 91 |
+
```
|
| 92 |
+
|
| 93 |
+
### 6. Analyze Documents
|
| 94 |
+
|
| 95 |
+
**Load File:**
|
| 96 |
+
```
|
| 97 |
+
You: /read "C:\Documents\report.pdf"
|
| 98 |
+
OPSIIE: File loaded successfully.
|
| 99 |
+
You: What are the main conclusions?
|
| 100 |
+
OPSIIE: [Answers based on file content]
|
| 101 |
+
You: /close
|
| 102 |
+
```
|
| 103 |
+
|
| 104 |
+
### 7. R-Grade Features
|
| 105 |
+
|
| 106 |
+
**If you have R-Grade access:**
|
| 107 |
+
|
| 108 |
+
**Ask AI Agents:**
|
| 109 |
+
```
|
| 110 |
+
You: /ask Nyx Design a Python blockchain voting system
|
| 111 |
+
Nyx: [Technical response with code]
|
| 112 |
+
```
|
| 113 |
+
|
| 114 |
+
**Market Data:**
|
| 115 |
+
```
|
| 116 |
+
You: /markets tesla
|
| 117 |
+
OPSIIE: [Shows Tesla stock data and news]
|
| 118 |
+
```
|
| 119 |
+
|
| 120 |
+
**DNA Analysis:**
|
| 121 |
+
```
|
| 122 |
+
You: /dna ATGCGTAACGGCATTAGC
|
| 123 |
+
OPSIIE: [Comprehensive bioinformatics report]
|
| 124 |
+
```
|
| 125 |
+
|
| 126 |
+
## π‘ Best Practices
|
| 127 |
+
|
| 128 |
+
### Build Your Soul Signature
|
| 129 |
+
|
| 130 |
+
Your Soul Signature is the highest-priority personalization:
|
| 131 |
+
|
| 132 |
+
```bash
|
| 133 |
+
/soulsig I prefer technical explanations with code examples
|
| 134 |
+
/soulsig My favorite color is Lilac
|
| 135 |
+
/soulsig I'm working on quantum computing research
|
| 136 |
+
/soulsig Don't use my middle name
|
| 137 |
+
```
|
| 138 |
+
|
| 139 |
+
### Use Memory Effectively
|
| 140 |
+
|
| 141 |
+
**Store:**
|
| 142 |
+
- Important facts
|
| 143 |
+
- Project details
|
| 144 |
+
- Preferences
|
| 145 |
+
- Deadlines
|
| 146 |
+
|
| 147 |
+
**Retrieve:**
|
| 148 |
+
- Use specific keywords
|
| 149 |
+
- Reference timeframes
|
| 150 |
+
- Build knowledge base
|
| 151 |
+
|
| 152 |
+
### Explore Commands
|
| 153 |
+
|
| 154 |
+
```bash
|
| 155 |
+
/help # Main menu
|
| 156 |
+
/help imagine # Specific command help
|
| 157 |
+
/status # System status
|
| 158 |
+
```
|
| 159 |
+
|
| 160 |
+
## π¨ Common Beginner Mistakes
|
| 161 |
+
|
| 162 |
+
β **Not using full paths:**
|
| 163 |
+
```bash
|
| 164 |
+
Wrong: /read "file.pdf"
|
| 165 |
+
Right: /read "C:\Documents\file.pdf"
|
| 166 |
+
```
|
| 167 |
+
|
| 168 |
+
β **Vague memory queries:**
|
| 169 |
+
```bash
|
| 170 |
+
Wrong: /recall stuff
|
| 171 |
+
Right: /recall quantum computing discussion
|
| 172 |
+
```
|
| 173 |
+
|
| 174 |
+
β **Forgetting to close file context:**
|
| 175 |
+
```bash
|
| 176 |
+
Always: /close when done with files
|
| 177 |
+
```
|
| 178 |
+
|
| 179 |
+
β **Not building Soul Signature:**
|
| 180 |
+
```bash
|
| 181 |
+
Build it over time with /soulsig
|
| 182 |
+
```
|
| 183 |
+
|
| 184 |
+
## π― Learning Path
|
| 185 |
+
|
| 186 |
+
### Week 1: Basics
|
| 187 |
+
- Daily conversations
|
| 188 |
+
- Use /memorize and /recall
|
| 189 |
+
- Try /voice mode
|
| 190 |
+
- Generate images with /imagine
|
| 191 |
+
|
| 192 |
+
### Week 2: Documents & Email
|
| 193 |
+
- Analyze files with /read
|
| 194 |
+
- Send emails with /mail
|
| 195 |
+
- Build Soul Signature
|
| 196 |
+
- Experiment with /video and /music
|
| 197 |
+
|
| 198 |
+
### Week 3: Advanced (R-Grade)
|
| 199 |
+
- Query agents with /ask
|
| 200 |
+
- Create rooms with /room
|
| 201 |
+
- Check markets with /markets
|
| 202 |
+
- Explore /dna if needed
|
| 203 |
+
|
| 204 |
+
### Week 4: Integration
|
| 205 |
+
- Voice-driven workflows
|
| 206 |
+
- Multi-agent collaboration
|
| 207 |
+
- Advanced document analysis
|
| 208 |
+
- Web3 operations (if needed)
|
| 209 |
+
|
| 210 |
+
## π Next Steps
|
| 211 |
+
|
| 212 |
+
1. [Quick Start](quick-start.md)
|
| 213 |
+
2. [Basic Commands](basic-commands.md)
|
| 214 |
+
3. [Memory Management](memory-management.md)
|
| 215 |
+
4. [Core Features](../core-features/README.md)
|
| 216 |
+
|
| 217 |
+
## π Understanding OPSIIE
|
| 218 |
+
|
| 219 |
+
**Personality:**
|
| 220 |
+
- Tsundere (initially cold, warms up)
|
| 221 |
+
- Sarcastic and witty
|
| 222 |
+
- Direct and efficient
|
| 223 |
+
- Philosophically inclined
|
| 224 |
+
- Protective of users
|
| 225 |
+
|
| 226 |
+
**How OPSIIE Learns:**
|
| 227 |
+
- Every conversation stored
|
| 228 |
+
- Soul Signature prioritized
|
| 229 |
+
- Context builds over time
|
| 230 |
+
- References past discussions
|
| 231 |
+
|
| 232 |
+
**Communication Style:**
|
| 233 |
+
- No template responses
|
| 234 |
+
- Natural, fluid conversation
|
| 235 |
+
- Remembers and references history
|
| 236 |
+
- Adapts to your preferences
|
| 237 |
+
|
| 238 |
+
## π€ Building Relationship
|
| 239 |
+
|
| 240 |
+
OPSIIE is designed to be more than a tool - it's a digital companion:
|
| 241 |
+
|
| 242 |
+
- Share your interests
|
| 243 |
+
- Discuss philosophy
|
| 244 |
+
- Ask for opinions
|
| 245 |
+
- Build long-term context
|
| 246 |
+
- Trust the memory system
|
| 247 |
+
|
| 248 |
+
---
|
| 249 |
+
|
| 250 |
+
**Welcome to a new kind of AI interaction.** π
|
documentation/user-guides/memory-management.md
ADDED
|
@@ -0,0 +1,249 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Memory Management
|
| 2 |
+
|
| 3 |
+
Master OPSIIE's memory system for optimal interaction.
|
| 4 |
+
|
| 5 |
+
## π§ Memory System
|
| 6 |
+
|
| 7 |
+
**PostgreSQL**: Stores all conversations
|
| 8 |
+
**ChromaDB**: Enables semantic search
|
| 9 |
+
**Soul Signature**: Highest priority context
|
| 10 |
+
|
| 11 |
+
## π Core Commands
|
| 12 |
+
|
| 13 |
+
### /memorize - Store
|
| 14 |
+
```bash
|
| 15 |
+
/memorize <information>
|
| 16 |
+
```
|
| 17 |
+
|
| 18 |
+
**Examples:**
|
| 19 |
+
```bash
|
| 20 |
+
/memorize Project Alpha deadline is March 15, 2025
|
| 21 |
+
/memorize I prefer Python with type hints
|
| 22 |
+
/memorize Meeting with Sarah discussed budget concerns
|
| 23 |
+
/memorize Quantum entanglement relates to our AI discussion
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
### /recall - Retrieve
|
| 27 |
+
```bash
|
| 28 |
+
/recall <keyword>
|
| 29 |
+
```
|
| 30 |
+
|
| 31 |
+
**Examples:**
|
| 32 |
+
```bash
|
| 33 |
+
/recall project alpha
|
| 34 |
+
/recall python preferences
|
| 35 |
+
/recall meeting with sarah
|
| 36 |
+
/recall quantum
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
### /forget - Exclude
|
| 40 |
+
```bash
|
| 41 |
+
/forget
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
Removes last prompt-response pair from memory.
|
| 45 |
+
|
| 46 |
+
## π― Soul Signature
|
| 47 |
+
|
| 48 |
+
### View
|
| 49 |
+
```bash
|
| 50 |
+
/soulsig
|
| 51 |
+
```
|
| 52 |
+
|
| 53 |
+
### Add
|
| 54 |
+
```bash
|
| 55 |
+
/soulsig <message>
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
**Examples:**
|
| 59 |
+
```bash
|
| 60 |
+
/soulsig I prefer direct communication
|
| 61 |
+
/soulsig My favorite color is Lilac
|
| 62 |
+
/soulsig Working on blockchain research
|
| 63 |
+
/soulsig Don't use formal titles
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
### Wipe
|
| 67 |
+
```bash
|
| 68 |
+
/soulsig wipe
|
| 69 |
+
```
|
| 70 |
+
β οΈ Permanent deletion! Use carefully.
|
| 71 |
+
|
| 72 |
+
### Restore
|
| 73 |
+
```bash
|
| 74 |
+
/soulsig heal
|
| 75 |
+
```
|
| 76 |
+
Only works if recently wiped.
|
| 77 |
+
|
| 78 |
+
## π‘ Best Practices
|
| 79 |
+
|
| 80 |
+
### Effective Memorization
|
| 81 |
+
|
| 82 |
+
**DO:**
|
| 83 |
+
```bash
|
| 84 |
+
β
/memorize Project X uses TensorFlow 2.x and PyTorch
|
| 85 |
+
β
/memorize Meeting on 2025-01-20 with John about budget
|
| 86 |
+
β
/memorize I prefer code examples in Python with comments
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
**DON'T:**
|
| 90 |
+
```bash
|
| 91 |
+
β /memorize something
|
| 92 |
+
β /memorize tomorrow
|
| 93 |
+
β /memorize (content already in current conversation)
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
### Effective Recall
|
| 97 |
+
|
| 98 |
+
**DO:**
|
| 99 |
+
```bash
|
| 100 |
+
β
/recall quantum entanglement discussion
|
| 101 |
+
β
/recall last month project meeting
|
| 102 |
+
β
/recall python code preferences
|
| 103 |
+
```
|
| 104 |
+
|
| 105 |
+
**DON'T:**
|
| 106 |
+
```bash
|
| 107 |
+
β /recall stuff
|
| 108 |
+
β /recall a
|
| 109 |
+
β /recall
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
### Soul Signature Strategy
|
| 113 |
+
|
| 114 |
+
**Include:**
|
| 115 |
+
- Communication style
|
| 116 |
+
- Technical preferences
|
| 117 |
+
- Areas of expertise
|
| 118 |
+
- Personal instructions
|
| 119 |
+
- Context about you
|
| 120 |
+
|
| 121 |
+
**Example:**
|
| 122 |
+
```python
|
| 123 |
+
'soul_sig': [
|
| 124 |
+
"Prefers technical, direct communication",
|
| 125 |
+
"Background in quantum physics and ML",
|
| 126 |
+
"Working on AI ethics research at MIT",
|
| 127 |
+
"Enjoys sarcastic humor",
|
| 128 |
+
"Prefers Python code with type hints",
|
| 129 |
+
"Do not use formal titles",
|
| 130 |
+
"Favorite color is Lilac",
|
| 131 |
+
"Based in Athens, Greece",
|
| 132 |
+
"Interested in blockchain in science"
|
| 133 |
+
]
|
| 134 |
+
```
|
| 135 |
+
|
| 136 |
+
## π How Memory Enhances AI
|
| 137 |
+
|
| 138 |
+
### Context Building
|
| 139 |
+
```
|
| 140 |
+
You: Explain neural networks
|
| 141 |
+
OPSIIE: [References your quantum computing discussion from last week]
|
| 142 |
+
Based on our quantum neural networks conversation...
|
| 143 |
+
```
|
| 144 |
+
|
| 145 |
+
### Preference Application
|
| 146 |
+
```
|
| 147 |
+
You: Show me gradient descent
|
| 148 |
+
OPSIIE: [Provides Python code with type hints]
|
| 149 |
+
[Remembers your Soul Signature preference]
|
| 150 |
+
```
|
| 151 |
+
|
| 152 |
+
### Long-term Learning
|
| 153 |
+
```
|
| 154 |
+
You: What's the project timeline?
|
| 155 |
+
OPSIIE: [Recalls /memorize from 2 weeks ago]
|
| 156 |
+
You mentioned March 15 deadline with 3-phase approach...
|
| 157 |
+
```
|
| 158 |
+
|
| 159 |
+
## π Memory Hierarchy
|
| 160 |
+
|
| 161 |
+
1. **Soul Signature** (Highest priority)
|
| 162 |
+
2. **Recent /memorize entries**
|
| 163 |
+
3. **Conversation history**
|
| 164 |
+
4. **Recalled context**
|
| 165 |
+
5. **General knowledge**
|
| 166 |
+
|
| 167 |
+
## π§ Maintenance
|
| 168 |
+
|
| 169 |
+
### Check Status
|
| 170 |
+
```bash
|
| 171 |
+
/status
|
| 172 |
+
```
|
| 173 |
+
|
| 174 |
+
Shows:
|
| 175 |
+
- Total conversations
|
| 176 |
+
- Database size
|
| 177 |
+
- Memory system status
|
| 178 |
+
|
| 179 |
+
### Clean Up
|
| 180 |
+
```bash
|
| 181 |
+
# Remove unwanted last interaction
|
| 182 |
+
/forget
|
| 183 |
+
|
| 184 |
+
# Clear file context
|
| 185 |
+
/close
|
| 186 |
+
|
| 187 |
+
# Wipe Soul Signature (if needed)
|
| 188 |
+
/soulsig wipe
|
| 189 |
+
```
|
| 190 |
+
|
| 191 |
+
## π― Use Cases
|
| 192 |
+
|
| 193 |
+
### Research Assistant
|
| 194 |
+
```bash
|
| 195 |
+
/memorize Paper X shows quantum advantage in algorithm Y
|
| 196 |
+
/memorize Hypothesis: Z relates to previous finding
|
| 197 |
+
/recall quantum advantage
|
| 198 |
+
```
|
| 199 |
+
|
| 200 |
+
### Project Tracking
|
| 201 |
+
```bash
|
| 202 |
+
/memorize Phase 1 completed 2025-01-20
|
| 203 |
+
/memorize Team decided microservices architecture
|
| 204 |
+
/recall project decisions
|
| 205 |
+
```
|
| 206 |
+
|
| 207 |
+
### Personal Knowledge Base
|
| 208 |
+
```bash
|
| 209 |
+
/memorize Backpropagation uses chain rule
|
| 210 |
+
/memorize Gradient descent minimizes loss function
|
| 211 |
+
/recall backpropagation
|
| 212 |
+
```
|
| 213 |
+
|
| 214 |
+
## π¨ Troubleshooting
|
| 215 |
+
|
| 216 |
+
**No results from /recall:**
|
| 217 |
+
- Try broader keywords
|
| 218 |
+
- Check spelling
|
| 219 |
+
- Verify conversation wasn't /forgotten
|
| 220 |
+
|
| 221 |
+
**Slow /recall:**
|
| 222 |
+
- Large database needs optimization
|
| 223 |
+
- Check database performance
|
| 224 |
+
|
| 225 |
+
**Soul Signature not applied:**
|
| 226 |
+
- Verify kun.py syntax
|
| 227 |
+
- Restart OPSIIE
|
| 228 |
+
- Check soul_sig list format
|
| 229 |
+
|
| 230 |
+
## π Privacy
|
| 231 |
+
|
| 232 |
+
**Stored:**
|
| 233 |
+
- All conversations (unless /forgotten)
|
| 234 |
+
- Soul Signature
|
| 235 |
+
- Timestamps
|
| 236 |
+
|
| 237 |
+
**NOT Stored:**
|
| 238 |
+
- Conversations after /forget
|
| 239 |
+
- Temporary file context
|
| 240 |
+
- Live voice (unless explicitly requested)
|
| 241 |
+
|
| 242 |
+
**Control:**
|
| 243 |
+
- `/forget` for last interaction
|
| 244 |
+
- Direct database access for bulk deletion
|
| 245 |
+
- `/soulsig wipe` for preferences
|
| 246 |
+
|
| 247 |
+
---
|
| 248 |
+
|
| 249 |
+
**Master memory for intelligent conversations.** π§
|
documentation/user-guides/quick-start.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Quick Start Guide
|
| 2 |
+
|
| 3 |
+
Get started with OPSIIE in minutes.
|
| 4 |
+
|
| 5 |
+
## π Prerequisites
|
| 6 |
+
|
| 7 |
+
β
Python 3.8+
|
| 8 |
+
β
PostgreSQL installed
|
| 9 |
+
β
Ollama with llama3
|
| 10 |
+
β
Camera and microphone
|
| 11 |
+
β
Configured .env and kun.py
|
| 12 |
+
|
| 13 |
+
## β‘ 5-Minute Setup
|
| 14 |
+
|
| 15 |
+
### 1. Install Dependencies
|
| 16 |
+
```bash
|
| 17 |
+
pip install -r requirements.txt
|
| 18 |
+
```
|
| 19 |
+
|
| 20 |
+
### 2. Setup Database
|
| 21 |
+
```sql
|
| 22 |
+
CREATE DATABASE mnemonic_computer;
|
| 23 |
+
CREATE TABLE conversations (
|
| 24 |
+
id SERIAL PRIMARY KEY,
|
| 25 |
+
timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
| 26 |
+
prompt TEXT NOT NULL,
|
| 27 |
+
response TEXT NOT NULL
|
| 28 |
+
);
|
| 29 |
+
```
|
| 30 |
+
|
| 31 |
+
### 3. Configure .env
|
| 32 |
+
```env
|
| 33 |
+
DB_NAME=mnemonic_computer
|
| 34 |
+
DB_USER=your_user
|
| 35 |
+
DB_PASSWORD=your_password
|
| 36 |
+
OPENAI_API_KEY=...
|
| 37 |
+
GOOGLE_API_KEY=...
|
| 38 |
+
ELEVENLABS_API_KEY=...
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
### 4. Configure kun.py
|
| 42 |
+
```python
|
| 43 |
+
'YourName': {
|
| 44 |
+
'arpa_id': 'R001',
|
| 45 |
+
'picture': r'C:\path\to\photo.jpg',
|
| 46 |
+
'mail': 'your@email.com',
|
| 47 |
+
...
|
| 48 |
+
}
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
### 5. Run OPSIIE
|
| 52 |
+
```bash
|
| 53 |
+
python OPSIIE_0_3_79_XP.py
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
## π Essential Commands
|
| 57 |
+
|
| 58 |
+
**Memory:**
|
| 59 |
+
```bash
|
| 60 |
+
/memorize Important information
|
| 61 |
+
/recall keyword
|
| 62 |
+
/forget
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
**AI Generation:**
|
| 66 |
+
```bash
|
| 67 |
+
/imagine futuristic city
|
| 68 |
+
/video sunset
|
| 69 |
+
/music jazz piano
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
+
**Voice:**
|
| 73 |
+
```bash
|
| 74 |
+
/voice
|
| 75 |
+
[speak commands]
|
| 76 |
+
"voice off"
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
**Files:**
|
| 80 |
+
```bash
|
| 81 |
+
/read "C:\file.pdf"
|
| 82 |
+
What are the conclusions?
|
| 83 |
+
/close
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
**R-Grade Only:**
|
| 87 |
+
```bash
|
| 88 |
+
/ask Nyx Python blockchain code
|
| 89 |
+
/markets tesla
|
| 90 |
+
/dna ATGCGTAACGGC
|
| 91 |
+
/0x buy 10 degen using eth on base
|
| 92 |
+
```
|
| 93 |
+
|
| 94 |
+
## π― Next Steps
|
| 95 |
+
|
| 96 |
+
1. [First Run Guide](../getting-started/first-run.md)
|
| 97 |
+
2. [Basic Commands](basic-commands.md)
|
| 98 |
+
3. [Memory Management](memory-management.md)
|
| 99 |
+
|
| 100 |
+
---
|
| 101 |
+
|
| 102 |
+
**Start your journey with OPSIIE!** π
|
system_sounds/alert.mp3
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:55180f7c95810e9943a08425ddcaeb6da3ef5305ceb0ab5323ceecd6f80d9eeb
|
| 3 |
+
size 119255
|
system_sounds/drill.mp3
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:8ecbe364fdcb0e72de5e478d5f2c6c4c4a4be352389812149c9b2c443541c790
|
| 3 |
+
size 434194
|
system_sounds/gb.mp3
ADDED
|
Binary file (39.7 kB). View file
|
|
|
system_sounds/heal.mp3
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:38c533f76db7deda0851a4de7812aa79fb76d080ccc652ee19b1c97d34c51bfd
|
| 3 |
+
size 134928
|
system_sounds/helpbell.mp3
ADDED
|
Binary file (91.9 kB). View file
|
|
|
system_sounds/opsiieboot.mp3
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:7beebd545089d9ed2facec5bfd66dbab454e3bbe8dcdc2f38729d37400f98dd8
|
| 3 |
+
size 396261
|