Skip to content
StructHub StructHub
Docs

Getting Started with StructHub

Getting Started with StructHub

Welcome to StructHub! This guide will help you get started with our comprehensive knowledge management and RAG (Retrieval-Augmented Generation) platform. Follow these steps to begin building your intelligent knowledge base.

Table of Contents

Account Setup

1. Sign Up

Create your free StructHub account:

  1. Visit StructHub.io
  2. Click “Sign Up” and enter your email address
  3. Choose a secure password
  4. Accept the terms of service and privacy policy
  5. Click “Create Account”

2. Email Verification

After registration, you’ll receive an email verification link:

  1. Check your email inbox (and spam folder)
  2. Click the verification link in the email
  3. Your account will be activated and ready to use

3. First Login

  1. Return to StructHub.io
  2. Click “Sign In” and enter your credentials
  3. You’ll be redirected to your dashboard

Creating Your First Project

Project Basics

Projects are the foundation of StructHub - they contain your documents, data sources, and AI conversations.

Creating a Project

  1. Navigate to Projects - Click on “Projects” in the sidebar
  2. Create New Project - Click “Create New Project”
  3. Project Details:
    • Name: Choose a descriptive name (e.g., “Company Knowledge Base”)
    • Description: Add a brief description of the project’s purpose
  4. Click “Create” - Your project is now ready!

Project Settings

Configure your project for optimal performance:

  1. Basic Settings:

    • Update name and description as needed
    • Set project visibility (private by default)

  2. Advanced Settings:

    • LLM Model: Powered by Google’s Gemini 2.5 model
    • Search TopK: Set to 50 for balanced performance
    • Token Limit: Set to 100,000 for comprehensive responses
    • Web Search: Enable for hybrid search capabilities

  3. Metadata Configuration:

    • Auto-tagging: Enable automatic metadata extraction
    • Custom Metadata: Define custom fields for your documents
    • Metadata Prompts: Configure AI prompts for metadata generation

Connecting Data Sources

Choose Your Integration

StructHub supports multiple data sources. Choose the ones that match your needs:

Cloud Storage

Google Drive:

  1. Click “Connect Data Source” → “Google Drive”
  2. Authenticate with your Google account
  3. Select folders to sync
  4. Configure sync schedule (hourly recommended)

OneDrive:

  1. Click “Connect Data Source” → “OneDrive”
  2. Sign in with your Microsoft account
  3. Choose folders to sync
  4. Set sync preferences

SharePoint:

  1. Click “Connect Data Source” → “SharePoint”
  2. Authenticate with Microsoft/Azure
  3. Select SharePoint sites and libraries
  4. Configure sync settings

Enterprise Systems

Confluence:

  1. Click “Connect Data Source” → “Confluence”
  2. Enter your Confluence URL
  3. Provide authentication credentials
  4. Select spaces to sync

ServiceNow:

  1. Click “Connect Data Source” → “ServiceNow”
  2. Enter your ServiceNow instance URL
  3. Authenticate with OAuth 2.0
  4. Select content types:
    • Knowledge Articles
    • Service Catalog Items
    • ITSM Incidents
    • APM Applications

File Upload

For immediate testing or one-time documents:

  1. Navigate to “Data” section
  2. Click “Upload Files” or drag and drop
  3. Select files from your computer (30+ formats supported)
  4. Files are automatically processed and indexed

Sync Configuration

Recommended Settings:

  • Sync Frequency: Hourly for active environments
  • Sync Type: Incremental (only new/changed files)
  • File Types: All supported formats
  • Folder Structure: Maintain original hierarchy

Chatting with Your Data

Starting Your First Chat

  1. Select Project - Choose your project from the sidebar
  2. Navigate to Chat - Click on “Chat” or “AI Hub”
  3. Start New Thread - Click “New Chat”
  4. Ask Your First Question - Type a question about your documents

Example Questions

General Questions:

  • “What are our company policies on remote work?”
  • “Summarize the latest product updates”
  • “What are the key points from the Q3 financial report?”

Specific Queries:

  • “What’s the procedure for expense reporting?”
  • “How do we handle customer complaints?”
  • “What are the security requirements for new software?”

Analytical Questions:

  • “Compare our Q2 and Q3 performance metrics”
  • “What are the common themes in customer feedback?”
  • “Analyze the trends in our support tickets”

Understanding Responses

AI Response Components:

  • Answer: Direct response to your question
  • Sources: Documents and pages referenced
  • Citations: Specific page numbers and file names
  • Follow-up Questions: AI-suggested related questions

