https://github.com/yukaty/vector-search-api

FastAPI application implementing book similarity search
https://github.com/yukaty/vector-search-api

docker docker-compose embeddings fastapi ollama openai pgvector postgresql

Last synced: 19 days ago
JSON representation

FastAPI application implementing book similarity search

• Host: GitHub
• URL: https://github.com/yukaty/vector-search-api
• Owner: yukaty
• Created: 2024-11-07T01:52:09.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-29T17:41:12.000Z (23 days ago)
• Last Synced: 2024-11-29T18:30:24.150Z (23 days ago)
• Topics: docker, docker-compose, embeddings, fastapi, ollama, openai, pgvector, postgresql
• Language: Python
• Homepage:
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Vector Search API

A FastAPI application implementing vector similarity search.

## Overview

This project demonstrates how to build a vector similarity search system using:

- PostgreSQL with pgvector extension for vector operations

- OpenAI/Ollama Embedding models for text vectorization

- FastAPI for the REST API interface

- Docker for containerization

## Quick Start

1. Create `.env` in the root directory

    ```bash

    OPENAI_API_KEY=your_openai_api_key

    ```

2. Start the services

   ```bash

   docker compose up --build

   ```

## API Endpoints

Visit http://localhost:8000/docs for the Swagger UI.

## Development

- Update database schema: Edit `postgres/schema.sql`

- Add data: Use `scripts/load_data.py`

- Modify API: Edit files in `api/`