// customize
const inkeepSettings = {
    baseSettings: {
        apiKey: '3adc15f45617826bb73c0a4cb9fb3a06547b6ab7f90c819e',
        integrationId: 'clv1yuc8f0002vzhxbzwy26yx',
        organizationId: 'clu6yudh9000sajgn7nwxfve8',
        primaryBrandColor: '#26D6FF', // your brand color, widget color scheme is derived from this
        organizationDisplayName: 'R2R',
        theme: {
          colorMode: {
            forcedColorMode: 'dark', // to sync dark mode with the widget
          },
        },
    },
    aiChatSettings: {
      // ...optional settings
      botAvatarSrcUrl:
        "https://www.sciphi.ai/screenshots/logo222_cut.png",
      quickQuestions: [
        "How do I get started?",
        "How does R2R implement hybrid search?",
        "How do I use the R2R API?",
        // "How do I use ",
        // "Example question 3?",
      ],
    },
    modalSettings: {
      isShortcutKeyEnabled: false, // disable default cmd+k behavior
      // ...optional settings
    },
  };
  
  // The Mintlify search triggers, which we'll reuse to trigger the Inkeep modal
  const searchButtonContainerIds = [
    "search-bar-entry",
    "search-bar-entry-mobile",
  ];
  
  // Clone and replace, needed to remove existing event listeners
  const clonedSearchButtonContainers = searchButtonContainerIds.map((id) => {
    const originalElement = document.getElementById(id);
    const clonedElement = originalElement.cloneNode(true);
    originalElement.parentNode.replaceChild(clonedElement, originalElement);
  
    return clonedElement;
  });
  
  // Load the Inkeep component library
  const inkeepScript = document.createElement("script");
  inkeepScript.type = "module";
  inkeepScript.src =
    "https://unpkg.com/@inkeep/widgets-embed@latest/dist/embed.js";
  document.body.appendChild(inkeepScript);
  
  // Once the Inkeep library is loaded, instantiate the UI components
  inkeepScript.addEventListener("load", function () {
    // Customization settings
  
    // for syncing with dark mode
    const colorModeSettings = {
      observedElement: document.documentElement,
      isDarkModeCallback: (el) => {
        return el.classList.contains("dark");
      },
      colorModeAttribute: "class",
    };
  
    // Instantiate the "Ask AI" pill chat button
    Inkeep().embed({
      componentType: "ChatButton",
      colorModeSync: colorModeSettings,
      properties: inkeepSettings,
    });
  
    // Instantiate the search bar modal
    const inkeepSearchModal = Inkeep({
      ...inkeepSettings.baseSettings,
    }).embed({
      componentType: "CustomTrigger",
      colorModeSync: colorModeSettings,
      properties: {
        ...inkeepSettings,
        isOpen: false,
        onClose: () => {
          inkeepSearchModal.render({
            isOpen: false,
          });
        },
      },
    });
  
    // When the Mintlify search bar elements are clicked, open the Inkeep search modal
    clonedSearchButtonContainers.forEach((trigger) => {
      trigger.addEventListener("click", function () {
        inkeepSearchModal.render({
          isOpen: true,
        });
      });
    });
  
    // Open the Inkeep Modal with cmd+k
    window.addEventListener(
      "keydown",
      (event) => {
        if (
          (event.metaKey || event.ctrlKey) &&
          (event.key === "k" || event.key === "K")
        ) {
          event.stopPropagation();
          inkeepSearchModal.render({ isOpen: true });
          return false;
        }
      },
      true
    );
  });
  
  

Key Features

Quickstart

RAG Cookbooks

Auth & Admin Features

Getting Started

Community

API Reference

The best open source AI powered answer engine.

SciPhi Cloud

R2R GitHub

Support

Build, scale, and manage user-facing Retrieval-Augmented Generation applications.

Introduction

Installation

A detailed step-by-step walkthrough of the core features provided by R2R.

Walkthrough

Basic Configuration

Learn how to set up and run a Retrieval-Augmented Generation system locally using R2R

Local RAG System

Learn how to build and use knowledge graphs with R2R

Knowledge Graphs

Learn how to implement and use hybrid search with R2R

Hybrid Search

Learn how to build and use advanced RAG techniques with R2R

Advanced RAG

Learn how to implement and use assistants with R2R

RAG Assistant

Learn how to use R2R for multimodal Retrieval-Augmented Generation

Multimodal RAG

Learn how to implement and use search reranking with R2R

Search Reranking

Learn how to build webapps powered by RAG using R2R

Web Development

A comprehensive guide to user authentication and management features in R2R

User Auth

Learn how to use analytics and and logging with R2R

Analytics & Observability

Learn how to set up and use the R2R Dashboard for managing your instance.

Dashboard

Learn how to deploy a RAG engine in the cloud

Deploy

Security

Core Logic

R2RConfig

R2RBuilder

R2REngine

Learn how to configure and use the authentication provider in R2R

Crypto & Auth

Configure and use multiple Language Model providers in R2R

Language Models (LLMs)

Learn how to configure and use the embeddings provider in R2R

Embeddings

Learn how to configure and use the database provider in R2R

Database

Learn how to configure and use the knowledge graph provider in R2R

Knowledge Graph

Pipelines

Ingestion

Learn about the R2R Retrieval-Augmented Generation (RAG) Pipeline for enhanced information retrieval and response generation

RAG Pipeline

Learn about R2R telemetry and how to manage it

Telemetry

Powerful document ingestion, search, and RAG capabilities at your fingertips

R2R API Reference

Endpoint for uploading and processing new files into the R2R system. This endpoint supports multipart/form-data requests, enabling you to upload files along with their metadata for ingestion into the vector database.

Ingest Files

Endpoint for updating existing files in the R2R system. This endpoint supports multipart/form-data requests, allowing you to upload new versions of files along with updated metadata.

Update Files

Search

Perform a RAG operation using vector search and/or knowledge graph search, followed by text generation.

Get Started

RAG Cookbooks

Auth & Admin Cookbooks

Deep Dives

Introduction

Key Features

Quickstart

Getting Started

RAG Cookbooks

Auth & Admin Features

Community

Get Started

RAG Cookbooks

Auth & Admin Cookbooks

Deep Dives

​Key Features

​Quickstart

​Getting Started

​RAG Cookbooks

​Auth & Admin Features

​Community

Key Features

Quickstart

Getting Started

RAG Cookbooks

Auth & Admin Features

Community