pg vector embed rust

PGベクターの埋め込みとクエリ錆

このリポジトリには、ベクターの埋め込みを管理し、PostgreSQLバックされたベクターデータベースを使用してクエリを照会するための錆ベースのシステムが含まれています。このシステムは、埋め込み生成、ストレージ、クエリを処理するように設計されています。

目次

• 概要
• 特徴
• ディレクトリ構造
• はじめる
  • 前提条件
  • インストール
  • アプリケーションの実行
• 使用法
  • コマンド
  • 構成
  • 埋め込みとクエリ
• テスト
• 貢献
• ライセンス

概要

このシステムは、埋め込みとクエリのプロセスのさまざまな側面を処理するいくつかのモジュールで構成されています。

• コマンド：コマンドライン引数とサブコマンドを処理します。
• 構成：埋め込みリクエストとデータベース接続の構成設定を管理します。
• 定数：アプリケーション全体で使用される一定の値を提供します。
• 埋め込み：埋め込みを生成し、データベースに持続するためのロジックが含まれています。
• VectordB ：ベクトル埋め込みを保存およびクエリするために、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ベクトルdb。
• Docker（実行中のテスト用）
• nomic-embed-textまたは同様のモデルを備えたアクティブオラマサービス。

インストール

1. リポジトリをクローンします：

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

2. 依存関係をインストールします：

   cargo build

アプリケーションの実行

1. PostgreSQLベクトルデータベースを開始します（まだ実行されていない場合）。

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 

貢献

貢献は大歓迎です！このプロジェクトへの貢献方法の詳細については、Convinting.mdファイルをお読みください。

ライセンス

このプロジェクトは、MITライセンスに基づいてライセンスされています。詳細については、ライセンスファイルを参照してください。

---

特定のニーズとプロジェクトの詳細に基づいて、このREADMEをさらにカスタマイズしてください。