https://github.com/lostovayne/profanity-api
API built using Typescript and Honojs, connected to a vector database using an embedding of Upstash to compare similar words and phrases and determine if they are insults etc.
https://github.com/lostovayne/profanity-api
bun cloudflare honojs typescript upstash-vector
Last synced: about 1 month ago
JSON representation
API built using Typescript and Honojs, connected to a vector database using an embedding of Upstash to compare similar words and phrases and determine if they are insults etc.
- Host: GitHub
- URL: https://github.com/lostovayne/profanity-api
- Owner: Lostovayne
- Created: 2025-01-29T22:55:14.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-06T04:13:58.000Z (3 months ago)
- Last Synced: 2025-02-06T05:23:54.115Z (3 months ago)
- Topics: bun, cloudflare, honojs, typescript, upstash-vector
- Language: TypeScript
- Homepage: https://profanity-api.epsaind.workers.dev/
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Profanity API
## Description
The Profanity API was created to provide an endpoint that can quickly and efficiently respond to words or phrases that are considered offensive or inappropriate. Its primary goal is to filter out content that could harm a healthy community, thereby cleaning up chats and fostering a more positive environment. By using this API, developers can help prevent toxic behavior and promote a healthier community.
This API utilizes a vector database for words and similarities, along with Langchain to handle contextual understanding. It offers an easy-to-use interface for integrating profanity detection into applications.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Examples](#examples)
- [Environment Variables](#environment-variables)
- [Contributing](#contributing)
- [License](#license)
## Installation
To install the Profanity API, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/Lostovayne/Profanity-Api.git
```
2. Navigate to the project directory:
```bash
cd Profanity-Api
```
3. Install the dependencies using Bun:
```bash
bun install
```
4. Create the vector database in Upstash.
5. Seed the database with initial data:
```bash
bun run seed.ts
```
## Usage
To use the Profanity API, you need to set up the server and make requests to the endpoints.
### Starting the Server
You can run the server using:
```bash
bun index.ts
```
or using Wrangler:
```bash
bun wrangler dev index.ts
```
## API Endpoints
| Endpoint | Method | Description |
|----------------|--------|---------------------------------|
| `/` | POST | Check for profanity in text |
| `/` | POST | Filter profanity from text |
### Request Parameters
For both endpoints, the request body should be a JSON object containing the following parameter:
- `text` (string): The text to check or filter for profanity.
### Example Request
#### Check for Profanity
```bash
curl -X POST http://localhost:3000/ -d '{"text": "Some text with profanity"}'
```
### Response Format
The API will return a JSON response. Here’s an example response for the `/check` endpoint:
```json
{
"isProfanity": true,
"score": 0.95,
"flaggedFor": "profanity word"
}
```
```
## Environment Variables
You need to set the following environment variables in your `.env` file:
- `VECTOR_URL`: The URL for your Upstash vector database.
- `VECTOR_TOKEN`: The token for authenticating with your Upstash vector database.
Example `.env` file:
```plaintext
VECTOR_URL="https://your-upstash-vector-url"
VECTOR_TOKEN="your-upstash-token"
```
## Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/YourFeature
```
3. Commit your changes:
```bash
git commit -m "Add some feature"
```
4. Push to the branch:
```bash
git push origin feature/YourFeature
```
5. Open a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.