pg vector embed rust

PG Vector incrustación y óxido de consulta

Este repositorio contiene un sistema basado en el óxido para administrar integridades vectoriales y consultarlos utilizando una base de datos vectorial respaldada por PostgreSQL. El sistema está diseñado para manejar la generación de incrustación, el almacenamiento y la consulta.

Tabla de contenido

• Descripción general
• Características
• Estructura de directorio
• Empezando
  • Requisitos previos
  • Instalación
  • Ejecutando la aplicación
• Uso
  • Comandos
  • Configuración
  • Incrustación y consulta
• Pruebas
• Que contribuye
• Licencia

Descripción general

El sistema está compuesto por varios módulos que manejan diferentes aspectos del proceso de incrustación y consulta:

• Comandos : maneja argumentos de línea de comandos y subcomandos.
• Configuración : gestiona la configuración de configuración para solicitudes de incrustación y conexiones de base de datos.
• Constantes : proporciona valores constantes utilizados en toda la aplicación.
• Incrustación : contiene lógica para generar incrustaciones y persistirlos en la base de datos.
• VectordB : maneja las interacciones con la base de datos PostgreSQL para almacenar y consultar los incrustaciones de vectores.

Características

• Generación de incrustación : Genere incrustaciones de vectores a partir de datos de entrada.
• Persistencia de la base de datos : almacenar incrustaciones en una base de datos PostgreSQL.
• Consulta : consulte la base de datos para encontrar vecinos más cercanos en función de las integridades vectoriales.

Estructura de directorio

 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

Empezando

Requisitos previos

• Rust (última versión estable)
• Vector PostgreSQL DB.
• Docker (para ejecutar pruebas)
• Servicio Ollama Active con nomic-embed-text o modelo similar.

Instalación

1. Clon el repositorio:

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

2. Instalar dependencias:

   cargo build

Ejecutando la aplicación

1. Inicie la base de datos Vector PostgreSQL (si no se está ejecutando).

2. El servicio Ollama debe ejecutarse con el modelo especificado.

3. Ejecute la aplicación:

   cargo run
      
   

Uso

Comandos

La aplicación admite varios comandos y subcomandos. Use la bandera --help para ver las opciones disponibles:

   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 "  

Configuración

Los ajustes de configuración para las solicitudes de incrustación y las conexiones de la base de datos se administran en src/app/config.rs . Puede modificar estas configuraciones según sea necesario.

Incrustación y consulta

• Genere incrustaciones : use la función run_embedding para generar integridades y persistir en la base de datos.
• Incruscaciones de consulta : use la función run_query para consultar la base de datos de los vecinos más cercanos en función de los incrustaciones vectoriales.

Pruebas

El repositorio incluye un conjunto integral de pruebas para garantizar que el sistema funcione correctamente. Para ejecutar las pruebas:

cargo test 

Que contribuye

¡Las contribuciones son bienvenidas! Lea el archivo Contributing.MD para obtener detalles sobre cómo contribuir a este proyecto.

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.

---

Siéntase libre de personalizar este readme en función de sus necesidades específicas y detalles del proyecto.