Skip to content

Add documentation for AI Assistant PDF upload feature #757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 257 additions & 0 deletions advanced/dashboard/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,257 @@
---
title: "Dashboard Settings"
description: "Configure your dashboard settings and AI Assistant features for optimal performance"
---

## Introduction to Dashboard Settings

The Dashboard Settings panel provides comprehensive control over your workspace configuration, including advanced AI Assistant features, user preferences, and system integrations. Access your settings by clicking the gear icon in the top-right corner of your dashboard.

<Card>
<CardHeader>
<CardTitle>Quick Access</CardTitle>
</CardHeader>
<CardBody>
Navigate to **Settings** → **Dashboard** to access all configuration options
</CardBody>
</Card>

## AI Assistant Configuration

Configure your AI Assistant to maximize productivity and accuracy across your documentation workflow.

### Basic Configuration

1. **Assistant Name**: Customize your AI Assistant's display name
2. **Response Style**: Choose between concise, detailed, or balanced responses
3. **Language Preferences**: Set primary and secondary language options
4. **Context Window**: Adjust how much conversation history the assistant retains

```json
{
"assistant_config": {
"name": "Documentation Assistant",
"response_style": "detailed",
"language": "en-US",
"context_window": 4096

Check warning on line 36 in advanced/dashboard/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/settings.mdx#L36

Did you really mean 'context_window'?
}
}
```

### Advanced Settings

<AccordionGroup>
<Accordion title="Model Selection">
Choose from available AI models based on your specific needs:
- **GPT-4**: Best for complex reasoning and detailed analysis
- **GPT-3.5 Turbo**: Faster responses for general queries
- **Claude**: Excellent for document analysis and summarization
</Accordion>

<Accordion title="Custom Instructions">
Add specific instructions to guide your AI Assistant's behavior:
```
Always provide code examples when explaining technical concepts.
Include relevant links to documentation when available.
Format responses using markdown for better readability.
```
</Accordion>
</AccordionGroup>

## PDF Upload Feature

<Info>
**New Feature**: The PDF Upload feature allows you to enhance your AI Assistant with custom reference materials, making it more knowledgeable about your specific documentation and processes.
</Info>

### Overview

The PDF Upload feature enables you to upload reference documents that your AI Assistant can use to provide more accurate and contextually relevant responses. This is particularly useful for:

- Internal documentation and procedures
- Technical specifications and standards
- Style guides and writing standards
- Product documentation and user manuals

### How to Upload PDFs

1. **Access Upload Interface**
- Navigate to **Settings** → **AI Assistant** → **Knowledge Base**
- Click the **Upload PDF** button

2. **Select Your Files**
```bash
Supported formats: PDF
Maximum file size: 50MB per file
Maximum total storage: 500MB
```

3. **Configure Upload Settings**
- **Document Title**: Provide a descriptive name
- **Category**: Organize by type (e.g., "Style Guide", "API Docs")
- **Priority Level**: Set importance for reference weighting
- **Access Level**: Define who can reference this document

<Warning>
Ensure your PDFs contain searchable text. Scanned documents without OCR may not be properly indexed.

Check warning on line 96 in advanced/dashboard/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/settings.mdx#L96

Did you really mean 'PDFs'?
</Warning>

### Processing and Indexing

Once uploaded, your PDFs undergo automatic processing:

Check warning on line 101 in advanced/dashboard/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/settings.mdx#L101

Did you really mean 'PDFs'?

1. **Text Extraction**: Content is extracted and cleaned
2. **Semantic Indexing**: Documents are analyzed for key concepts
3. **Cross-Referencing**: Links between documents are established
4. **Quality Validation**: Content quality is assessed

<Frame>
<img src="/images/pdf-processing-flow.png" alt="PDF Processing Workflow" />
</Frame>

### Managing Uploaded Documents

#### Document Library

View and manage all uploaded PDFs in the Knowledge Base library:

Check warning on line 116 in advanced/dashboard/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/settings.mdx#L116

Did you really mean 'PDFs'?

- **Search**: Find documents by title, content, or tags
- **Filter**: Sort by category, upload date, or usage frequency
- **Preview**: Quick preview of document content
- **Analytics**: View usage statistics and effectiveness metrics

#### Document Actions

<CardGroup cols={2}>
<Card title="Edit Metadata" icon="edit">
Update document titles, categories, and descriptions
</Card>
<Card title="Version Control" icon="code-branch">
Upload new versions while maintaining reference history
</Card>
<Card title="Access Control" icon="lock">
Manage who can view and reference specific documents
</Card>
<Card title="Delete Documents" icon="trash">
Remove outdated or irrelevant reference materials
</Card>
</CardGroup>

## Best Practices for PDF References

### Document Preparation

<Steps>
<Step title="Optimize Content Structure">
Ensure your PDFs have clear headings, consistent formatting, and logical organization

Check warning on line 146 in advanced/dashboard/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/settings.mdx#L146

Did you really mean 'PDFs'?
</Step>
<Step title="Include Metadata">
Add relevant titles, authors, and descriptions to improve searchability

Check warning on line 149 in advanced/dashboard/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/settings.mdx#L149

Did you really mean 'searchability'?
</Step>
<Step title="Regular Updates">
Keep documents current by uploading new versions when information changes
</Step>
<Step title="Quality Control">
Review documents for accuracy and completeness before uploading
</Step>
</Steps>

### Naming Conventions

Use consistent naming patterns for better organization:

```
[Category]_[Topic]_[Version]_[Date].pdf

Examples:
- StyleGuide_Writing_v2.1_2024.pdf
- API_Authentication_v1.0_Jan2024.pdf
- Procedures_Deployment_v3.2_2024.pdf
```

### Content Guidelines

<Tip>
**Pro Tip**: Documents with clear structure, bullet points, and examples work best with the AI Assistant's processing algorithms.
</Tip>

- **Use clear headings** (H1, H2, H3) for better content parsing
- **Include examples** and code snippets where applicable
- **Add cross-references** to related documents
- **Maintain consistent terminology** across all documents

### Categorization Strategy

Organize your documents into logical categories:

| Category | Description | Example Documents |
|----------|-------------|-------------------|
| Style Guides | Writing and formatting standards | Brand guidelines, tone of voice |
| Technical Specs | API docs, system requirements | Architecture diagrams, API references |
| Procedures | Step-by-step processes | Deployment guides, troubleshooting |
| Templates | Reusable document formats | Report templates, meeting notes |

## Troubleshooting

### Common Upload Issues

<AccordionGroup>
<Accordion title="Upload Failed - File Too Large">
**Solution**: Reduce file size by:
- Compressing images within the PDF
- Removing unnecessary pages
- Splitting large documents into smaller sections
</Accordion>

<Accordion title="Text Not Searchable">
**Cause**: PDF contains scanned images without text layer

**Solution**:
- Use OCR software to add text layer
- Re-create document from original source
- Convert to text-based PDF format
</Accordion>

<Accordion title="Processing Stuck">
**Troubleshooting Steps**:
1. Check file format compatibility
2. Verify document isn't password protected
3. Ensure stable internet connection
4. Try uploading during off-peak hours
</Accordion>
</AccordionGroup>

### Performance Optimization

If your AI Assistant responses seem slow or inaccurate:

<CheckboxGroup>
<Checkbox>Review document relevance and remove outdated files</Checkbox>
<Checkbox>Optimize document categories for better organization</Checkbox>
<Checkbox>Check document quality scores in analytics</Checkbox>
<Checkbox>Update priority levels for most important references</Checkbox>
<Checkbox>Consider splitting large documents into focused sections</Checkbox>
</CheckboxGroup>

### Getting Help

<CardGroup cols={2}>
<Card title="Documentation" icon="book" href="/support/docs">
Comprehensive guides and tutorials
</Card>
<Card title="Support Ticket" icon="ticket" href="/support/contact">
Direct assistance from our support team
</Card>
<Card title="Community Forum" icon="users" href="/community">
Connect with other users and share solutions
</Card>
<Card title="Video Tutorials" icon="play" href="/tutorials">
Step-by-step video guides
</Card>
</CardGroup>

---

<Note>
For additional configuration options and advanced features, visit the [Advanced Configuration](/advanced/configuration) section.
</Note>
25 changes: 24 additions & 1 deletion ai-ingestion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
)
}

Mintlify generates optimized formats and provides shortcuts that help users get faster, more accurate responses when using your documentation as context for LLMs and AI tools.

Check warning on line 15 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L15

Did you really mean 'LLMs'?

## Contextual menu

Expand Down Expand Up @@ -46,16 +46,39 @@
"options": [
"copy",
"view",
"chatgpt",

Check warning on line 49 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L49

Did you really mean 'chatgpt'?
"claude"

Check warning on line 50 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L50

Did you really mean 'claude'?
]
}
}
```

## PDF Reference Documents

Upload PDF documents to enhance your AI Assistant's knowledge base with custom reference materials. This feature allows your AI to provide more accurate and contextually relevant responses by referencing your specific documentation and procedures.

### Benefits of PDF References

- **Enhanced Accuracy**: AI responses become more precise with access to your specific documentation
- **Custom Knowledge**: Include internal procedures, style guides, and technical specifications
- **Contextual Responses**: AI can reference relevant sections from your uploaded documents
- **Improved Productivity**: Reduce time spent searching for information across multiple sources

### Supported Document Types

Upload various types of reference materials to improve AI Assistant performance:

- Internal documentation and procedures
- Technical specifications and standards
- Style guides and writing standards
- Product documentation and user manuals
- API documentation and code examples

For detailed information on uploading and managing PDF reference documents, see our [Dashboard Settings documentation](/advanced/dashboard/settings).

## /llms.txt

The [/llms.txt file](https://llmstxt.org) is an industry standard that helps general-purpose LLMs index more efficiently, similar to how a sitemap helps search engines.

Check warning on line 81 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L81

Did you really mean 'LLMs'?

Every documentation site automatically hosts an `/llms.txt` file at the root that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.

Expand All @@ -81,4 +104,4 @@

### Command \+ C shortcut

Select Command \+ C (Ctrl \+ C on Windows) to copy any page as Markdown.
Select Command \+ C (Ctrl \+ C on Windows) to copy any page as Markdown.

Check warning on line 107 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L107

Did you really mean 'Ctrl'?
53 changes: 53 additions & 0 deletions ai/ingestion.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: "AI Ingestion"
description: "Configure how your AI Assistant processes and references documentation content"
---

## PDF Reference Documents

Upload PDF documents to enhance your AI Assistant's knowledge base with custom reference materials. This powerful feature allows your AI to provide more accurate and contextually relevant responses by referencing your specific documentation and procedures.

### How PDF References Enhance AI Responses

The AI Assistant can now access external information from PDFs uploaded via the Dashboard, significantly improving response accuracy even for information not included in your main documentation. When you ask questions, the AI can:

Check warning on line 12 in ai/ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai/ingestion.mdx#L12

Did you really mean 'PDFs'?

- **Reference specific sections** from your uploaded documents
- **Provide more accurate answers** by drawing from your custom knowledge base
- **Include contextual information** from internal procedures and guidelines
- **Maintain consistency** with your organization's standards and practices

This capability makes the AI Assistant much more valuable for teams with specialized knowledge, internal procedures, or domain-specific information that extends beyond standard documentation.

### Benefits of PDF References

- **Enhanced Accuracy**: AI responses become more precise with access to your specific documentation
- **Custom Knowledge**: Include internal procedures, style guides, and technical specifications
- **Contextual Responses**: AI can reference relevant sections from your uploaded documents
- **Improved Productivity**: Reduce time spent searching for information across multiple sources
- **Organizational Consistency**: Ensure responses align with your company's standards and procedures

### Supported Document Types

Upload various types of reference materials to improve AI Assistant performance:

- Internal documentation and procedures
- Technical specifications and standards
- Style guides and writing standards
- Product documentation and user manuals
- API documentation and code examples
- Training materials and best practices guides

### Getting Started with PDF Upload

To upload and manage PDF reference documents:

1. Navigate to your Dashboard Settings
2. Access the AI Assistant configuration section
3. Use the PDF upload feature to add your reference materials
4. Configure document categories and priority levels

For detailed step-by-step instructions on uploading and managing PDF reference documents, see our comprehensive [Dashboard Settings documentation](/advanced/dashboard/settings).

<Note>
PDF documents are processed and indexed automatically, making their content searchable and referenceable by your AI Assistant within minutes of upload.

Check warning on line 52 in ai/ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai/ingestion.mdx#L52

Did you really mean 'referenceable'?
</Note>
33 changes: 32 additions & 1 deletion api-reference/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,36 @@
secret.
</Note>

## PDF Reference Documents

The AI Assistant API supports uploading PDF reference documents to enhance the assistant's knowledge base. This feature allows you to provide additional context and information that the AI can reference when answering questions.

### Upload PDF Documents

Use the PDF upload endpoints to add reference materials to your AI Assistant's knowledge base:

- **Upload**: Add new PDF documents to the knowledge base
- **List**: Retrieve all uploaded PDF documents
- **Update**: Modify metadata or replace existing documents
- **Delete**: Remove documents from the knowledge base

### Managing PDF References

The API provides comprehensive management capabilities for your PDF reference documents:

- **Query**: Search through uploaded documents based on content or metadata
- **Categorize**: Organize documents by type, topic, or priority
- **Version Control**: Track different versions of the same document
- **Access Control**: Manage permissions for document access

### Best Practices

When uploading PDF documents through the API:

- Ensure PDFs contain searchable text for optimal indexing

Check warning on line 62 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-reference/introduction.mdx#L62

Did you really mean 'PDFs'?
- Use descriptive filenames and metadata for better organization
- Keep documents up-to-date by replacing outdated versions
- Organize documents into logical categories for efficient retrieval

Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
the API for AI assistant. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
the API for AI assistant. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
Loading
Loading