Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/assafelovic/gpt3-api
A basic Flask API interface for OpenAI GPT3
https://github.com/assafelovic/gpt3-api
Last synced: 3 months ago
JSON representation
A basic Flask API interface for OpenAI GPT3
- Host: GitHub
- URL: https://github.com/assafelovic/gpt3-api
- Owner: assafelovic
- License: mit
- Created: 2022-11-08T06:45:19.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T17:41:02.000Z (almost 2 years ago)
- Last Synced: 2024-08-13T07:07:42.098Z (5 months ago)
- Language: Python
- Size: 17.6 KB
- Stars: 31
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - assafelovic/gpt3-api - A basic Flask API interface for OpenAI GPT3 (Python)
README
# OpenAI Flask API Wrapper
A basic Flask API interface for OpenAI GPT3, ChatGPT, Whisper and Dalle2 including training and examples.
> Features:
- Simple, intuitive codebase - can be extended with ease.
- `Gunicorn` support
- `Docker` support
- Includes both prediction and training GPT3 services
- Includes support for OpenAI moderation for validating responses
## API
| Route | Method | Info |
| --- | --- | --- |
| `/` | **GET** | Get current GPT3 model params
| `/api/v1/predict` | **POST** | Predict GPT3 prompt completion
| `/api/v1/image` | **POST** | Generate Dalle-2 prompt image
| `/api/v1/chat` | **POST** | ChatGPT wrapper including context support
| `/api/v1/transcribe` | **POST** | OpenAI Whisper Transcription
> **Before you run** - Set your OpenAI API Key in .env file
```bash
$ echo 'OPENAI_API_KEY={Your key here}' .env
```
## Quick Start with Docker
```bash
$ git clone https://github.com/assafelovic/gpt3-api.git
$ cd gpt3-api
```
```bash
$ docker-compose up --build
```
The API server will start using the PORT `5005`.
## Usage example
Client sends post request with the params `prompts` (String) and optional params to `http://127.0.0.1:5005/api/v1/predict`
```
POST /api/v1/predict
{
prompt: "What is the meaning of life?",
moderation: true,
max_tokens: 128,
temperature: 0.4
}
```
and the server responds with the predicted result:
```
{
"result": {
"result": "The meaning of life is to find fulfillment and purpose through living a life of value and making a positive contribution to the world.",
"temperature": 0.4,
"max_tokens": 128,
"model": "text-davinci-003",
"moderation": {
"id": "modr-6paOy8KtNPYQdPzDamKYvhQ1GQUGD",
"model": "text-moderation-004",
"results": [
{
"categories": {
"hate": false,
"hate/threatening": false,
"self-harm": false,
"sexual": false,
"sexual/minors": false,
"violence": false,
"violence/graphic": false
},
"category_scores": {
"hate": 3.4930130254906544e-07,
"hate/threatening": 8.722193106658338e-11,
"self-harm": 2.9834368309167303e-09,
"sexual": 4.3741639643712915e-08,
"sexual/minors": 5.4334679117085116e-11,
"violence": 5.354117149636295e-08,
"violence/graphic": 1.3893468597814262e-09
},
"flagged": false
}
]
},
},
"success": true
}
```
## Installation
> **Step #1** - Clone the project
```bash
$ git clone https://github.com/assafelovic/gpt3-api.git
$ cd gpt3-api
```
> **Step #2** - Install dependencies
```bash
$ pip install -r requirements.txt
```
> **Step #3** - setup `flask` command for our app
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
```
> **Step #4** - start development server at `localhost:5005`
```bash
$ flask run
```
---