Documentation

Knowledge Base Items

How to create, manage, and work with knowledge base items.

Knowledge Base Items are individual documents that you can add to your knowledge bases to provide context for AI-powered question answering.

What are Knowledge Base Items?

A Knowledge Base Item is a document that contains information that can be used to answer questions. These items are stored within knowledge bases and can include:

  • Text documents
  • PDF files
  • Web pages
  • Structured data
  • Code snippets
  • Documentation

Creating Knowledge Base Items

To create a new knowledge base item:

  1. Navigate to your organization's knowledge base settings
  2. Select the knowledge base where you want to add the item
  3. Click "Add Document" or "Create Item"
  4. Choose your input method:
    • Upload File: Upload a document from your computer
    • Paste Text: Copy and paste text content directly
    • URL Import: Import content from a web page
    • Manual Entry: Type or write content directly

Supported File Types

Knowledge Base Items support various file formats:

  • Text files: .txt, .md, .rst
  • Documents: .pdf, .docx, .doc
  • Web content: URLs and web pages
  • Code files: .py, .js, .ts, .java, .cpp, and more
  • Data files: .csv, .json, .xml

Managing Knowledge Base Items

Editing Items

You can edit knowledge base items after they've been created:

  1. Go to the knowledge base containing the item
  2. Find the item in the list
  3. Click the "Edit" button
  4. Make your changes
  5. Save the updated content

Organizing Items

Keep your knowledge base organized by:

  • Using descriptive titles and descriptions
  • Adding tags to categorize items
  • Setting up proper folder structures
  • Regularly reviewing and updating content

Deleting Items

To remove a knowledge base item:

  1. Navigate to the knowledge base
  2. Find the item you want to delete
  3. Click the "Delete" button
  4. Confirm the deletion

Note: Deleting an item is permanent and cannot be undone.

Best Practices

Content Quality

  • Be specific: Include detailed, accurate information
  • Stay current: Regularly update outdated information
  • Use clear language: Write in a way that's easy to understand
  • Include examples: Provide practical examples when possible

Organization

  • Consistent naming: Use clear, descriptive names for your items
  • Logical grouping: Organize related items together
  • Version control: Keep track of important changes
  • Regular maintenance: Periodically review and clean up your items

Security

  • Sensitive information: Be careful not to include confidential data
  • Access control: Ensure only authorized users can view sensitive items
  • Data privacy: Follow your organization's data handling policies

Credits and Pricing

Knowledge Base Items consume credits based on their size and complexity:

  • Text content: Charged per character/token
  • File uploads: Charged based on file size and processing requirements
  • Web imports: Charged for content extraction and processing

The exact credit cost depends on:

  • Document length
  • File format complexity
  • Processing requirements
  • Update frequency

Web URL Crawling

1AiKit supports automatic crawling of web URLs to extract and index content for your knowledge base. This feature allows you to easily add web content without manual copy-pasting.

How Web Crawling Works

When you add a web URL to your knowledge base:

  1. Content Extraction: The system automatically crawls the URL and extracts the main content
  2. Text Processing: The content is cleaned and processed to remove navigation, ads, and other non-essential elements
  3. Indexing: The processed content is indexed and made searchable
  4. Storage: The content is stored as a knowledge base item

Adding Web URLs

To add a web URL to your knowledge base:

  1. Navigate to your knowledge base
  2. Click "Add Document" or "Create Item"
  3. Select "URL Import" or "Web Crawl"
  4. Enter the web URL you want to crawl
  5. Optionally configure crawling settings (see below)
  6. Click "Add to Knowledge Base"

Supported URL Types

The web crawler can handle various types of web content:

  • Blog posts and articles
  • Documentation pages
  • Wiki pages
  • News articles
  • Product pages
  • FAQ pages
  • Technical documentation
  • API documentation

Authentication

For protected content, you can provide optional credentials: