diff --git a/advanced/dashboard/settings.mdx b/advanced/dashboard/settings.mdx new file mode 100644 index 00000000..15fd16d2 --- /dev/null +++ b/advanced/dashboard/settings.mdx @@ -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. + + + + Quick Access + + + Navigate to **Settings** → **Dashboard** to access all configuration options + + + +## 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 + } +} +``` + +### Advanced Settings + + + + 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 + + + + 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. + ``` + + + +## PDF Upload Feature + + + **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. + + +### 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 + + + Ensure your PDFs contain searchable text. Scanned documents without OCR may not be properly indexed. + + +### Processing and Indexing + +Once uploaded, your PDFs undergo automatic processing: + +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 + + + PDF Processing Workflow + + +### Managing Uploaded Documents + +#### Document Library + +View and manage all uploaded PDFs in the Knowledge Base library: + +- **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 + + + + Update document titles, categories, and descriptions + + + Upload new versions while maintaining reference history + + + Manage who can view and reference specific documents + + + Remove outdated or irrelevant reference materials + + + +## Best Practices for PDF References + +### Document Preparation + + + + Ensure your PDFs have clear headings, consistent formatting, and logical organization + + + Add relevant titles, authors, and descriptions to improve searchability + + + Keep documents current by uploading new versions when information changes + + + Review documents for accuracy and completeness before uploading + + + +### 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 + + + **Pro Tip**: Documents with clear structure, bullet points, and examples work best with the AI Assistant's processing algorithms. + + +- **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 + + + + **Solution**: Reduce file size by: + - Compressing images within the PDF + - Removing unnecessary pages + - Splitting large documents into smaller sections + + + + **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 + + + + **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 + + + +### Performance Optimization + +If your AI Assistant responses seem slow or inaccurate: + + + Review document relevance and remove outdated files + Optimize document categories for better organization + Check document quality scores in analytics + Update priority levels for most important references + Consider splitting large documents into focused sections + + +### Getting Help + + + + Comprehensive guides and tutorials + + + Direct assistance from our support team + + + Connect with other users and share solutions + + + Step-by-step video guides + + + +--- + + + For additional configuration options and advanced features, visit the [Advanced Configuration](/advanced/configuration) section. + \ No newline at end of file diff --git a/ai-ingestion.mdx b/ai-ingestion.mdx index a025889f..8e5cb001 100644 --- a/ai-ingestion.mdx +++ b/ai-ingestion.mdx @@ -53,6 +53,29 @@ Add the `contextual` field to your `docs.json` and specify which options you wan } ``` +## 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. @@ -81,4 +104,4 @@ Add a `.md` to a page's URL to display a Markdown version of that page. ### 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. \ No newline at end of file diff --git a/ai/ingestion.mdx b/ai/ingestion.mdx new file mode 100644 index 00000000..cca8e082 --- /dev/null +++ b/ai/ingestion.mdx @@ -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: + +- **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). + + + PDF documents are processed and indexed automatically, making their content searchable and referenceable by your AI Assistant within minutes of upload. + \ No newline at end of file diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 06ea3688..b5b03258 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -33,5 +33,36 @@ Responses include citations so you can point your users to the right places they secret. +## 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 +- 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). \ No newline at end of file diff --git a/docs.json b/docs.json index f20329ea..b962d04b 100644 --- a/docs.json +++ b/docs.json @@ -92,14 +92,14 @@ "group": "MDX", "icon": "markdown", "pages": [ - "api-playground/mdx/configuration", - "api-playground/mdx/authentication" + "api-playground/mdx/configuration", + "api-playground/mdx/authentication" ] }, "api-playground/troubleshooting" ] }, - { + { "group": "Authentication and Personalization", "pages": [ "settings/authentication-personalization/authentication", @@ -157,8 +157,8 @@ "pages": [ "advanced/dashboard/sso", "advanced/dashboard/permissions", - "advanced/dashboard/roles" - + "advanced/dashboard/roles", + "advanced/dashboard/settings" ] } ] @@ -217,7 +217,7 @@ { "group": "Version Control and CI/CD", "pages": [ - "settings/github", + "settings/github", "settings/gitlab", "settings/ci", "settings/preview-deployments"