Base code

This commit is contained in:
Kunthawat Greethong
2026-01-08 22:39:53 +07:00
parent 697115c61a
commit c35fa52117
2169 changed files with 626670 additions and 0 deletions

View File

@@ -0,0 +1,379 @@
# Assistive Writing
ALwrity's Assistive Writing feature revolutionizes content creation by providing AI-powered writing assistance that helps you create high-quality, engaging content with minimal effort. This intelligent writing companion understands context, maintains consistency, and adapts to your unique writing style.
## Visuals
<p align="center">
<img src="../../assests/assistive-1.png" alt="Assistive writing selection tools" width="45%">
<img src="../../assests/assistive-2.png" alt="Inline fact checking and quick edits" width="45%">
</p>
## Quick Reference
1. Enable: Toggle “Assistive Writing” in the LinkedIn Writer header
2. Write: Type at least 5 words
3. Wait: 5 seconds for the first automatic suggestion
4. Accept/Dismiss: Use buttons in the suggestion card
### How It Works
- First suggestion: Automatic (5 words + 5 seconds)
- More suggestions: Click “Continue writing”
- Daily limit: 50 suggestions (resets every 24 hours)
### Best Practices
- Write specific, clear content
- Review source links before accepting
- Use manual “Continue writing” for additional suggestions
- Dont expect suggestions for very short text
- Dont ignore source verification
### Common Issues (Quick Table)
| Problem | Solution |
| --- | --- |
| No suggestions | Write 5+ words, then wait 5 seconds |
| “API quota exceeded” | Wait 24 hours or upgrade plan |
| “No relevant sources” | Be more specific in your writing |
| Suggestions not relevant | Try different wording or topics |
## What is Assistive Writing?
Assistive Writing is an AI-powered feature that provides real-time writing assistance, suggestions, and enhancements to help you create compelling content. It combines advanced natural language processing with contextual understanding to offer intelligent recommendations that improve your writing quality and efficiency.
### Key Capabilities
- **Real-time Suggestions**: Instant writing recommendations as you type
- **Style Consistency**: Maintains your brand voice and writing style
- **Grammar and Style**: Advanced grammar checking and style improvements
- **Content Enhancement**: Suggestions for better engagement and clarity
- **Context Awareness**: Understands your content goals and audience
## Core Features
### Intelligent Writing Assistance
#### Real-Time Suggestions
- **Word Choice**: Suggest better vocabulary and phrasing
- **Sentence Structure**: Improve sentence flow and readability
- **Tone Adjustment**: Modify tone to match your brand voice
- **Clarity Enhancement**: Make complex ideas more accessible
- **Engagement Optimization**: Increase reader engagement
#### Style Consistency
- **Brand Voice**: Maintain consistent brand personality
- **Writing Style**: Adapt to your preferred writing style
- **Format Consistency**: Ensure consistent formatting and structure
- **Terminology**: Use consistent industry terminology
- **Tone Matching**: Match tone across all content pieces
### Content Enhancement
#### Readability Improvement
- **Sentence Length**: Optimize sentence length for readability
- **Paragraph Structure**: Improve paragraph organization
- **Transition Words**: Add smooth transitions between ideas
- **Active Voice**: Convert passive voice to active voice
- **Clarity**: Make content more clear and understandable
#### Engagement Optimization
- **Hook Creation**: Craft compelling opening sentences
- **Call-to-Action**: Suggest effective CTAs
- **Storytelling**: Enhance narrative elements
- **Emotional Appeal**: Add emotional resonance
- **Reader Connection**: Build stronger reader relationships
### Grammar and Language
#### Advanced Grammar Checking
- **Grammar Rules**: Check for grammatical errors
- **Punctuation**: Correct punctuation usage
- **Spelling**: Identify and correct spelling mistakes
- **Syntax**: Improve sentence structure
- **Style Issues**: Address style and clarity problems
#### Language Enhancement
- **Vocabulary**: Suggest more precise word choices
- **Conciseness**: Eliminate unnecessary words
- **Variety**: Add sentence and word variety
- **Flow**: Improve overall content flow
- **Impact**: Increase content impact and memorability
## Writing Modes
### Content Types
#### Blog Writing
- **Article Structure**: Optimize article organization
- **SEO Integration**: Incorporate SEO best practices
- **Readability**: Ensure blog-friendly readability
- **Engagement**: Increase reader engagement
- **Call-to-Action**: Add effective CTAs
#### Social Media
- **Platform Optimization**: Adapt content for each platform
- **Character Limits**: Work within platform constraints
- **Hashtag Integration**: Suggest relevant hashtags
- **Engagement Tactics**: Increase social engagement
- **Visual Elements**: Coordinate with visual content
#### Email Marketing
- **Subject Lines**: Craft compelling subject lines
- **Email Body**: Optimize email content
- **Personalization**: Add personalization elements
- **CTA Placement**: Optimize call-to-action placement
- **Mobile Optimization**: Ensure mobile-friendly content
#### Professional Writing
- **Business Communication**: Professional tone and style
- **Report Writing**: Structured and analytical content
- **Proposal Writing**: Persuasive and compelling proposals
- **Presentation Content**: Clear and engaging presentation text
- **Documentation**: Technical and user-friendly documentation
### Writing Styles
#### Conversational
- **Casual Tone**: Friendly and approachable language
- **Personal Pronouns**: Use "you" and "we" appropriately
- **Questions**: Include engaging questions
- **Stories**: Incorporate personal anecdotes
- **Humor**: Add appropriate humor and personality
#### Professional
- **Formal Tone**: Professional and authoritative language
- **Industry Terms**: Use appropriate technical terminology
- **Data-Driven**: Support claims with evidence
- **Structured**: Clear organization and flow
- **Credible**: Establish authority and expertise
#### Creative
- **Imaginative**: Creative and original language
- **Metaphors**: Use effective metaphors and analogies
- **Descriptive**: Rich and vivid descriptions
- **Emotional**: Evoke emotions and feelings
- **Unique**: Stand out with original content
## AI-Powered Features
### Context Understanding
#### Content Analysis
- **Topic Recognition**: Understand content subject matter
- **Audience Analysis**: Adapt to target audience needs
- **Purpose Identification**: Recognize content goals
- **Tone Matching**: Match appropriate tone for context
- **Style Adaptation**: Adapt to content requirements
#### Intent Recognition
- **Informational**: Educational and informative content
- **Persuasive**: Convincing and compelling content
- **Entertaining**: Engaging and enjoyable content
- **Transactional**: Action-oriented content
- **Relationship Building**: Community and connection content
### Learning and Adaptation
#### Personal Style Learning
- **Writing Patterns**: Learn your writing patterns
- **Preference Recognition**: Understand your preferences
- **Style Evolution**: Adapt to style changes
- **Feedback Integration**: Learn from your corrections
- **Consistency Maintenance**: Maintain style consistency
#### Brand Voice Adaptation
- **Brand Personality**: Understand brand characteristics
- **Voice Consistency**: Maintain brand voice across content
- **Tone Matching**: Match brand tone requirements
- **Message Alignment**: Align with brand messaging
- **Value Integration**: Incorporate brand values
## Workflow
```text
1. ENABLE ASSISTIVE WRITING
┌─────────────────────────┐
│ Toggle "Assistive │
│ Writing" ON (blue) │
└─────────────────────────┘
2. START WRITING
┌─────────────────────────┐
│ Type at least 5 words │
│ in the text area │
└─────────────────────────┘
3. WAIT FOR AI ANALYSIS
┌─────────────────────────┐
│ Wait 5 seconds │
│ AI analyzes your text │
└─────────────────────────┘
4. RECEIVE FIRST SUGGESTION
┌─────────────────────────┐
│ Suggestion card appears │
│ near your cursor │
│ │
│ [Accept] [Dismiss] │
└─────────────────────────┘
5. AFTER FIRST SUGGESTION
┌─────────────────────────┐
│ "Continue writing" │
│ prompt appears │
│ │
│ [Continue writing] │
│ [Dismiss] │
└─────────────────────────┘
6. MANUAL SUGGESTIONS
┌─────────────────────────┐
│ Click "Continue writing"│
│ to get more suggestions │
│ (saves costs) │
└─────────────────────────┘
```
### Step-by-Step
- Enable → Start writing (5+ words) → Wait 5s
- First suggestion shows: suggested text, confidence score, source links, Accept/Dismiss
- After first suggestion, trigger more via “Continue writing”
## Integration with Other Features
### Blog Writer Integration
- **Content Creation**: Assist in blog post creation
- **SEO Optimization**: Integrate SEO best practices
- **Research Integration**: Use research data for better content
- **Performance Optimization**: Optimize for engagement
- **Quality Assurance**: Ensure high content quality
### SEO Dashboard Integration
- **Keyword Integration**: Naturally incorporate keywords
- **Readability Optimization**: Improve SEO readability scores
- **Meta Content**: Optimize meta descriptions and titles
- **Internal Linking**: Suggest relevant internal links
- **Content Structure**: Optimize for search engines
### Content Strategy Integration
- **Persona Alignment**: Align content with target personas
- **Goal Support**: Support content marketing goals
- **Brand Consistency**: Maintain brand consistency
- **Message Alignment**: Align with strategic messaging
- **Performance Optimization**: Optimize for performance
## Best Practices
### Effective Usage
#### Writing Process
1. **Start with Outline**: Create content structure first
2. **Use Suggestions**: Accept helpful AI suggestions
3. **Maintain Voice**: Keep your unique writing voice
4. **Review Changes**: Review all AI suggestions
5. **Final Polish**: Add final personal touches
#### Quality Control
1. **Review Suggestions**: Evaluate all AI recommendations
2. **Maintain Authenticity**: Keep content authentic
3. **Check Facts**: Verify all factual information
4. **Test Readability**: Ensure content is readable
5. **Proofread**: Final proofreading and editing
### Optimization Tips
#### Content Enhancement
- **Use Varied Suggestions**: Try different AI suggestions
- **Experiment with Tone**: Test different tones
- **Improve Flow**: Focus on content flow and transitions
- **Enhance Engagement**: Use engagement optimization features
- **Maintain Consistency**: Keep style consistent throughout
#### Performance Improvement
- **Track Changes**: Monitor content performance changes
- **A/B Test**: Test different writing approaches
- **Gather Feedback**: Collect reader feedback
- **Analyze Results**: Review performance analytics
- **Iterate**: Continuously improve based on results
## Advanced Features
### Customization Options
#### Style Preferences
- **Writing Style**: Set preferred writing style
- **Tone Preferences**: Define tone requirements
- **Vocabulary Level**: Set appropriate vocabulary level
- **Formality Level**: Choose formality level
- **Industry Terms**: Include industry-specific terminology
#### Brand Settings
- **Brand Voice**: Define brand personality
- **Message Guidelines**: Set messaging requirements
- **Tone Guidelines**: Establish tone standards
- **Style Guide**: Implement brand style guide
- **Quality Standards**: Set quality benchmarks
### Collaboration Features
#### Team Writing
- **Shared Styles**: Maintain team writing consistency
- **Brand Guidelines**: Enforce brand guidelines
- **Quality Standards**: Maintain quality standards
- **Review Process**: Facilitate content review
- **Approval Workflow**: Streamline approval process
#### Feedback Integration
- **Suggestion Review**: Review and accept suggestions
- **Feedback Learning**: Learn from user feedback
- **Improvement Tracking**: Track writing improvements
- **Performance Metrics**: Monitor writing performance
- **Skill Development**: Support writing skill development
## Troubleshooting
### Common Issues
#### Suggestion Quality
- **Irrelevant Suggestions**: Adjust context and settings
- **Style Mismatch**: Update style preferences
- **Tone Issues**: Refine tone requirements
- **Over-Suggestions**: Adjust suggestion frequency
- **Under-Suggestions**: Increase suggestion sensitivity
#### Performance Issues
- **Slow Response**: Check internet connection
- **Inconsistent Results**: Review settings and preferences
- **Learning Problems**: Provide more feedback
- **Integration Issues**: Check feature integrations
- **Quality Concerns**: Review and adjust settings
### Getting Help
#### Support Resources
- **Documentation**: Review feature documentation
- **Tutorials**: Watch feature tutorials
- **Best Practices**: Follow best practice guides
- **Community**: Join user community
- **Support**: Contact technical support
#### Optimization Tips
- **Settings Review**: Regularly review settings
- **Feedback Provision**: Provide regular feedback
- **Usage Patterns**: Analyze usage patterns
- **Performance Monitoring**: Monitor performance metrics
- **Continuous Learning**: Keep learning and improving
---
*Ready to enhance your writing with AI assistance? [Start with our First Steps Guide](../../getting-started/first-steps.md) and [Explore Blog Writer Features](../blog-writer/overview.md) to begin creating amazing content with assistive writing!*

