Skip to content

User Guide

User Guide for InspectRAG 🧑‍💻

About this Guide

This guide walks users through the steps to access InspectRAG, upload and query documents, and understand permission-based responses. It includes practical examples of queries and sample matching scenarios to help users understand how their roles and permissions impact their access.

1. Accessing InspectRAG

  1. Login via OpenID 🔑
  2. Visit your organization’s login page.

  3. Enter your username and password.

  4. Navigating to InspectRAG

  5. After logging in, you will land on the InspectChat homepage.
  6. Select the InspectRAG Plugin from the list of available plugins to start querying documents.

2. What You Can Query in InspectRAG

Your access to documents depends on your roles, group memberships, and permissions configured in Active Directory and mapped within InspectRAG.

Allowed Query Examples:

  1. By Document Title
    Example: 
    Find the Annual Budget Report 2023.

  2. Response: If you have the necessary role (e.g., "Finance Team"), InspectRAG retrieves the report.

  3. By Document Type
    Example: 

    Show me all meeting notes for this month.

  4. Response: Retrieves relevant documents if you belong to the Meetings group.

  5. By Document Creator
    Example: 

    Retrieve all project plans created by John Doe.

  6. Response: Provides documents created by John if you have permission to access them.

3. Uploading Files via Chat 💬

  1. Upload a File:
  2. Click on the Upload button in the chat interface.

  3. Select the file you want to upload.

  4. Query the Uploaded File: Example: 

    What are the key deliverables in the uploaded project plan?

  5. Response: InspectRAG extracts the requested information from the uploaded file.

4. SharePoint Integration Queries 📁

If SharePoint integration is enabled, you can access documents stored in SharePoint based on your permissions.

  1. Role-Based Query Example:
    Show me the compliance reports available to my department.

  2. Response: InspectRAG returns only those reports that match your role or group.

  3. Check File Updates:

    What changes were made to the marketing strategy document?

  4. Response: Retrieves the updated document version with a summary of changes.

5. Permission Matching in Action 🔍

When you submit a query, InspectRAG cross-references your roles, groups, or username with the file permissions and metadata.

Matching Scenarios:

  1. Successful Match Example
    User Query: 
    Retrieve the Q2 Sales Report 2024.
    File Metadata:
  2. file_id: 12345
  3. creator: Sarah Johnson
  4. permissions: Finance Team, Managers Group
  5. roles required: Finance Analyst or Manager

User’s Roles: - Finance Analyst
- Group: Finance Team

Response: 

Here is the Q2 Sales Report 2024 ...

  1. Failed Match Example
    User Query: 
    Show me the legal compliance document.
    File Metadata:
  2. file_id: 67890
  3. creator: Legal Department
  4. permissions: Legal Team, Compliance Officers
  5. roles required: Compliance Officer

User’s Roles: - Marketing Team Member

Response: - For queries specific to restricted files, the AI responds in a neutral, context-less manner. For example: - If a user asks about a restricted report, the response might be:
"Without specific details, it's challenging to provide an exact answer. Reports vary widely depending on the scope and purpose." - Or, for a query about a restricted person in context, it might say:
"There are many individuals with that name. Could you clarify further?"

This approach subtly limits responses without disclosing restricted access, keeping interactions seamless yet secure.

6. Tips for Effective Queries

  • Use Specific Keywords:
    Example:

    Find all sales forecasts for Q4.

  • Filter by Creator or Date:
    Example:

    Show me the reports submitted by Jane Doe in September.

  • Role-Based Queries:
    Example:

    What reports are available to the Finance team?

7. Summary of Query Permissions

InspectRAG ensures that only authorized users access documents by matching your roles, group memberships, and username with the file permissions stored in SharePoint or applied during uploads.

This guide helps you understand how to: - Log in and navigate InspectRAG. - Upload files and query documents seamlessly. - Understand permission-based responses with practical examples.

By following the examples and tips in this guide, you can effectively use InspectRAG to retrieve the information you need securely and efficiently.