# A Django / Celery scalable OpenAI Assistant Runner.
Assumption: you have Django up and running with Celery.
(Tested on Redis)
1. pip install django_openai_assistant
2. in settings.py
Add 'django_openai_assistant' to your INSTALLED_APPS [] array
make sure to have OPENAI_API_KEY defined in settings with your OpenAI key
create and apply migrations for django_openai_assistant
3. Create a simple Assistant in https://platform.openai.com/assistants
To begin you probably want one with no functions.
Let's say you called it 'Test Assistant'
4. Use the assistant in your code:
demo.py
```
ffrom django_openai_assistant.assistant import assistantTask
from celery import shared_task
# Define OPENAI_API_KEY in your settings.py file
# Add 'django_openai_assistant' to your INSTALLED_APPS in settings.py
# run python manage.py makemigrations django_openai_assistant and then python managey.pymigrate
# create at least one Assistant in https://platform.openai.com/assistants
def testAssistant(request=None):
# replace <<your appname>> with the name you django app this file is in!
# replace <<your assistant name>> with the name of the assistant you created in the OpenAI platform
task = assistantTask(assistantName="<<your assistant name>>", tools= [], completionCall = "<<your appname>>.test:afterRunFunction")
task.prompt = "Who was Napoleon Bonaparte?"
task.createRun() ## this will get everything going!
@shared_task(Name="This will be called once the run is complete")
def afterRunFunction(taskID):
# Function is called when run is completed. MUST be annoted as @shared_task!!!
# start by retrieving the task
task = assistantTask(run_id = taskID)
if task.status == 'completed': ## check to make sure it is completed not failed or something else
print(task.markdownresponse())
else:
print('run failed')
```
See https://medium.com/@jlvalorvc/building-a-scalable-openai-assistant-processor-in-django-with-celery-a61a1af722e0
## Version history:
0.6.0
- since 1.33.00 Openai properly supports the 'vision' file attachment. Now supported here as well.
Based on filetype images are automatically marked as 'vision' and added to the thread as such.
image_extensions = ['jpg', 'jpeg', 'png', 'gif', 'bmp', 'tiff']
- Added getallmessages() and getfullresponse() to easily support threaded responses
- requires openai 1.33.0
0.5.4
- added getallmessages() which returns threads.messages.list( thread_id=self.thread_id) .data
0.5.3
- Added getfullresponse() that comiles all Assistant repsonses in one message
- still waiting for the openai Python library to support vision.
0.5.2
- Updated the file upload mechanism to determine file types (retrieval yes/no and prepare for vision support (image yes/no))
- When attachments are added to a thread they will always have 'tools' enabled and retrieval will only be enabled for the supported file types https://platform.openai.com/docs/assistants/tools/file-search/supported-files
0.5.1
- Remove getopenaiclient() instead use OpenAI() everywhere
- Fix getAssistant() that could fail if retrieving an Assistant by name from an org with more than 20 Assistants.
0.5.0
- Added support for Assistants 2.0. For now all files are added to a thread with support for both search and code completion. For now no support to upload files to a vectorstore to an Assistant.
0.4.3
- Added optional parameter temperature createRun() default is 1, like the OpenAI default
0.4.2
- Added optional parameter temperature createRun() default is 1, like the OpenAI default
0.4.1
- another fix for metadata always returning {} never None
0.4.0
- redo readme.md
- standard version numbering
- task.metadata is now initiatilized as {} to prevent task.metadata.get() from failing.
0.33
- retrieve by thread_id or run_id openaiTask(run_id='run_xxxx').
- asmarkdown(string) available as a function outside class
- retrievefile() to download a file by openai file ID.
- now processing multi response with embedded image.
0.32
- small fixes.
0.31
- made sure that file uploads to openai receive a 'file name' when uploaded.
0.30
- fix to properly differentiate between two functions that start with the same name like 'company'
- and 'companyfind' and throw and exception (istead of a pass) when running in Debug mode when calling tool function.
Raw data
{
"_id": null,
"home_page": null,
"name": "django-openai-assistant",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "Jean-Luc Vanhulst <jl@valor.vc>",
"keywords": "assistants, celery, django, openai",
"author": null,
"author_email": "Jean-Luc Vanhulst <jl@valor.vc>",
"download_url": "https://files.pythonhosted.org/packages/5c/ce/42bd54d374214ad4d909eb818b74f7065d4dce13fad385dc22231448b8e5/django_openai_assistant-0.6.0.tar.gz",
"platform": null,
"description": "# A Django / Celery scalable OpenAI Assistant Runner.\n\nAssumption: you have Django up and running with Celery. \n(Tested on Redis)\n\n1. pip install django_openai_assistant\n\n2. in settings.py\nAdd 'django_openai_assistant' to your INSTALLED_APPS [] array \nmake sure to have OPENAI_API_KEY defined in settings with your OpenAI key \ncreate and apply migrations for django_openai_assistant \n\n3. Create a simple Assistant in https://platform.openai.com/assistants\nTo begin you probably want one with no functions.\nLet's say you called it 'Test Assistant'\n\n4. Use the assistant in your code:\n\ndemo.py\n```\nffrom django_openai_assistant.assistant import assistantTask\nfrom celery import shared_task\n\n # Define OPENAI_API_KEY in your settings.py file\n # Add 'django_openai_assistant' to your INSTALLED_APPS in settings.py\n # run python manage.py makemigrations django_openai_assistant and then python managey.pymigrate\n # create at least one Assistant in https://platform.openai.com/assistants\n\ndef testAssistant(request=None):\n # replace <<your appname>> with the name you django app this file is in!\n # replace <<your assistant name>> with the name of the assistant you created in the OpenAI platform\n task = assistantTask(assistantName=\"<<your assistant name>>\", tools= [], completionCall = \"<<your appname>>.test:afterRunFunction\")\n task.prompt = \"Who was Napoleon Bonaparte?\"\n task.createRun() ## this will get everything going!\n\n@shared_task(Name=\"This will be called once the run is complete\")\ndef afterRunFunction(taskID):\n # Function is called when run is completed. MUST be annoted as @shared_task!!! \n # start by retrieving the task\n task = assistantTask(run_id = taskID)\n if task.status == 'completed': ## check to make sure it is completed not failed or something else\n print(task.markdownresponse())\n else:\n print('run failed')\n```\nSee https://medium.com/@jlvalorvc/building-a-scalable-openai-assistant-processor-in-django-with-celery-a61a1af722e0\n\n## Version history:\n0.6.0\n- since 1.33.00 Openai properly supports the 'vision' file attachment. Now supported here as well. \nBased on filetype images are automatically marked as 'vision' and added to the thread as such.\n image_extensions = ['jpg', 'jpeg', 'png', 'gif', 'bmp', 'tiff']\n\n- Added getallmessages() and getfullresponse() to easily support threaded responses \n- requires openai 1.33.0\n\n0.5.4\n- added getallmessages() which returns threads.messages.list( thread_id=self.thread_id) .data\n0.5.3\n- Added getfullresponse() that comiles all Assistant repsonses in one message\n- still waiting for the openai Python library to support vision.\n0.5.2\n- Updated the file upload mechanism to determine file types (retrieval yes/no and prepare for vision support (image yes/no))\n- When attachments are added to a thread they will always have 'tools' enabled and retrieval will only be enabled for the supported file types https://platform.openai.com/docs/assistants/tools/file-search/supported-files\n\n0.5.1\n- Remove getopenaiclient() instead use OpenAI() everywhere\n- Fix getAssistant() that could fail if retrieving an Assistant by name from an org with more than 20 Assistants.\n\n0.5.0\n- Added support for Assistants 2.0. For now all files are added to a thread with support for both search and code completion. For now no support to upload files to a vectorstore to an Assistant. \n\n0.4.3\n- Added optional parameter temperature createRun() default is 1, like the OpenAI default\n\n0.4.2\n- Added optional parameter temperature createRun() default is 1, like the OpenAI default\n\n0.4.1\n- another fix for metadata always returning {} never None\n\n0.4.0\n- redo readme.md \n- standard version numbering\n- task.metadata is now initiatilized as {} to prevent task.metadata.get() from failing.\n\n0.33\n- retrieve by thread_id or run_id openaiTask(run_id='run_xxxx'). \n- asmarkdown(string) available as a function outside class \n- retrievefile() to download a file by openai file ID. \n- now processing multi response with embedded image.\n\n0.32\n- small fixes. \n\n0.31\n- made sure that file uploads to openai receive a 'file name' when uploaded. \n\n0.30 \n- fix to properly differentiate between two functions that start with the same name like 'company'\n- and 'companyfind' and throw and exception (istead of a pass) when running in Debug mode when calling tool function. ",
"bugtrack_url": null,
"license": null,
"summary": "Django OpenAI Assistant",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/jlvanhulst/django-openai"
},
"split_keywords": [
"assistants",
" celery",
" django",
" openai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1984133710464dd00d4e41a11ff206435e5ad2236cd728b1909f12467b13bc4",
"md5": "b0333b1045dce9d68797640818cd31e5",
"sha256": "76b4a0c906d931e506a1c88a1a6732407accd1decffb890ded69b3bceb2e54a9"
},
"downloads": -1,
"filename": "django_openai_assistant-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0333b1045dce9d68797640818cd31e5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 11529,
"upload_time": "2024-06-11T18:47:48",
"upload_time_iso_8601": "2024-06-11T18:47:48.468450Z",
"url": "https://files.pythonhosted.org/packages/e1/98/4133710464dd00d4e41a11ff206435e5ad2236cd728b1909f12467b13bc4/django_openai_assistant-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5cce42bd54d374214ad4d909eb818b74f7065d4dce13fad385dc22231448b8e5",
"md5": "6a56c7c9ebaf82b30bf21a981b3f23b0",
"sha256": "912da203a38229c2bceff49621dbe5463cac02efc5115e83db1d248f7bb986ba"
},
"downloads": -1,
"filename": "django_openai_assistant-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "6a56c7c9ebaf82b30bf21a981b3f23b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9434,
"upload_time": "2024-06-11T18:47:50",
"upload_time_iso_8601": "2024-06-11T18:47:50.104211Z",
"url": "https://files.pythonhosted.org/packages/5c/ce/42bd54d374214ad4d909eb818b74f7065d4dce13fad385dc22231448b8e5/django_openai_assistant-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 18:47:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jlvanhulst",
"github_project": "django-openai",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "django-openai-assistant"
}
JSON