View File

@@ -0,0 +1,334 @@
# Grounding UI
ALwrity's Grounding UI feature provides AI-powered content verification and fact-checking capabilities, ensuring your content is accurate, reliable, and trustworthy. This advanced feature helps maintain content credibility by grounding AI-generated content in verified information sources.
## Visuals
<p align="center">
<img src="../../assests/assistive-2.png" alt="Inline fact checking with citations and claim statuses" width="60%">
</p>
## What is Grounding UI?
Grounding UI is an intelligent content verification system that connects AI-generated content with real-world data sources, ensuring accuracy and reliability. It provides visual indicators, source citations, and verification status to help you create trustworthy, fact-checked content.
## Implementation Overview (Concise)
- Backend service: `backend/services/hallucination_detector.py` (claim extraction → evidence search → verification)
- Models: `backend/models/hallucination_models.py`
- API router: `backend/api/hallucination_detector.py` (registered in `backend/app.py`)
- Frontend service: `frontend/src/services/hallucinationDetectorService.ts`
- UI: LinkedIn Writer selection menu + FactCheckResults modal
### API Endpoints (Summary)
- `POST /api/hallucination-detector/detect` main fact-checking
- `POST /api/hallucination-detector/extract-claims` claims only
- `POST /api/hallucination-detector/verify-claim` single claim
- `GET /api/hallucination-detector/health` health check
### Minimal Setup
- Backend env:
- `EXA_API_KEY=...` (evidence search)
- `OPENAI_API_KEY=...` (claim extraction + verification)
- Frontend env:
- `REACT_APP_API_URL=http://localhost:8000`
### Quick Usage (UI)
1) In LinkedIn Writer, select a passage (10+ chars)
2) Click “Check Facts” in the selection menu
3) Review claims, assessments (supported/refuted/insufficient), confidence, and sources in the results modal
### Quick Usage (API)
```bash
curl -X POST "$API_URL/api/hallucination-detector/detect" \
-H "Content-Type: application/json" \
-d '{"text":"The Eiffel Tower is in Paris and built in 1889.","include_sources":true,"max_claims":5}'
```
### Key Benefits
- **Content Verification**: Verify facts and claims in real-time
- **Source Attribution**: Provide proper source citations
- **Credibility Enhancement**: Build trust with accurate content
- **Risk Mitigation**: Reduce misinformation and false claims
- **Quality Assurance**: Ensure content meets high standards
## Core Features
### Real-Time Fact Checking
#### Information Verification
- **Fact Validation**: Verify factual claims against reliable sources
- **Data Accuracy**: Check statistics and numerical data
- **Source Reliability**: Assess source credibility and authority
- **Claim Verification**: Validate specific claims and statements
- **Trend Analysis**: Verify current trends and developments
#### Source Integration
- **Multiple Sources**: Cross-reference information from multiple sources
- **Source Diversity**: Include various types of sources
- **Authority Assessment**: Evaluate source authority and expertise
- **Recency Check**: Ensure information is current and up-to-date
- **Bias Detection**: Identify potential bias in sources
### Visual Grounding Indicators
#### Verification Status
- **Verified**: Green indicators for verified information
- **Unverified**: Yellow indicators for unverified claims
- **Disputed**: Red indicators for disputed information
- **Outdated**: Orange indicators for outdated information
- **Source Missing**: Gray indicators for missing sources
#### Source Citations
- **Inline Citations**: Source links within content
- **Reference Lists**: Comprehensive reference sections
- **Source Types**: Different icons for different source types
- **Credibility Scores**: Visual credibility indicators
- **Last Updated**: Timestamp of last verification
### Content Enhancement
#### Accuracy Improvement
- **Fact Correction**: Suggest corrections for inaccurate information
- **Source Addition**: Recommend additional sources
- **Clarification**: Suggest clarifications for ambiguous content
- **Update Recommendations**: Suggest updates for outdated information
- **Bias Reduction**: Identify and suggest bias reduction
#### Trust Building
- **Transparency**: Show verification process and sources
- **Credibility Indicators**: Display content credibility scores
- **Expert Validation**: Highlight expert-reviewed content
- **Peer Review**: Show peer review status
- **Quality Metrics**: Display content quality indicators
## Integration with Research
### Web Research Integration
#### Real-Time Research
- **Live Data**: Access current information from web sources
- **Trend Monitoring**: Track real-time trends and developments
- **News Integration**: Include latest news and updates
- **Market Data**: Access current market information
- **Social Media**: Monitor social media discussions
#### Source Verification
- **Domain Authority**: Check website authority and credibility
- **Content Freshness**: Verify content recency
- **Author Credibility**: Assess author expertise and credentials
- **Publication Standards**: Evaluate publication quality
- **Fact-Checking Organizations**: Cross-reference with fact-checkers
### Database Integration
#### Knowledge Base
- **Internal Database**: Access internal knowledge base
- **Historical Data**: Reference historical information
- **Expert Knowledge**: Include expert-curated information
- **Industry Standards**: Reference industry best practices
- **Regulatory Information**: Include regulatory and compliance data
#### External Databases
- **Academic Sources**: Access academic and research databases
- **Government Data**: Include government and official sources
- **Industry Reports**: Reference industry research and reports
- **Statistical Databases**: Access statistical and data sources
- **News Archives**: Search historical news and information
## User Interface Features
### Visual Indicators
#### Status Icons
- **Checkmark**: Verified and accurate information
- **Warning**: Unverified or potentially inaccurate
- **Exclamation**: Disputed or controversial information
- **Clock**: Outdated or time-sensitive information
- **Question**: Missing or unclear information
#### Color Coding
- **Green**: Verified and reliable information
- **Yellow**: Requires verification or attention
- **Red**: Disputed or inaccurate information
- **Blue**: Source information and citations
- **Gray**: Neutral or informational content
### Interactive Elements
#### Hover Information
- **Source Details**: Show source information on hover
- **Verification Status**: Display verification details
- **Last Updated**: Show last verification timestamp
- **Credibility Score**: Display source credibility rating
- **Related Sources**: Show related source information
#### Click Actions
- **Source Links**: Direct links to source materials
- **Verification Details**: Detailed verification information
- **Source Analysis**: In-depth source analysis
- **Fact-Checking Reports**: Access to fact-checking reports
- **Update Requests**: Request content updates
## Content Types and Applications
### Blog Content
#### Fact-Checking
- **Statistical Claims**: Verify statistics and data
- **Historical Facts**: Check historical information
- **Expert Quotes**: Verify expert statements
- **Research Findings**: Validate research claims
- **Trend Analysis**: Verify trend information
#### Source Attribution
- **Research Citations**: Proper research citations
- **Expert References**: Expert opinion attribution
- **Data Sources**: Statistical data attribution
- **News References**: News and media citations
- **Industry Sources**: Industry-specific references
### Social Media Content
#### Quick Verification
- **Fact Checking**: Rapid fact verification
- **Source Links**: Quick access to sources
- **Credibility Indicators**: Visual credibility markers
- **Update Alerts**: Notifications for outdated information
- **Bias Warnings**: Bias detection and warnings
#### Engagement Enhancement
- **Trust Building**: Build audience trust
- **Transparency**: Show verification process
- **Credibility**: Enhance content credibility
- **Authority**: Establish thought leadership
- **Reliability**: Demonstrate content reliability
### Professional Content
#### Business Communications
- **Market Data**: Verify market information
- **Financial Data**: Check financial statistics
- **Regulatory Information**: Verify compliance data
- **Industry Standards**: Reference industry standards
- **Best Practices**: Validate best practice claims
#### Research and Analysis
- **Data Validation**: Verify research data
- **Methodology Review**: Check research methods
- **Source Evaluation**: Assess source quality
- **Bias Assessment**: Identify potential bias
- **Quality Assurance**: Ensure research quality
## Best Practices
### Content Creation
#### Verification Process
1. **Enable Grounding**: Activate grounding features
2. **Review Indicators**: Check verification status
3. **Verify Claims**: Ensure all claims are verified
4. **Add Sources**: Include proper source citations
5. **Update Regularly**: Keep information current
#### Quality Standards
1. **Source Diversity**: Use multiple source types
2. **Authority Sources**: Prioritize authoritative sources
3. **Current Information**: Ensure information is current
4. **Bias Awareness**: Be aware of potential bias
5. **Transparency**: Show verification process
### Source Management
#### Source Selection
- **Authority**: Choose authoritative sources
- **Recency**: Prefer recent information
- **Relevance**: Ensure source relevance
- **Diversity**: Include diverse perspectives
- **Credibility**: Verify source credibility
#### Citation Standards
- **Proper Attribution**: Give proper credit
- **Link Accessibility**: Ensure links work
- **Source Description**: Describe source context
- **Date Information**: Include publication dates
- **Author Information**: Include author details
## Advanced Features
### Customization Options
#### Verification Settings
- **Source Preferences**: Set preferred source types
- **Credibility Thresholds**: Define credibility standards
- **Update Frequency**: Set verification update frequency
- **Bias Sensitivity**: Adjust bias detection sensitivity
- **Quality Standards**: Set quality requirements
#### Display Options
- **Indicator Style**: Customize visual indicators
- **Color Schemes**: Choose color coding schemes
- **Information Density**: Adjust information display
- **Hover Details**: Customize hover information
- **Click Actions**: Set click action preferences
### Integration Features
#### API Integration
- **External APIs**: Connect to external data sources
- **Custom Databases**: Integrate custom databases
- **Real-Time Data**: Access real-time information
- **Automated Updates**: Enable automatic updates
- **Custom Sources**: Add custom source types
#### Workflow Integration
- **Content Review**: Integrate with content review process
- **Quality Gates**: Set quality checkpoints
- **Approval Workflow**: Include in approval process
- **Publishing Pipeline**: Integrate with publishing workflow
- **Performance Tracking**: Track verification performance
## Troubleshooting
### Common Issues
#### Verification Problems
- **Source Unavailable**: Handle unavailable sources
- **Outdated Information**: Manage outdated content
- **Bias Detection**: Address bias concerns
- **Credibility Issues**: Resolve credibility problems
- **Update Delays**: Manage update delays
#### Technical Issues
- **API Connectivity**: Resolve API connection issues
- **Data Synchronization**: Fix data sync problems
- **Performance Issues**: Address performance concerns
- **Display Problems**: Fix visual indicator issues
- **Integration Errors**: Resolve integration problems
### Environment & Health
- “EXA_API_KEY not found” → add key to backend `.env`, restart server
- “OpenAI API key not found” → add `OPENAI_API_KEY`, verify credits
- Health check: `GET /api/hallucination-detector/health`
### Getting Help
#### Support Resources
- **Documentation**: Review feature documentation
- **Tutorials**: Watch grounding UI tutorials
- **Best Practices**: Follow best practice guides
- **Community**: Join user community discussions
- **Support**: Contact technical support
#### Optimization Tips
- **Settings Review**: Regularly review settings
- **Source Management**: Maintain source quality
- **Update Monitoring**: Monitor update status
- **Performance Tracking**: Track verification performance
- **Continuous Improvement**: Continuously improve process
---
*Ready to enhance your content credibility with grounding UI? [Start with our First Steps Guide](../../getting-started/first-steps.md) and [Explore Blog Writer Features](../blog-writer/overview.md) to begin creating verified, trustworthy content!*