| Name | promptengine-catapult JSON |
| Version |
0.1.9
JSON |
| download |
| home_page | |
| Summary | PromptEngine is a Python library for conducting interview sessions using OpenAI's ChatGPT model. |
| upload_time | 2023-07-29 20:02:45 |
| maintainer | |
| docs_url | None |
| author | Bharat Bodkhe |
| requires_python | |
| license | |
| keywords |
python
interview
chatbot
ai
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PromptEngine
PromptEngine is a Python library that provides an interface for conducting interview sessions using OpenAI's ChatGPT model. It allows you to interact with the AI assistant to simulate interview conversations and generate responses based on candidate input.
## Installation
You can install PromptEngine using pip:
pip install promptengine
## Prerequisites
Before using PromptEngine, make sure you have the following:
- Python 3.6 or higher
- OpenAI API key
- .env file having following info:
OPENAI_API_KEY = "Your-key"
LOG_MODE=DEBUG
## Usage
Here's an example of how to use PromptEngine:
import promptengine
# Create a PromptEngine instance
prompt_engine = promptengine.PromptEngine(redis_instance)
# Store user data for an interview session
interview_id = "interview-1"
username = "John Doe"
position = "Software Engineer"
skills = "Python, JavaScript"
job_description = "A software engineer responsible for developing web applications."
experience = "5 years of experience in software development."
prompt_engine.store_user_data(
interview_id,
username,
position,
skills,
job_description,
experience
)
# Conduct an interview conversation
state = "ONGOING"
candidate_input = "Tell me about your team management experience."
system_message = prompt_engine.chatAI(interview_id, state, candidate_input)
# Convert voice to text
audio_file = "interview_audio.wav"
transcription = prompt_engine.voiceToText(audio_file)
For detailed API documentation and usage examples, please refer to the documentation.
# Contributing
Contributions to PromptEngine are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
# License
This project is licensed under the MIT License - see the LICENSE file for details.
# Acknowledgments
PromptEngine was inspired by the need to automate interview simulations and make the process more efficient and interactive.
# Contact
For any questions or inquiries, please contact akybharat02@gmail.com.
We hope you find PromptEngine useful! Enjoy conducting interview sessions with AI assistance.
Raw data
{
"_id": null,
"home_page": "",
"name": "promptengine-catapult",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,interview,chatbot,AI",
"author": "Bharat Bodkhe",
"author_email": "akybharat02@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/58/35/80584348cdef5eaf37b96ef44235c98328c394e50f7a1737ffc7748493e0/promptengine_catapult-0.1.9.tar.gz",
"platform": null,
"description": "\n# PromptEngine\n\nPromptEngine is a Python library that provides an interface for conducting interview sessions using OpenAI's ChatGPT model. It allows you to interact with the AI assistant to simulate interview conversations and generate responses based on candidate input.\n\n## Installation\n\nYou can install PromptEngine using pip:\npip install promptengine\n\n\n## Prerequisites\n\nBefore using PromptEngine, make sure you have the following:\n\n- Python 3.6 or higher\n- OpenAI API key\n- .env file having following info:\n OPENAI_API_KEY = \"Your-key\"\n LOG_MODE=DEBUG\n\n## Usage\n\nHere's an example of how to use PromptEngine:\n\nimport promptengine\n\n# Create a PromptEngine instance\nprompt_engine = promptengine.PromptEngine(redis_instance)\n\n# Store user data for an interview session\ninterview_id = \"interview-1\"\nusername = \"John Doe\"\nposition = \"Software Engineer\"\nskills = \"Python, JavaScript\"\njob_description = \"A software engineer responsible for developing web applications.\"\nexperience = \"5 years of experience in software development.\"\n\nprompt_engine.store_user_data(\n interview_id,\n username,\n position,\n skills,\n job_description,\n experience\n)\n\n# Conduct an interview conversation\nstate = \"ONGOING\"\ncandidate_input = \"Tell me about your team management experience.\"\n\nsystem_message = prompt_engine.chatAI(interview_id, state, candidate_input)\n\n# Convert voice to text\naudio_file = \"interview_audio.wav\"\ntranscription = prompt_engine.voiceToText(audio_file)\n\nFor detailed API documentation and usage examples, please refer to the documentation.\n\n# Contributing\nContributions to PromptEngine are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.\n\n# License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n# Acknowledgments\nPromptEngine was inspired by the need to automate interview simulations and make the process more efficient and interactive.\n\n# Contact\nFor any questions or inquiries, please contact akybharat02@gmail.com.\n\nWe hope you find PromptEngine useful! Enjoy conducting interview sessions with AI assistance.\n",
"bugtrack_url": null,
"license": "",
"summary": "PromptEngine is a Python library for conducting interview sessions using OpenAI's ChatGPT model.",
"version": "0.1.9",
"project_urls": null,
"split_keywords": [
"python",
"interview",
"chatbot",
"ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ee2845c334b542967fd79fff080a0701d799f6688f7077b47778d992d86ee33",
"md5": "aa033e46c792f6a7e7373009781b864d",
"sha256": "7dfc6fd468f09402f09cb6ec90e895c21ec271ce773f554460097a123194acd1"
},
"downloads": -1,
"filename": "promptengine_catapult-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa033e46c792f6a7e7373009781b864d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11055,
"upload_time": "2023-07-29T20:02:43",
"upload_time_iso_8601": "2023-07-29T20:02:43.201230Z",
"url": "https://files.pythonhosted.org/packages/0e/e2/845c334b542967fd79fff080a0701d799f6688f7077b47778d992d86ee33/promptengine_catapult-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "583580584348cdef5eaf37b96ef44235c98328c394e50f7a1737ffc7748493e0",
"md5": "b3abac66febf3bc7099bc003b82bc7ff",
"sha256": "128737fbae6359b58465c6f824f76bcd11bf7a6e8f9189e1c3079949b626eb3b"
},
"downloads": -1,
"filename": "promptengine_catapult-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "b3abac66febf3bc7099bc003b82bc7ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9748,
"upload_time": "2023-07-29T20:02:45",
"upload_time_iso_8601": "2023-07-29T20:02:45.927463Z",
"url": "https://files.pythonhosted.org/packages/58/35/80584348cdef5eaf37b96ef44235c98328c394e50f7a1737ffc7748493e0/promptengine_catapult-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-29 20:02:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "promptengine-catapult"
}
