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许可证获得许可的 - 有关详细信息，请参见许可证文件。

---

根据您的特定需求和项目详细信息，请随时自定义此读数。