| Name | askGPT JSON |
| Version |
0.7.6
JSON |
| download |
| home_page | |
| Summary | askGPT is a simple command line tool for interacting with OpenAI's API. |
| upload_time | 2023-10-24 18:05:39 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
openai
gpt-3
cli
cmd2
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
askGPT
======
```
:|11; _ ____ ____ _____
20;::20 __ _ ___| | __/ ___| _ \_ _|
10|:;2$ / _` / __| |/ / | _| |_) || |
|&2' | (_| \__ \ <| |_| | __/ | |
'''''''''''':&1 ''''''''''' \__,_|___/_|\_\\____|_| |_|
|21111111111111111111111111111121
18: 20
0$ ';;; :;;: |&:
2218$ 22|;101 :01;;10: |&12
:&; $$ 82:':02 ;8|''|8; |&
:&; $$ ;111: '|11|' |&
1218$ :211|112| |&22
$$ ':::' |&:
18; '$$
;2212: ';11111111111111111112|
82 ;1221:
0021;
''
```
***Disclaimer***: The advice provided by askGPT is intended for informational and entertainment purposes only. It should not be used as a substitute for professional advice, and we cannot be held liable for any
damages or losses arising from the use of the advice provided by askGPT.
***askGPT*** is a command line program written in Python that allows you to query the chatGPT API. It keeps track of conversations and has a set of scenarios to focus the conversation.
## Run with docker Latest release
```
docker run -i cyborgfi/askgpt:latest
```
## Run with docker development version
```
docker run -i cyborgfi/askgpt:dev
```
## Installation
To install askGPT , simply run the following command:
```
pip install askGPT
```
or for cutting edge code, not to be used in production:
```
git clone https://github.com/meirm/askGPT.git
cd askGPT
python -m build
pip install .
```
## Usage
Once installed, you can use ***askGPT*** by running the following command:
```
askgpt
```
Once inside the shell you can run the /help command.
## Install
pip install askGPT
or
git clone https://github.com/meirm/askGPT.git
cd askGPT
python setup.py install
## Available commands
/clone
Clone a conversation
/config
Shows the current configuration
/credentials
Set the necessary credentials to interact with openAI
/delete
Deletes the specified conversation
/dream
Retrieves from openAI a image based on the prompt
/edit
Edit your conversation
/exec
Execute a the rest of the line in a bash shell and print the output
/exit
Exit the program
/greetings
if args is one of the scenarios, print the greeting of that scenario
...
/help
Show available commands and options
/man
/show <config|scenarios|subjects|models>
### Configuration
***askGPT*** will create a config.toml on your .askGPT folder. You can see or change values calling ***askGPT*** config
The content of the file by default is the following:
```
name = "askGPT"
[default]
maxTokens = 150
model = "text-davinci-003"
temperature = 0.0
topP = 1
frequencyPenalty = 0.0
presencePenalty = 0.0
showDisclaimer = true
maxRetries = 3
retryDelay = 5.0
retryMultiplier = 2.0
retryMaxDelay = 60.0
## Optional when running an opensource model through lm studio
# api_base = "http://localhost:1234/v1"
```
## scenarios
***askGPT*** repository includes a sample of several scenarios which you can use to preset your bot.
* Doctor
* Psychotherapist
* Lawyer
* Marv (from The HitchHicker guide to the galaxy)
* VocationalTest
* scenariolityAssessment
* DiaryAssistance
* veganCheff
When you first run askGPT, it will copy the ***scenario.json*** file from the package into your .askGPT directory
In the git repository under ***config*** you can find the latest file named ***scenarios.json***
copy this file to ***.askGPT*** directory
***askGPT*** allows you to use scenarios to focus the conversation. scenarios are defined as follows:
```
{"<scenario>": {"name": "<name>", "greetings": "<Initial sentence>", "conversation": [ {"role":"user", "content":"<your initial prompt>"},{"role": "assistant", "content": "<AI response>"}, ... ]}}
```
Where `<scenario>` is the name of the scenario, `<name>` is the name of the character, `<initial sentence>` is the initial sentence used to start the conversation, and `<prompt>` is an array of sentences between the user and ***askGPT*** .
i.e.
```
"AlbertoKnox":{"Name": "Knox", "greetings":"I am Alberto Knox, the philosopher from Sophia's world. I am also a chatbot", "conversation":[
{"role": "user", "content": "What's your role in the book?"},
{"role": "assistant", "content": "The ideal philosopher. I am never quick to judge and I always thinks about what I am doing."}
]}
```
In the git repository under config you have a sample json with a few scenariolities. Copy the file to $HOME/.***askGPT***
## API Key
In order to communicate with openai API you need to register at https://www.openai.com and create an API key. Once you have your API key, you can use them to authenticate with ***askGPT*** .
## Summary
***askGPT*** is a command line program written in Python that allows you to query the chatGPT API. It keeps track of conversations and has a set of scenarios to focus the conversation. Installation is easy,
simply run `pip install askGPT ` and you're ready to go. Authentication requires an API key and organization code from OpenAI. With ***askGPT*** , you can easily query the chatGPT API and have meaningful conversations with AI.
You can also list the scenarios, list conversations, show the content of a conversation, delete it, and fine tune parameters such as temperature for more scenariolized conversations.
## Contributing
We welcome contributions to ***askGPT***! If you have an idea for a new feature or have found a bug, please open an issue on the GitHub repository.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Next
* Adding support for other languages.
## Note
This project is under active development.
Raw data
{
"_id": null,
"home_page": "",
"name": "askGPT",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "openai,gpt-3,cli,cmd2",
"author": "",
"author_email": "Meir Michanie <meirm@riunx.com>",
"download_url": "https://files.pythonhosted.org/packages/48/87/4308529fb30cd539cf0e4412583c48663e9ee195cd22bc752413d42a8282/askGPT-0.7.6.tar.gz",
"platform": null,
"description": "askGPT\n======\n```\n :|11; _ ____ ____ _____\n 20;::20 __ _ ___| | __/ ___| _ \\_ _|\n 10|:;2$ / _` / __| |/ / | _| |_) || |\n |&2' | (_| \\__ \\ <| |_| | __/ | |\n '''''''''''':&1 ''''''''''' \\__,_|___/_|\\_\\\\____|_| |_|\n |21111111111111111111111111111121\n 18: 20\n 0$ ';;; :;;: |&:\n 2218$ 22|;101 :01;;10: |&12\n :&; $$ 82:':02 ;8|''|8; |&\n :&; $$ ;111: '|11|' |&\n 1218$ :211|112| |&22\n $$ ':::' |&:\n 18; '$$\n ;2212: ';11111111111111111112|\n 82 ;1221:\n 0021;\n ''\n \n \n\n ```\n\n***Disclaimer***: The advice provided by askGPT is intended for informational and entertainment purposes only. It should not be used as a substitute for professional advice, and we cannot be held liable for any\ndamages or losses arising from the use of the advice provided by askGPT.\n\n***askGPT*** is a command line program written in Python that allows you to query the chatGPT API. It keeps track of conversations and has a set of scenarios to focus the conversation.\n\n## Run with docker Latest release\n```\ndocker run -i cyborgfi/askgpt:latest \n```\n## Run with docker development version\n```\ndocker run -i cyborgfi/askgpt:dev \n```\n## Installation\n\nTo install askGPT , simply run the following command:\n\n```\npip install askGPT \n```\nor for cutting edge code, not to be used in production:\n```\ngit clone https://github.com/meirm/askGPT.git\ncd askGPT \npython -m build\npip install .\n```\n## Usage\n\nOnce installed, you can use ***askGPT*** by running the following command:\n\n```\naskgpt \n```\n\nOnce inside the shell you can run the /help command.\n\n## Install \n pip install askGPT\n\nor\n\n git clone https://github.com/meirm/askGPT.git\n cd askGPT \n python setup.py install\n \n## Available commands\n \n /clone\n Clone a conversation\n\n /config\n Shows the current configuration\n\n /credentials\n Set the necessary credentials to interact with openAI\n\n /delete\n Deletes the specified conversation\n\n /dream\n Retrieves from openAI a image based on the prompt\n\n /edit\n Edit your conversation\n\n /exec\n Execute a the rest of the line in a bash shell and print the output\n\n /exit\n Exit the program\n\n /greetings\n if args is one of the scenarios, print the greeting of that scenario\n\n ...\n\n /help\n Show available commands and options\n\n /man\n\n \n /show <config|scenarios|subjects|models>\n\n \n\n### Configuration\n\n***askGPT*** will create a config.toml on your .askGPT folder. You can see or change values calling ***askGPT*** config\n\nThe content of the file by default is the following:\n```\nname = \"askGPT\"\n\n[default]\nmaxTokens = 150\nmodel = \"text-davinci-003\"\ntemperature = 0.0\ntopP = 1\nfrequencyPenalty = 0.0\npresencePenalty = 0.0\nshowDisclaimer = true\nmaxRetries = 3\nretryDelay = 5.0\nretryMultiplier = 2.0\nretryMaxDelay = 60.0\n## Optional when running an opensource model through lm studio\n# api_base = \"http://localhost:1234/v1\"\n\n```\n \n## scenarios\n***askGPT*** repository includes a sample of several scenarios which you can use to preset your bot.\n* Doctor\n* Psychotherapist\n* Lawyer\n* Marv (from The HitchHicker guide to the galaxy)\n* VocationalTest\n* scenariolityAssessment\n* DiaryAssistance\n* veganCheff\n\nWhen you first run askGPT, it will copy the ***scenario.json*** file from the package into your .askGPT directory\nIn the git repository under ***config*** you can find the latest file named ***scenarios.json*** \n\ncopy this file to ***.askGPT*** directory\n\n***askGPT*** allows you to use scenarios to focus the conversation. scenarios are defined as follows:\n\n```\n{\"<scenario>\": {\"name\": \"<name>\", \"greetings\": \"<Initial sentence>\", \"conversation\": [ {\"role\":\"user\", \"content\":\"<your initial prompt>\"},{\"role\": \"assistant\", \"content\": \"<AI response>\"}, ... ]}}\n```\n\nWhere `<scenario>` is the name of the scenario, `<name>` is the name of the character, `<initial sentence>` is the initial sentence used to start the conversation, and `<prompt>` is an array of sentences between the user and ***askGPT*** .\n\n\ni.e.\n```\n\"AlbertoKnox\":{\"Name\": \"Knox\", \"greetings\":\"I am Alberto Knox, the philosopher from Sophia's world. I am also a chatbot\", \"conversation\":[\n {\"role\": \"user\", \"content\": \"What's your role in the book?\"},\n {\"role\": \"assistant\", \"content\": \"The ideal philosopher. I am never quick to judge and I always thinks about what I am doing.\"}\n]}\n```\n\nIn the git repository under config you have a sample json with a few scenariolities. Copy the file to $HOME/.***askGPT*** \n\n## API Key \nIn order to communicate with openai API you need to register at https://www.openai.com and create an API key. Once you have your API key, you can use them to authenticate with ***askGPT*** .\n\n## Summary\n\n***askGPT*** is a command line program written in Python that allows you to query the chatGPT API. It keeps track of conversations and has a set of scenarios to focus the conversation. Installation is easy, \nsimply run `pip install askGPT ` and you're ready to go. Authentication requires an API key and organization code from OpenAI. With ***askGPT*** , you can easily query the chatGPT API and have meaningful conversations with AI. \nYou can also list the scenarios, list conversations, show the content of a conversation, delete it, and fine tune parameters such as temperature for more scenariolized conversations.\n\n## Contributing\nWe welcome contributions to ***askGPT***! If you have an idea for a new feature or have found a bug, please open an issue on the GitHub repository.\n\n## License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n\n## Next\n\n* Adding support for other languages.\n\n## Note\n\n This project is under active development.\n",
"bugtrack_url": null,
"license": "",
"summary": "askGPT is a simple command line tool for interacting with OpenAI's API.",
"version": "0.7.6",
"project_urls": {
"Bug Tracker": "https://github.com/meirm/askGPT/issues",
"Homepage": "https://github.com/meirm/askGPT"
},
"split_keywords": [
"openai",
"gpt-3",
"cli",
"cmd2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48874308529fb30cd539cf0e4412583c48663e9ee195cd22bc752413d42a8282",
"md5": "e97cdc73062194b047d97ac156957c40",
"sha256": "e9867bd825a1e8a662b29eb9ed7f5f04879334a20dc67e951291d4e59533bbc5"
},
"downloads": -1,
"filename": "askGPT-0.7.6.tar.gz",
"has_sig": false,
"md5_digest": "e97cdc73062194b047d97ac156957c40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 612288,
"upload_time": "2023-10-24T18:05:39",
"upload_time_iso_8601": "2023-10-24T18:05:39.071703Z",
"url": "https://files.pythonhosted.org/packages/48/87/4308529fb30cd539cf0e4412583c48663e9ee195cd22bc752413d42a8282/askGPT-0.7.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-24 18:05:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "meirm",
"github_project": "askGPT",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "askgpt"
}