Source Attribution:

  • Click on source citations to view original documents
  • Page numbers help you find exact information
  • Multiple sources indicate comprehensive coverage

Chat Features

During Conversation:

  • Streaming: Watch responses generate in real-time
  • Copy Text: Copy answers for use elsewhere
  • Export: Save conversations as PDF
  • New Thread: Start fresh topics in new threads

Managing Conversations:

  • Thread History: Access all past conversations
  • Thread Naming: Rename threads for better organization
  • Thread Search: Find specific conversations quickly
  • Thread Deletion: Remove unwanted conversations

Team Collaboration

Adding Team Members

  1. Project Settings - Navigate to your project settings
  2. Team Members - Click on “Members” tab
  3. Add Member - Click “Add Member”
  4. Enter Email - Provide team member’s email address
  5. Choose Role:
    • Owner: Full project control
    • Admin: Management capabilities
    • Member: Access and participation
  6. Send Invitation - Member receives email invitation

Collaboration Features

Shared Access:

  • All team members can access project documents
  • Chat threads are visible to all members
  • Collaborative learning from each other’s questions

Role-Based Permissions:

  • Owners: Can modify project settings and manage members
  • Admins: Can manage data sources and configurations
  • Members: Can chat and access information

Team Best Practices

  • Naming Conventions: Use clear, descriptive names for projects and threads
  • Question Sharing: Share useful questions and answers with the team
  • Regular Updates: Keep data sources synced and current
  • Credit Management: Monitor team usage and allocate credits appropriately

Understanding Credits

Free Tier Benefits

Generous Free Usage:

  • 2,000 credits per month - Substantial free usage
  • Credit rollover - Unused credits carry over to next month
  • Full feature access - All features available on free tier
  • No time limits - Use free tier indefinitely

How Credits Work

Credit Consumption:

  • 1 credit = 1 page processed - Simple, transparent pricing
  • Document Processing: Credits used when documents are processed
  • AI Chat: Credits used for AI responses (varies by model)
  • Real-time Usage: Monitor credit consumption in dashboard

Credit Management:

  • Usage Dashboard: Track credit consumption by project
  • Usage Alerts: Get notified when approaching limits
  • Project Allocation: Allocate credits to specific projects
  • Team Usage: Monitor team member usage

Optimizing Credit Usage

Efficient Practices:

  • Batch Processing: Upload multiple files at once
  • Incremental Sync: Only sync new or changed files
  • Smart Questioning: Ask comprehensive questions to get more information per query
  • Optimize Settings: Configure Gemini 2.5 model parameters for your needs

Next Steps

Explore Advanced Features

Once you’re comfortable with the basics:

  1. Advanced Chat Features:

    • Configure search parameters (TopK, token limits)
    • Enable web search for hybrid responses
    • Optimize Gemini 2.5 model settings
    • Use conversation export and sharing

  2. Data Source Optimization:

    • Set up multiple data sources
    • Configure metadata extraction
    • Optimize sync schedules
    • Monitor data source health

  3. API Integration:

    • Generate API keys for your projects
    • Use the Document Processing API
    • Integrate Knowledge Base Search API
    • Build custom applications

Get More Help

Resources:

  • Documentation: Comprehensive guides and tutorials
  • API Reference: Complete API documentation
  • Community: Join user forums and discussions
  • Support: Contact support for assistance

Common Next Steps:

  1. Connect Additional Data Sources - Centralize more of your knowledge
  2. Invite Team Members - Enable collaborative knowledge management
  3. Explore API Features - Build custom integrations
  4. Set up Workflows - Create efficient knowledge management processes

Best Practices for Success

Document Organization:

  • Clear Structure: Organize documents logically
  • Consistent Naming: Use consistent file naming conventions
  • Regular Updates: Keep documents current and relevant
  • Quality Control: Ensure document quality and accuracy

Effective Usage:

  • Start Simple: Begin with basic questions and gradually explore advanced features
  • Regular Interaction: Use the system regularly to build familiarity
  • Team Training: Ensure all team members understand the platform
  • Feedback Loop: Provide feedback to improve the system

Quick Start Checklist

✅ Account created and verified ✅ First project created ✅ Data source connected ✅ First chat completed ✅ Team members invited (if applicable) ✅ Credits and usage understood

Ready to unlock your knowledge? You now have everything you need to start building a powerful, intelligent knowledge base with StructHub!

For additional help, visit our documentation or contact support.