pg vector embed rust

PG -Vektor -Einbettung und Abfragerost

Dieses Repository enthält ein rostbasiertes System zum Verwalten von Vektor-Einbettungen und Abfragen mit einer Postgresql-von Vektor-Datenbank. Das System ist für die Einbettung von Erzeugung, Speicherung und Abfrage ausgelegt.

Inhaltsverzeichnis

• Überblick
• Merkmale
• Verzeichnisstruktur
• Erste Schritte
  • Voraussetzungen
  • Installation
  • Ausführen der Anwendung
• Verwendung
  • Befehle
  • Konfiguration
  • Einbetten und Abfragen
• Testen
• Beitragen
• Lizenz

Überblick

Das System besteht aus mehreren Modulen, die verschiedene Aspekte des Einbettungs- und Abfrageprozesses verarbeiten:

• Befehle : Handle Command Line Argumente und Unterbefehle.
• Konfiguration : Verwaltet Konfigurationseinstellungen für Einbettungsanforderungen und Datenbankverbindungen.
• Konstanten : Bietet konstante Werte, die in der gesamten Anwendung verwendet werden.
• Einbettung : Enthält Logik für die Erzeugung von Einbettungen und das Bestehen in der Datenbank.
• VectordB : Verarbeitet Interaktionen mit der PostgreSQL -Datenbank zum Speichern und Abfragen von Vektor -Einbettungen.

Merkmale

• Erzeugung einbetten : Generieren Sie Vektoreinbettung aus Eingabedaten.
• Datenbank Persistenz : Speichern Einbettung in einer PostgreSQL -Datenbank.
• Abfrage : Fragen Sie die Datenbank ab, um die nächsten Nachbarn basierend auf Vektoreinbettungen zu finden.

Verzeichnisstruktur

 src/
├── app/
│   ├── commands.rs
│   ├── config.rs
│   └── constants.rs
├── embedding/
│   ├── run_embedding.rs
│   └── vector_embedding.rs
├── main.rs
├── tests/
│   ├── setup_docker.rs
│   ├── test_pgclient.rs
│   ├── test_query_vector.rs
│   ├── test_run_embedding.rs
│   └── test_vector_embedding.rs
├── vectordb/
│   ├── pg_vector.rs
│   └── query_vector.rs
├── lib.rs
├── vectordb/mod.rs
├── tests/mod.rs
├── embedding/mod.rs
└── app/mod.rs

Erste Schritte

Voraussetzungen

• Rost (neueste stabile Version)
• PostgreSQL Vector db.
• Docker (zum Ausführen von Tests)
• Active Ollama-Service mit nomic-embed-text oder ähnlichem Modell.

Installation

1. Klonen Sie das Repository:

   git clone https://github.com/rupeshtr78/pg-vector-embed-rust.git
   cd pg-vector-embed-rust

2. Abhängigkeiten installieren:

   cargo build

Ausführen der Anwendung

1. Starten Sie die PostgreSQL Vector -Datenbank (falls nicht bereits ausgeführt).

2. Der Ollama -Service sollte mit dem angegebenen Modell ausgeführt werden.

3. Führen Sie die Anwendung aus:

   cargo run
      
   

Verwendung

Befehle

Die Anwendung unterstützt verschiedene Befehle und Unterbefehle. Verwenden Sie das Flag --help -Flag, um verfügbare Optionen anzuzeigen:

   cargo run -- --help
   cargo run -- write --input " dog sound is called bark " --input " cat sounds is called purr " --model " nomic-embed-text " --table " from_rust2 " --dim 768 --log-level " debug "
   cargo run -- query --input " who is barking " --model " nomic-embed-text " --table " from_rust2 "  

Konfiguration

Konfigurationseinstellungen für Einbettungsanforderungen und Datenbankverbindungen werden in src/app/config.rs verwaltet. Sie können diese Einstellungen nach Bedarf ändern.

Einbetten und Abfragen

• Erzeugen Sie Einbettung : Verwenden Sie die Funktion run_embedding , um Einbettungen zu generieren und in der Datenbank zu bestehen.
• Abfrage -Einbettungen : Verwenden Sie die Funktion run_query , um die Datenbank für nächste Nachbarn basierend auf Vektoreinbettungen abzufragen.

Testen

Das Repository enthält eine umfassende Testsuite, um sicherzustellen, dass das System korrekt funktioniert. Um die Tests durchzuführen:

cargo test 

Beitragen

Beiträge sind willkommen! Bitte lesen Sie die Datei für die beitragen.md, um Einzelheiten zum Beitrag zu diesem Projekt zu erhalten.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.

---

Fühlen Sie sich frei, diese Readme anhand Ihrer spezifischen Anforderungen und Projektdetails weiter anzupassen.