// 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
    );
  });
  
  

Community

API Reference

The best open source AI powered answer engine.

SciPhi Cloud

R2R GitHub

Support

Analytics

R2RAnalyticsRequest

HTTPValidationError

Get Analytics App

R2R - The best open source RAG answer engine

Introduction

Installation

Quickstart

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

Walkthrough

Learn how to use different language models with R2R

Multiple LLMs

Learn how to implement and use hybrid search with R2R

Hybrid Search

Learn how to use R2R for multimodal Retrieval-Augmented Generation

Multimodal RAG

Learn how to build and use advanced RAG techniques with R2R

Advanced RAG

Learn how to build and use knowledge graphs with R2R

Knowledge Graphs

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

Local RAG System

Learn how to implement and use search reranking with R2R

Search Reranking

Learn how to effectively manage users and documents with R2R

Document Management

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 build and customize R2R applications

Building R2R

Learn how to configure R2R applications using the config.json file

Configuring R2R

Learn how to customize R2R applications using factories and the builder pattern

Customizing R2R

Pipelines

Learn about the R2R Ingestion Pipeline for processing and storing documents

Ingestion Pipeline

Learn about the R2R Search Pipeline for retrieving relevant information using vector and knowledge graph searches

Search Pipeline

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

RAG Pipeline

Learn how to configure and switch between different Language Model providers in R2R

API Documentation

Document Ingestion

Retrieval

Management

Analytics

Query Parameters

Body

Response