pg vector embed rust

PG矢量嵌入和查詢生鏽

該存儲庫包含一個基於生鏽的系統，用於管理向量嵌入並使用PostgreSQL支持的矢量數據庫查詢它們。該系統旨在處理嵌入，存儲和查詢。

目錄

• 概述
• 特徵
• 目錄結構
• 入門
  • 先決條件
  • 安裝
  • 運行應用程序
• 用法
  • 命令
  • 配置
  • 嵌入和查詢
• 測試
• 貢獻
• 執照

概述

該系統由幾個模塊組成，這些模塊處理嵌入和查詢過程的不同方面：

• 命令：處理命令行參數和子命令。
• 配置：管理嵌入請求和數據庫連接的配置設置。
• 常數：提供整個應用程序中使用的恆定值。
• 嵌入：包含用於生成嵌入的邏輯並將其持續到數據庫中。
• VECTORDB ：處理與PostgreSQL數據庫的交互，以存儲和查詢向量嵌入。

特徵

• 嵌入生成：從輸入數據生成向量嵌入。
• 數據庫持久性：將嵌入在PostgreSQL數據庫中。
• 查詢：查詢數據庫以根據向量嵌入查找最近的鄰居。

目錄結構

 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

入門

先決條件

• Rust（最新穩定版本）
• PostgreSQL矢量數據庫。
• Docker（用於運行測試）
• 帶有nomic-embed-text或類似模型的主動Ollama服務。

安裝

1. 克隆存儲庫：

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

2. 安裝依賴項：

   cargo build

運行應用程序

1. 啟動PostgreSQL Vector數據庫（如果尚未運行）。

2. Ollama服務應使用指定的模型運行。

3. 運行應用程序：

   cargo run
      
   

用法

命令

該應用程序支持各種命令和子命令。使用--help標誌查看可用選項：

   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 "  

配置

用於嵌入請求和數據庫連接的配置設置在src/app/config.rs中管理。您可以根據需要修改這些設置。

嵌入和查詢

• 生成嵌入：使用run_embedding功能生成嵌入並將其持續到數據庫中。
• 查詢嵌入：使用run_query函數根據向量嵌入來查詢數據庫以查詢最近的鄰居。

測試

存儲庫包括一套全面的測試套件，以確保系統正常運行。進行測試：

cargo test 

貢獻

歡迎捐款！請閱讀contring.md文件，以獲取有關如何為該項目貢獻的詳細信息。

執照

該項目是根據MIT許可證獲得許可的 - 有關詳細信息，請參見許可證文件。

---

根據您的特定需求和項目詳細信息，請隨時自定義此讀數。