| Name | gptbots JSON |
| Version |
0.1.14
JSON |
| download |
| home_page | |
| Summary | A simple Python package for creating and interacting with GPT-based chatbots |
| upload_time | 2024-01-12 03:35:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
openai
gpt
chatbots
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# gptbots
A simple Python package for creating and interacting with GPT-based chatbots
## Preliminaries
Make sure your OpenAI API key is setup (see [OpenAI's Quickstart tutorial](https://platform.openai.com/docs/quickstart?context=python)).
## Usage
To create a chatbot:
- `bot = gptbots.Chatbot()` creates a chatbot instance with default attributes
- `bot = gptbots.Chatbot(model, temperature, custom_instructions, chatbot_name)` creates a chatbot instance with custom attributes
To chat:
- `bot.chat(prompt)` prints chatbot response to string prompt
See more methods below.
### Attributes
- `model` : default is "gpt-3.5-turbo-1106"; see [OpenAI's documentation on models](https://platform.openai.com/docs/models/) for valid model names
- `temperature` : default is 0.7; ranges from 0.0 to 1.0; higher generally means more creative
- `custom_instructions` : default is "You are a helpful assistant."
- `chatbot_name` : default is "Assistant"
- `context` : contains custom instructions, user messages, and chatbot responses
### Methods
- `chat(prompt)` prints chatbot response to string prompt
- `chat_image(prompt, url)` prints chatbot response to string prompt + image URL when using "gpt-4-vision-preview" (aka GPT-4 Turbo with vision)
- `save(file_path)` saves chat history and settings to preferred file
- `load(file_path)` loads chat history and settings from preferred file
- `print_messages()` prints context without custom instructions in a prettier format
- `print_context()` prints context in a prettier format
Raw data
{
"_id": null,
"home_page": "",
"name": "gptbots",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "openai,gpt,chatbots",
"author": "",
"author_email": "Carl Vincent Escobar <cvescobar112@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/47/65/4fcd615c8ff64b337a3ca09cd18c7cfa976f2e929e90a4f9dd8d21391f1c/gptbots-0.1.14.tar.gz",
"platform": null,
"description": "# gptbots\nA simple Python package for creating and interacting with GPT-based chatbots\n\n## Preliminaries\nMake sure your OpenAI API key is setup (see [OpenAI's Quickstart tutorial](https://platform.openai.com/docs/quickstart?context=python)).\n\n## Usage\nTo create a chatbot:\n- `bot = gptbots.Chatbot()` creates a chatbot instance with default attributes\n- `bot = gptbots.Chatbot(model, temperature, custom_instructions, chatbot_name)` creates a chatbot instance with custom attributes\n\nTo chat:\n- `bot.chat(prompt)` prints chatbot response to string prompt\n\nSee more methods below. \n\n### Attributes\n- `model` : default is \"gpt-3.5-turbo-1106\"; see [OpenAI's documentation on models](https://platform.openai.com/docs/models/) for valid model names\n- `temperature` : default is 0.7; ranges from 0.0 to 1.0; higher generally means more creative\n- `custom_instructions` : default is \"You are a helpful assistant.\"\n- `chatbot_name` : default is \"Assistant\"\n- `context` : contains custom instructions, user messages, and chatbot responses\n\n### Methods\n- `chat(prompt)` prints chatbot response to string prompt\n- `chat_image(prompt, url)` prints chatbot response to string prompt + image URL when using \"gpt-4-vision-preview\" (aka GPT-4 Turbo with vision)\n- `save(file_path)` saves chat history and settings to preferred file\n- `load(file_path)` loads chat history and settings from preferred file\n- `print_messages()` prints context without custom instructions in a prettier format\n- `print_context()` prints context in a prettier format\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple Python package for creating and interacting with GPT-based chatbots",
"version": "0.1.14",
"project_urls": null,
"split_keywords": [
"openai",
"gpt",
"chatbots"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7afba5e6e29c614c80b7d855f96adac2ac7723d7850523c237149c33556227d0",
"md5": "075de1aee9e44f082a253996e38178cc",
"sha256": "76ddc55e01bde39ac30598beb559eaae5fe6f2afb128e89dbc6661c085150be5"
},
"downloads": -1,
"filename": "gptbots-0.1.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "075de1aee9e44f082a253996e38178cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3944,
"upload_time": "2024-01-12T03:35:53",
"upload_time_iso_8601": "2024-01-12T03:35:53.452388Z",
"url": "https://files.pythonhosted.org/packages/7a/fb/a5e6e29c614c80b7d855f96adac2ac7723d7850523c237149c33556227d0/gptbots-0.1.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47654fcd615c8ff64b337a3ca09cd18c7cfa976f2e929e90a4f9dd8d21391f1c",
"md5": "9805623f9952c5f1d90ba138085e5b4c",
"sha256": "6407fd0a66f27d3b4e962f1a2cf68ce87a5b50ba0d4c0cb350d0be5cab06f965"
},
"downloads": -1,
"filename": "gptbots-0.1.14.tar.gz",
"has_sig": false,
"md5_digest": "9805623f9952c5f1d90ba138085e5b4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3561,
"upload_time": "2024-01-12T03:35:55",
"upload_time_iso_8601": "2024-01-12T03:35:55.213134Z",
"url": "https://files.pythonhosted.org/packages/47/65/4fcd615c8ff64b337a3ca09cd18c7cfa976f2e929e90a4f9dd8d21391f1c/gptbots-0.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-12 03:35:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gptbots"
}
