New front-end Launch Chat API Manage Sources Enable re-embedding of all contents Sources can be added without a notebook now Improved settings Enable model selector on all chats Background processing for better experience Dark mode Improved Notes Improved Docs: - Remove all Streamlit references from documentation - Update deployment guides with React frontend setup - Fix Docker environment variables format (SURREAL_URL, SURREAL_PASSWORD) - Update docker image tag from :latest to :v1-latest - Change navigation references (Settings → Models to just Models) - Update development setup to include frontend npm commands - Add MIGRATION.md guide for users upgrading from Streamlit - Update quick-start guide with correct environment variables - Add port 5055 documentation for API access - Update project structure to reflect frontend/ directory - Remove outdated source-chat documentation files
422 lines
No EOL
15 KiB
Markdown
422 lines
No EOL
15 KiB
Markdown
# Chat User Guide
|
|
|
|
The Chat Assistant in Open Notebook provides an intelligent interface for interacting with your research materials. This guide will help you master the chat features to get the most insightful and productive conversations with AI about your content.
|
|
|
|
## Chat Interface Basics
|
|
|
|
### Starting Your First Chat
|
|
|
|
1. **Navigate to Your Notebook**: Open the notebook containing your research materials
|
|
2. **Access the Chat Panel**: Look for the chat interface in your notebook layout
|
|
3. **Review Your Context**: Check which sources are available for the conversation
|
|
4. **Start Typing**: Enter your question or topic in the chat input field
|
|
5. **Send Your Message**: Press Enter or click the send button to begin
|
|
|
|
### Understanding the Chat Layout
|
|
|
|
The chat interface consists of several key components:
|
|
|
|
- **Message History**: Shows your conversation thread
|
|
- **Context Panel**: Displays which sources are available to the AI
|
|
- **Input Field**: Where you type your messages
|
|
- **Action Buttons**: Options to save messages as notes or manage the conversation
|
|
|
|
### Basic Chat Commands and Interactions
|
|
|
|
#### Effective Question Patterns
|
|
|
|
**Research Questions**:
|
|
- "What are the main arguments in [source name]?"
|
|
- "How do these sources relate to each other?"
|
|
- "What evidence supports [specific claim]?"
|
|
|
|
**Analysis Requests**:
|
|
- "Analyze the methodology used in [source]"
|
|
- "Compare the findings across all sources"
|
|
- "Identify gaps in the current research"
|
|
|
|
**Synthesis Queries**:
|
|
- "Synthesize the key insights from all sources"
|
|
- "What conclusions can be drawn from this evidence?"
|
|
- "How do these findings challenge existing theory?"
|
|
|
|
## Context Configuration Options
|
|
|
|
Context management is crucial for effective AI conversations. Open Notebook gives you complete control over what information the AI can access.
|
|
|
|
### Context Levels Explained
|
|
|
|
#### Not in Context
|
|
- **What it means**: The AI cannot see this content
|
|
- **When to use**: For sensitive information or irrelevant sources
|
|
- **Benefits**: Maintains privacy, reduces costs, keeps conversations focused
|
|
|
|
#### Summary Context
|
|
- **What it means**: AI receives a condensed version of the content
|
|
- **When to use**: For background information or supporting materials
|
|
- **Benefits**: Provides context without overwhelming the conversation, cost-effective
|
|
|
|
#### Full Content Context
|
|
- **What it means**: AI has access to the complete source material
|
|
- **When to use**: For detailed analysis or when precise citations are needed
|
|
- **Benefits**: Most comprehensive analysis, detailed responses
|
|
|
|
### Strategic Context Management
|
|
|
|
#### The Minimalist Approach
|
|
Start with minimal context and expand as needed:
|
|
1. Begin with "Summary" context for background sources
|
|
2. Add "Full Content" only for primary sources
|
|
3. Gradually include more context if the AI needs additional information
|
|
|
|
#### The Focused Approach
|
|
Select context based on your current research question:
|
|
- **For broad overview**: Use summary context for multiple sources
|
|
- **For detailed analysis**: Use full content for 1-2 key sources
|
|
- **For comparison**: Use full content for sources being compared
|
|
|
|
#### The Cost-Conscious Approach
|
|
Balance insight quality with API costs:
|
|
- Use summary context as the default
|
|
- Reserve full content for the most important sources
|
|
- Remove sources from context when they're no longer relevant
|
|
|
|
### Dynamic Context Adjustment
|
|
|
|
You can modify context settings during conversations:
|
|
|
|
1. **Mid-Conversation Changes**: Adjust context based on how the conversation develops
|
|
2. **Follow-up Questions**: Add relevant sources when diving deeper into topics
|
|
3. **Topic Shifts**: Remove irrelevant sources and add new ones for different questions
|
|
|
|
## Multiple Chat Sessions
|
|
|
|
Open Notebook allows you to maintain separate chat threads for different aspects of your research.
|
|
|
|
### Creating and Managing Multiple Chats
|
|
|
|
#### When to Start a New Chat Session
|
|
|
|
**Different Research Questions**:
|
|
- Each major research question deserves its own chat
|
|
- Separate exploratory from analytical conversations
|
|
- Keep methodology discussions separate from findings
|
|
|
|
**Different Source Sets**:
|
|
- Create chats for different groups of sources
|
|
- Separate primary and secondary source discussions
|
|
- Use different chats for different time periods or topics
|
|
|
|
**Different Analysis Stages**:
|
|
- Initial exploration chat
|
|
- Deep analysis chat
|
|
- Synthesis and conclusion chat
|
|
|
|
#### Best Practices for Multiple Chats
|
|
|
|
1. **Descriptive Names**: Give each chat a clear, descriptive name
|
|
2. **Consistent Context**: Maintain appropriate context settings for each chat's purpose
|
|
3. **Regular Reviews**: Periodically review and organize your chat sessions
|
|
4. **Cross-Reference**: Note connections between different chat sessions
|
|
|
|
### Chat Organization Strategies
|
|
|
|
#### By Research Phase
|
|
- **Phase 1**: Initial exploration and question formulation
|
|
- **Phase 2**: Deep analysis and evidence gathering
|
|
- **Phase 3**: Synthesis and conclusion development
|
|
|
|
#### By Source Type
|
|
- **Academic Sources**: Scholarly papers and research
|
|
- **Media Sources**: News articles and reports
|
|
- **Primary Sources**: Original documents and data
|
|
|
|
#### By Topic or Theme
|
|
- **Main Research Question**: Core topic investigation
|
|
- **Related Topics**: Supporting or tangential inquiries
|
|
- **Methodology**: Research approach and methods
|
|
|
|
## Chat History Management
|
|
|
|
### Reviewing Past Conversations
|
|
|
|
#### Finding Important Information
|
|
- **Search Within Chats**: Use keywords to find specific discussions
|
|
- **Bookmark Key Messages**: Save important AI responses as notes
|
|
- **Review Summaries**: Periodically summarize key insights from chats
|
|
|
|
#### Organizing Chat History
|
|
- **Regular Cleanup**: Archive or delete outdated conversations
|
|
- **Export Key Insights**: Move important findings to permanent notes
|
|
- **Create Indexes**: Maintain lists of important chat topics
|
|
|
|
### Using Chat History for Research Development
|
|
|
|
#### Tracking Research Evolution
|
|
- **Question Development**: See how your research questions evolved
|
|
- **Insight Building**: Track how insights developed over time
|
|
- **Gap Identification**: Notice what topics need more exploration
|
|
|
|
#### Building on Previous Conversations
|
|
- **Reference Earlier Chats**: Mention previous discussions in new messages
|
|
- **Continuing Threads**: Pick up where previous conversations left off
|
|
- **Connecting Insights**: Link findings across different chat sessions
|
|
|
|
## Best Practices for Effective AI Conversations
|
|
|
|
### Asking Better Questions
|
|
|
|
#### Be Specific and Clear
|
|
**Instead of**: "What does this say?"
|
|
**Try**: "What are the main arguments in Smith's 2023 paper about climate policy?"
|
|
|
|
**Instead of**: "Are these related?"
|
|
**Try**: "How do the findings in Source A support or contradict the theory presented in Source B?"
|
|
|
|
#### Provide Context for Your Questions
|
|
- Explain why you're asking the question
|
|
- Mention your research goals
|
|
- Reference previous parts of the conversation
|
|
|
|
#### Use Progressive Questioning
|
|
1. **Start Broad**: "What are the main themes in these sources?"
|
|
2. **Get Specific**: "Can you elaborate on the methodology used in Source A?"
|
|
3. **Synthesize**: "How do these findings relate to my research question about X?"
|
|
|
|
### Optimizing AI Responses
|
|
|
|
#### Request Specific Formats
|
|
- "Please provide a bullet-point summary"
|
|
- "Create a comparison table"
|
|
- "List the evidence for each argument"
|
|
|
|
#### Ask for Citations
|
|
- "Please include specific quotes to support your analysis"
|
|
- "Which sources support this conclusion?"
|
|
- "Can you provide page numbers for these references?"
|
|
|
|
#### Encourage Critical Analysis
|
|
- "What are the limitations of this study?"
|
|
- "What alternative interpretations are possible?"
|
|
- "Where might there be bias in this source?"
|
|
|
|
### Managing Long Conversations
|
|
|
|
#### Breaking Down Complex Topics
|
|
- Address one aspect at a time
|
|
- Use follow-up questions to drill down
|
|
- Summarize key points before moving to new topics
|
|
|
|
#### Maintaining Conversation Flow
|
|
- Reference previous points in the conversation
|
|
- Ask the AI to summarize before continuing
|
|
- Use transitional phrases to connect ideas
|
|
|
|
## Citation Features in Chat
|
|
|
|
### Understanding AI Citations
|
|
|
|
When the AI references your sources, it provides:
|
|
- **Source Identification**: Which document the information came from
|
|
- **Specific References**: Page numbers or sections when available
|
|
- **Quote Attribution**: Direct quotes with proper attribution
|
|
|
|
### Requesting Better Citations
|
|
|
|
#### Ask for Specific References
|
|
- "Please provide the exact quote that supports this point"
|
|
- "Which page in the document contains this information?"
|
|
- "Can you cite the specific study mentioned?"
|
|
|
|
#### Verify Citation Accuracy
|
|
- **Cross-Check**: Verify quotes against original sources
|
|
- **Context Check**: Ensure citations are used appropriately
|
|
- **Completeness**: Make sure important citations aren't missing
|
|
|
|
### Using Citations for Your Research
|
|
|
|
#### Building Bibliography
|
|
- Save cited sources for your reference list
|
|
- Note page numbers for future reference
|
|
- Track which sources are most frequently cited
|
|
|
|
#### Fact-Checking
|
|
- Use citations to verify AI claims
|
|
- Cross-reference information across sources
|
|
- Identify potential contradictions
|
|
|
|
## Advanced Chat Features
|
|
|
|
### Using the Ask Feature
|
|
|
|
The Ask feature provides sophisticated research assistance:
|
|
|
|
1. **Query Strategy**: AI determines what to search for
|
|
2. **Individual Analysis**: Each query gets processed separately
|
|
3. **Final Synthesis**: All results are combined into a coherent answer
|
|
|
|
#### Optimizing Ask Queries
|
|
- **Be Specific**: Clear, focused questions get better results
|
|
- **Provide Context**: Explain what you're trying to understand
|
|
- **Multiple Angles**: Ask questions that explore different aspects
|
|
|
|
### Integration with Notes
|
|
|
|
#### Saving Chat Messages as Notes
|
|
1. **Identify Valuable Responses**: Look for insights worth preserving
|
|
2. **Click "Save as Note"**: Convert any AI message to a permanent note
|
|
3. **Edit and Enhance**: Customize the note with your own insights
|
|
4. **Link to Sources**: Connect the note to relevant source materials
|
|
|
|
#### Using Notes to Enhance Chats
|
|
- Reference your notes in conversations
|
|
- Ask the AI to build on your existing notes
|
|
- Use notes as starting points for new discussions
|
|
|
|
## Troubleshooting Common Chat Issues
|
|
|
|
### AI Responses Lack Depth
|
|
|
|
**Problem**: AI gives superficial answers
|
|
**Solutions**:
|
|
- Provide more specific context
|
|
- Ask follow-up questions
|
|
- Request examples or evidence
|
|
- Use full content context for key sources
|
|
|
|
### AI Misunderstands Questions
|
|
|
|
**Problem**: AI doesn't address your actual question
|
|
**Solutions**:
|
|
- Rephrase your question more clearly
|
|
- Provide additional context
|
|
- Break complex questions into smaller parts
|
|
- Reference specific sources or sections
|
|
|
|
### Context Limitations
|
|
|
|
**Problem**: AI doesn't have access to needed information
|
|
**Solutions**:
|
|
- Adjust context settings
|
|
- Add relevant sources to full content context
|
|
- Upload additional sources if needed
|
|
- Provide direct quotes in your messages
|
|
|
|
### High API Costs
|
|
|
|
**Problem**: Chat usage is expensive
|
|
**Solutions**:
|
|
- Use summary context as default
|
|
- Remove unnecessary sources from context
|
|
- Choose more cost-effective models
|
|
- Be more targeted with questions
|
|
|
|
## Model Selection and Configuration
|
|
|
|
### Choosing the Right Model
|
|
|
|
#### For Different Task Types
|
|
|
|
**Research and Analysis**:
|
|
- Claude Sonnet or GPT-4 for deep analysis
|
|
- Gemini Pro for comprehensive understanding
|
|
- Grok for creative insights
|
|
|
|
**Quick Questions**:
|
|
- GPT-5-mini for fast, cost-effective responses
|
|
- Gemini Flash for quick summaries
|
|
- Ollama models for privacy-focused usage
|
|
|
|
**Specialized Tasks**:
|
|
- Use model strengths for specific capabilities
|
|
- Consider language requirements
|
|
- Balance cost with quality needs
|
|
|
|
### Customizing Model Behavior
|
|
|
|
#### Through Context Management
|
|
- Adjust what information the model sees
|
|
- Control the level of detail available
|
|
- Focus on relevant source materials
|
|
|
|
#### Through Question Framing
|
|
- Specify the type of response you want
|
|
- Request specific formats or structures
|
|
- Guide the model's analytical approach
|
|
|
|
## Privacy and Security Considerations
|
|
|
|
### Data Protection
|
|
|
|
#### What Gets Shared
|
|
- Only sources you've explicitly added to context
|
|
- Your chat messages and questions
|
|
- Selected content based on context settings
|
|
|
|
#### What Remains Private
|
|
- Sources set to "Not in Context"
|
|
- Other notebooks and their contents
|
|
- Personal information not explicitly shared
|
|
|
|
### Best Practices for Privacy
|
|
|
|
1. **Review Context Settings**: Regularly audit what's shared
|
|
2. **Sensitive Information**: Keep private data out of context
|
|
3. **Model Selection**: Consider privacy implications of different providers
|
|
4. **Regular Cleanup**: Remove outdated or sensitive conversations
|
|
|
|
## Future Chat Enhancements
|
|
|
|
### Planned Features
|
|
|
|
#### Enhanced Context Management
|
|
- **Smart Context Suggestions**: AI-recommended context settings
|
|
- **Dynamic Context**: Automatic adjustment based on conversation
|
|
- **Context History**: Track how context affected conversations
|
|
|
|
#### Improved Collaboration
|
|
- **Shared Chats**: Collaborate with others on conversations
|
|
- **Chat Templates**: Pre-configured chat setups for common tasks
|
|
- **Workflow Integration**: Connect chats to broader research workflows
|
|
|
|
#### Advanced Analysis
|
|
- **Multi-Modal Support**: Image and video analysis in chat
|
|
- **Real-Time Updates**: Live updates as new sources are added
|
|
- **Predictive Insights**: AI suggestions for research directions
|
|
|
|
## Getting the Most from Chat
|
|
|
|
### Regular Practices
|
|
|
|
1. **Daily Check-ins**: Brief conversations to maintain research momentum
|
|
2. **Weekly Reviews**: Summarize key insights and plan next steps
|
|
3. **Monthly Audits**: Review chat history and extract key learnings
|
|
|
|
### Continuous Improvement
|
|
|
|
- **Experiment with Different Approaches**: Try various questioning styles
|
|
- **Learn from Responses**: Notice what types of questions work best
|
|
- **Share Insights**: Contribute to the community with your discoveries
|
|
|
|
### Integration with Overall Workflow
|
|
|
|
- **Connect to Note-Taking**: Use chat insights to inform your notes
|
|
- **Link to Source Analysis**: Let chat guide your source selection
|
|
- **Support Writing**: Use chat insights in your research outputs
|
|
|
|
## Getting Help and Community
|
|
|
|
### Resources for Chat Support
|
|
|
|
1. **Documentation**: This guide and other help materials
|
|
2. **Community Forum**: [GitHub Discussions](https://github.com/lfnovo/open-notebook/discussions)
|
|
3. **Feature Requests**: Suggest improvements in the discussions
|
|
4. **Bug Reports**: Report issues through GitHub Issues
|
|
|
|
### Sharing Your Experience
|
|
|
|
- **Share Successful Strategies**: Help others learn from your experience
|
|
- **Request Features**: Suggest new chat capabilities
|
|
- **Provide Feedback**: Help improve the chat experience for everyone
|
|
|
|
The chat feature in Open Notebook is designed to be your research partner. With practice and experimentation, you'll develop a conversation style that maximizes the insights you can gain from your research materials. |