Quivr - Votre deuxième cerveau, optimisé par l'IA générative

Quivr, vous aide à construire votre deuxième cerveau, utilise la puissance de GenerativeAI pour être votre assistant personnel !

Principales fonctionnalités ?

RAG Opiniated : Nous avons créé un RAG avisé, rapide et efficace pour que vous puissiez vous concentrer sur votre produit.
LLM : Quivr fonctionne avec n'importe quel LLM, vous pouvez l'utiliser avec OpenAI, Anthropic, Mistral, Gemma, etc.
N'importe quel fichier : Quivr fonctionne avec n'importe quel fichier, vous pouvez l'utiliser avec PDF, TXT, Markdown, etc. et même ajouter vos propres analyseurs.
Personnalisez votre RAG : Quivr vous permet de personnaliser votre RAG, d'ajouter une recherche internet, d'ajouter des outils, etc.
Intégrations avec Megaparse : Quivr fonctionne avec Megaparse, vous pouvez donc ingérer vos fichiers avec Megaparse et utiliser le RAG avec Quivr.

Nous nous occupons du RAG afin que vous puissiez vous concentrer sur votre produit. Installez simplement quivr-core et ajoutez-le à votre projet. Vous pouvez désormais ingérer vos fichiers et poser des questions.*

Nous allons améliorer le RAG et ajouter plus de fonctionnalités, restez à l'écoute !

C'est le cœur de Quivr, le cerveau de Quivr.com.

Commencer ?

Vous pouvez tout trouver sur la documentation.

Conditions préalables ?

Assurez-vous que les éléments suivants sont installés :

Python 3.10 ou version ultérieure

30 secondes Installation ?

Étape 1 : Installer le package

pip install quivr-core # Check that the installation worked

Étape 2 : Créer un RAG avec 5 lignes de code

 import tempfile

from quivr_core import Brain

if __name__ == "__main__" :
    with tempfile . NamedTemporaryFile ( mode = "w" , suffix = ".txt" ) as temp_file :
        temp_file . write ( "Gold is a liquid of blue-like colour." )
        temp_file . flush ()

        brain = Brain . from_files (
            name = "test_brain" ,
            file_paths = [ temp_file . name ],
        )

        answer = brain . ask (
            "what is gold? asnwer in french"
        )
        print ( "answer:" , answer )

Configuration

Flux de travail

RAG de base

Créer un workflow RAG de base comme celui ci-dessus est simple, voici les étapes :

Ajoutez vos clés API à vos variables d'environnement

 import os
os . environ [ "OPENAI_API_KEY" ] = "myopenai_apikey"

Quivr prend en charge les API d'Anthropic, OpenAI et Mistral. Il prend également en charge les modèles locaux utilisant Ollama.

Créez le fichier YAML basic_rag_workflow.yaml et copiez-y le contenu suivant

 workflow_config :
  name : " standard RAG "
  nodes :
    - name : " START "
      edges : ["filter_history"]

    - name : " filter_history "
      edges : ["rewrite"]

    - name : " rewrite "
      edges : ["retrieve"]

    - name : " retrieve "
      edges : ["generate_rag"]

    - name : " generate_rag " # the name of the last node, from which we want to stream the answer to the user
      edges : ["END"]

# Maximum number of previous conversation iterations
# to include in the context of the answer
max_history : 10

# Reranker configuration
reranker_config :
  # The reranker supplier to use
  supplier : " cohere "

  # The model to use for the reranker for the given supplier
  model : " rerank-multilingual-v3.0 "

  # Number of chunks returned by the reranker
  top_n : 5

# Configuration for the LLM
llm_config :

  # maximum number of tokens passed to the LLM to generate the answer
  max_input_tokens : 4000

  # temperature for the LLM
  temperature : 0.7

Créer un cerveau avec la configuration par défaut

 from quivr_core import Brain

brain = Brain . from_files ( name = "my smart brain" ,
                        file_paths = [ "./my_first_doc.pdf" , "./my_second_doc.txt" ],
                        )

Lancer une discussion

 brain . print_info ()

from rich . console import Console
from rich . panel import Panel
from rich . prompt import Prompt
from quivr_core . config import RetrievalConfig

config_file_name = "./basic_rag_workflow.yaml"

retrieval_config = RetrievalConfig . from_yaml ( config_file_name )

console = Console ()
console . print ( Panel . fit ( "Ask your brain !" , style = "bold magenta" ))

while True :
    # Get user input
    question = Prompt . ask ( "[bold cyan]Question[/bold cyan]" )

    # Check if user wants to exit
    if question . lower () == "exit" :
        console . print ( Panel ( "Goodbye!" , style = "bold yellow" ))
        break

    answer = brain . ask ( question , retrieval_config = retrieval_config )
    # Print the answer with typing effect
    console . print ( f"[bold green]Quivr Assistant[/bold green]: { answer . answer } " )

    console . print ( "-" * console . width )

brain . print_info ()

Vous êtes maintenant prêt à parler avec votre cerveau et à tester différentes stratégies de récupération en modifiant simplement le fichier de configuration !

Aller plus loin

Vous pouvez aller plus loin avec Quivr en ajoutant une recherche internet, en ajoutant des outils, etc. Consultez la documentation pour plus d'informations.

Contributeurs ✨

Merci à ces personnes merveilleuses :

Contribuer ?

Avez-vous reçu une pull request ? Ouvrez-le et nous l'examinerons dès que possible. Consultez notre tableau de projets ici pour voir sur quoi nous nous concentrons actuellement, et n'hésitez pas à apporter vos nouvelles idées !