Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koda7/customgpt-autocomplete-system
https://github.com/koda7/customgpt-autocomplete-system
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/koda7/customgpt-autocomplete-system
- Owner: Koda7
- Created: 2024-02-11T18:02:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-11T21:01:54.000Z (11 months ago)
- Last Synced: 2024-02-12T21:49:30.572Z (11 months ago)
- Language: Python
- Size: 11.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CustomGPT-Autocomplete-System
## Description
This project aims to build a simple autocomplete system. The service provides suggestions to users based on their input query, utilizing a lookup mechanism to suggest the most relevant queries based on their frequency of occurrence.
## Features
- Simple autocomplete functionality using FastAPI.
- Efficient lookup mechanism to suggest relevant queries.
- Input query validation and parameter handling.
- Preprocessing script to prepare data for the autocomplete service.
## Installation
1. Clone this repository to your local machine:
```
git clone https://github.com/Koda7/CustomGPT-Autocomplete-System.git
```
2. Install the required dependencies:
```
pip3 install fastapi
pip3 install pandas
```
3. Run the preprocessing script to prepare the data:
```
python3 main.py
```
4. Start the FastAPI server:
```
python3 api.py
```
5. Access the autocomplete service by sending GET requests to the endpoint /query:
Example: In the URL http://localhost:8000/query?query=how&count=1 -
- Base URL: http://localhost:8000
- Endpoint: /query
- Query parameters:
query=how: This parameter represents the input query string. It is set to "how".
count=1: This parameter specifies the number of autocomplete suggestions to return. It is set to 1.