🤖 AsyncGPT 🤖
2 |AsyncGPT is an open-source unofficial asynchronous framework for ChatGPT API written in Python 3.11 using asyncio and aiohttp
3 | 4 | ## Installation 5 | ```bash 6 | pip install git+https://github.com/Just1z/asyncgpt 7 | ``` 8 | 9 | ## Usage 10 | The simplest usage for now: 11 | ```python 12 | import asyncio 13 | import asyncgpt 14 | 15 | 16 | async def main(): 17 | bot = asyncgpt.GPT(apikey="YOUR API KEY") 18 | completion = await bot.chat_complete([{"role": "user", "content": "Hello!"}]) 19 | print(completion) 20 | 21 | 22 | if __name__ == "__main__": 23 | asyncio.run(main()) 24 | # Hello there! How can I assist you today? 25 | ``` 26 | 27 | ## How to get API key? 28 | You should get one on the official OpenAI site 29 | 30 | https://platform.openai.com/account/api-keys 31 | -------------------------------------------------------------------------------- /asyncgpt/__init__.py: -------------------------------------------------------------------------------- 1 | """ PyChatGPT is an open-source unofficial asynchronous framework for ChatGPT API written in Python 3.11 using asyncio and aiohttp """ 2 | from .chatgpt import GPT 3 | -------------------------------------------------------------------------------- /asyncgpt/chatgpt.py: -------------------------------------------------------------------------------- 1 | from typing import Dict, Union 2 | from .types.requests import post 3 | from .types.responses import ChatCompletion, ChatCompletionChoice, Completion, CompletionChoice 4 | from .types.exceptions import AsyncGPTError 5 | 6 | 7 | class GPT: 8 | """Class is used to access ChatGPT method ChatCompletion""" 9 | def __init__(self, apikey: str) -> None: 10 | """ 11 | `apikey`: str 12 | The OpenAI API uses API keys for authentication. 13 | Visit https://platform.openai.com/account/api-keys to retrieve the API key. 14 | Remember that your API key is a secret! 15 | Do not share it with others or expose it in any client-side code (browsers, apps) 16 | """ 17 | if not isinstance(apikey, str): 18 | raise ValueError("apikey should be string") 19 | self.apikey = apikey 20 | 21 | @property 22 | def headers(self): 23 | return {"Content-Type": "application/json", 24 | "Authorization": "Bearer " + self.apikey} 25 | 26 | async def chat_complete( 27 | self, messages: list[Dict[str, str]], 28 | model: str = "gpt-3.5-turbo", 29 | temperature: float = 1.0, top_p: float = 1.0, 30 | stop: Union[str, list] = None, n: int = 1, stream: bool = False, 31 | max_tokens: int = None, presence_penalty: float = 0, 32 | frequency_penalty: float = 0, user: str = None) -> ChatCompletion: 33 | """Given a chat conversation, the model will return a chat completion response. 34 | 35 | `messages`: list[Dict[str, str]], required 36 | The messages to generate chat completions for, in the chat format, e.g. 37 | [ 38 | {"role": "system", "content": "You are a helpful assistant."}, 39 | 40 | {"role": "user", "content": "Who won the world series in 2020?"}, 41 | 42 | {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."}, 43 | 44 | {"role": "user", "content": "Where was it played?"} 45 | ] 46 | Visit https://platform.openai.com/docs/guides/chat/introduction for more info 47 | 48 | `temperature`: float, defaults to 1 49 | What sampling temperature to use, between 0 and 2. 50 | Higher values like 0.8 will make the output more random, 51 | while lower values like 0.2 will make it more focused and deterministic. 52 | We generally recommend altering this or `top_p` but not both. 53 | 54 | `top_p`: float, defaults to 1 55 | An alternative to sampling with temperature, called nucleus sampling, where the model 56 | considers the results of the tokens with top_p probability mass. 57 | So 0.1 means only the tokens comprising the top 10% probability mass are considered. 58 | We generally recommend altering this or `temperature` but not both. 59 | 60 | `n`: int, defaults to 1 61 | How many chat completion choices to generate for each input message. 62 | 63 | `stream`: bool, defaults to False 64 | If set, partial message deltas will be sent, like in ChatGPT. 65 | Tokens will be sent as data-only server-sent events as they become available, 66 | with the stream terminated 67 | by a `data: [DONE]` message 68 | 69 | `stop`: str or list, defaults to None 70 | Up to 4 sequences where the API will stop generating further tokens. 71 | 72 | `max_tokens`: int, defaults to inf 73 | The maximum number of tokens allowed for the generated answer. 74 | 75 | `presence_penalty`: float, defaults to 0 76 | Number between -2.0 and 2.0. Positive values penalize new tokens based on 77 | whether they appear in the text so far, increasing the model's likelihood 78 | to talk about new topics. 79 | Learn more at https://platform.openai.com/docs/api-reference/parameter-details 80 | 81 | `frequency_penalty`: float, defaults to 0 82 | Number between -2.0 and 2.0. Positive values penalize new tokens based on 83 | their existing frequency in the text so far, decreasing the model's 84 | likelihood to repeat the same line verbatim. 85 | Learn more at https://platform.openai.com/docs/api-reference/parameter-details 86 | 87 | `user`: str, default to None 88 | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. 89 | Learn more at https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids 90 | """ 91 | if not all((messages[0].get("role"), messages[0].get("content"))): 92 | raise ValueError("Invalid messages object") 93 | params = { 94 | "model": model, "messages": messages, 95 | "temperature": float(temperature), "top_p": float(top_p), 96 | "stop": stop, "n": int(n), "stream": bool(stream), 97 | "max_tokens": max_tokens, 98 | "presence_penalty": float(presence_penalty), 99 | "frequency_penalty": float(frequency_penalty) 100 | } 101 | if user: 102 | params["user"] = user 103 | response = await post( 104 | "https://api.openai.com/v1/chat/completions", 105 | json=params, headers=self.headers) 106 | if "error" in response: 107 | raise AsyncGPTError(f"{response['error']['type']}: {response['error']['message']}") 108 | return ChatCompletion( 109 | id=response["id"], created=response["created"], 110 | usage=response["usage"], 111 | choices=[ChatCompletionChoice(**choice) for choice in response["choices"]] 112 | ) 113 | 114 | async def complete( 115 | self, prompt: str = "", 116 | model: str = "text-davinci-003", suffix: str = None, 117 | temperature: float = 1.0, top_p: float = 1.0, echo: bool = False, 118 | stop: Union[str, list] = None, n: int = 1, stream: bool = False, 119 | best_of: int = 1, logprobs: int = None, 120 | max_tokens: int = None, presence_penalty: float = 0, 121 | frequency_penalty: float = 0, user: str = None) -> Completion: 122 | """Given a prompt, the model will return a completion response. 123 | 124 | `prompt`: str, defaults to <|endoftext|> 125 | The prompt(s) to generate completions for, encoded as a string, 126 | array of strings, array of tokens, or array of token arrays. 127 | Note that <|endoftext|> is the document separator that the model sees during training, 128 | so if a prompt is not specified the model will generate 129 | as if from the beginning of a new document. 130 | 131 | `suffix`: str, defaults to None 132 | The suffix that comes after a completion of inserted text. 133 | 134 | `max_tokens`: int, defaults to inf 135 | The maximum number of tokens to generate in the completion. 136 | The token count of your prompt plus `max_tokens` cannot exceed 137 | the model's context length. Most models have a context length of 2048 tokens 138 | (except for the newest models, which support 4096). 139 | 140 | `temperature`: float, defaults to 1 141 | What sampling temperature to use, between 0 and 2. 142 | Higher values like 0.8 will make the output more random, 143 | while lower values like 0.2 will make it more focused and deterministic. 144 | We generally recommend altering this or `top_p` but not both. 145 | 146 | `top_p`: float, defaults to 1 147 | An alternative to sampling with temperature, called nucleus sampling, where the model 148 | considers the results of the tokens with top_p probability mass. 149 | So 0.1 means only the tokens comprising the top 10% probability mass are considered. 150 | We generally recommend altering this or `temperature` but not both. 151 | 152 | `n`: int, defaults to 1 153 | How many completions to generate for each prompt. 154 | Note: Because this parameter generates many completions, 155 | it can quickly consume your token quota. 156 | Use carefully and ensure that you have 157 | reasonable settings for max_tokens and stop. 158 | 159 | `stream`: bool, defaults to False 160 | If set, partial message deltas will be sent, like in ChatGPT. 161 | Tokens will be sent as data-only server-sent events as they become available, 162 | with the stream terminated 163 | by a `data: [DONE]` message 164 | 165 | `logprobs`: int, defaults to None 166 | Include the log probabilities on the `logprobs` most likely tokens, 167 | as well the chosen tokens. For example, if `logprobs` is 5, the API 168 | will return a list of the 5 most likely tokens. The API will always 169 | return the `logprob` of the sampled token, so there may be 170 | up to `logprobs+1` elements in the response. 171 | 172 | `echo`: bool, defaults to False 173 | Echo back the prompt in addition to the completion 174 | 175 | `stop`: str or list, defaults to None 176 | Up to 4 sequences where the API will stop generating further tokens. 177 | 178 | `presence_penalty`: float, defaults to 0 179 | Number between -2.0 and 2.0. Positive values penalize new tokens based on 180 | whether they appear in the text so far, increasing the model's likelihood 181 | to talk about new topics. 182 | Learn more at https://platform.openai.com/docs/api-reference/parameter-details 183 | 184 | `frequency_penalty`: float, defaults to 0 185 | Number between -2.0 and 2.0. Positive values penalize new tokens based on 186 | their existing frequency in the text so far, decreasing the model's 187 | likelihood to repeat the same line verbatim. 188 | Learn more at https://platform.openai.com/docs/api-reference/parameter-details 189 | 190 | `best_of`: int, defaults to 1 191 | Generates `best_of` completions server-side and returns the "best" 192 | (the one with the highest log probability per token). Results cannot be streamed. 193 | When used with `n`, `best_of` controls the number of candidate completions and 194 | `n` specifies how many to return - `best_of` must be greater than `n`. 195 | Note: Because this parameter generates many completions, it can 196 | quickly consume your token quota. Use carefully and ensure that 197 | you have reasonable settings for `max_tokens` and `stop`. 198 | 199 | `user`: str, default to None 200 | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. 201 | Learn more at https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids 202 | """ 203 | params = { 204 | "model": model, "prompt": prompt, "suffix": suffix, 205 | "temperature": float(temperature), "top_p": float(top_p), 206 | "stop": stop, "n": int(n), "stream": bool(stream), 207 | "max_tokens": max_tokens, "echo": echo, 208 | "logprobs": logprobs, "best_of": best_of, 209 | "presence_penalty": float(presence_penalty), 210 | "frequency_penalty": float(frequency_penalty) 211 | } 212 | if user: 213 | params["user"] = user 214 | response = await post( 215 | "https://api.openai.com/v1/completions", 216 | json=params, headers=self.headers) 217 | if "error" in response: 218 | raise AsyncGPTError(f"{response['error']['type']}: {response['error']['message']}") 219 | return Completion( 220 | id=response["id"], created=response["created"], 221 | usage=response["usage"], model=model, 222 | choices=[CompletionChoice(**choice) for choice in response["choices"]] 223 | ) 224 | -------------------------------------------------------------------------------- /asyncgpt/types/___init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Just1z/asyncgpt/7582343e517d8d14fc9d41b88e44b901c202135f/asyncgpt/types/___init__.py -------------------------------------------------------------------------------- /asyncgpt/types/exceptions.py: -------------------------------------------------------------------------------- 1 | class AsyncGPTError(Exception): 2 | pass 3 | -------------------------------------------------------------------------------- /asyncgpt/types/requests.py: -------------------------------------------------------------------------------- 1 | from aiohttp import ClientSession 2 | 3 | 4 | async def post(url, json, headers): 5 | async with ClientSession() as session: 6 | response = await session.post(url, json=json, headers=headers) 7 | response = await response.json() 8 | return response -------------------------------------------------------------------------------- /asyncgpt/types/responses/__init__.py: -------------------------------------------------------------------------------- 1 | from .chatcompletion import ChatCompletion, ChatCompletionChoice 2 | from .completion import Completion, CompletionChoice 3 | -------------------------------------------------------------------------------- /asyncgpt/types/responses/chatcompletion.py: -------------------------------------------------------------------------------- 1 | from typing import Dict 2 | from dataclasses import dataclass 3 | 4 | 5 | @dataclass 6 | class ChatCompletionChoice: 7 | index: int 8 | message: Dict[str, str] 9 | finish_reason: str 10 | 11 | def __str__(self) -> str: 12 | return self.message["content"] 13 | 14 | 15 | @dataclass 16 | class ChatCompletion: 17 | id: str 18 | created: int 19 | choices: list[ChatCompletionChoice] 20 | usage: Dict[str, int] 21 | object: str = "chat.completion" 22 | 23 | def __str__(self) -> str: 24 | return str(self.choices[0]) 25 | -------------------------------------------------------------------------------- /asyncgpt/types/responses/completion.py: -------------------------------------------------------------------------------- 1 | from typing import Dict 2 | from dataclasses import dataclass 3 | 4 | 5 | @dataclass 6 | class CompletionChoice: 7 | text: str 8 | index: int 9 | logprobs: int 10 | finish_reason: str 11 | 12 | def __str__(self) -> str: 13 | return self.text 14 | 15 | 16 | @dataclass 17 | class Completion: 18 | id: str 19 | created: int 20 | model: str 21 | choices: list[CompletionChoice] 22 | usage: Dict[str, int] 23 | object: str = "text_completion" 24 | 25 | def __str__(self) -> str: 26 | return str(self.choices[0]) 27 | -------------------------------------------------------------------------------- /examples/chatcompletion.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import asyncgpt 3 | 4 | 5 | async def main(): 6 | bot = asyncgpt.GPT(apikey="YOUR API KEY") 7 | completion = await bot.chat_complete([{"role": "user", "content": "Hello!"}]) 8 | print(completion) 9 | 10 | 11 | if __name__ == "__main__": 12 | asyncio.run(main()) 13 | # Hello there! How can I assist you today? 14 | -------------------------------------------------------------------------------- /examples/completion.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import asyncgpt 3 | 4 | 5 | async def main(): 6 | bot = asyncgpt.GPT(apikey="YOUR API KEY") 7 | completion = await bot.complete("Say this is a test") 8 | print(completion) 9 | 10 | 11 | if __name__ == "__main__": 12 | asyncio.run(main()) 13 | # This is indeed a test 14 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["poetry-core>=1.0.0"] 3 | build-backend = "poetry.core.masonry.api" 4 | 5 | [tool.poetry] 6 | name = "asyncgpt" 7 | version = "1.2.0" 8 | authors = ["Just1z"] 9 | description = "Asynchronus framework for ChatGPT API" 10 | license = "MIT" 11 | readme = "README.md" 12 | classifiers = [ 13 | "Programming Language :: Python :: 3", 14 | "Framework :: AsyncIO", 15 | "Intended Audience :: Developers", 16 | "License :: OSI Approved :: MIT License", 17 | "Operating System :: OS Independent", 18 | "Topic :: Software Development :: Libraries :: Application Frameworks", 19 | ] 20 | homepage="https://github.com/Just1z/asyncgpt" 21 | repository="https://github.com/Just1z/asyncgpt" 22 | keywords = [ 23 | "chatgpt", "gpt", "async", "api", "openai", 24 | "framework", "asyncio", "wrapper"] 25 | 26 | [tool.poetry.dependencies] 27 | python = "^3.10" 28 | aiohttp = {version="^3.8.4"} 29 | 30 | [tool.poetry.urls] 31 | "Bug Tracker" = "https://github.com/Just1z/asyncgpt/issues" -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp --------------------------------------------------------------------------------