Skip to main content

5E OAI Assistants Manager

The data manageable on this page are associated with the OpenAI API Key set in the "Assistant Manager"

Additionally, the Plugin provides 4 different ways to feed assistants with information.

  • List all Assistants
    • Create/Delete assistants
    • Creating assistants
      • Only Requirement: "Name".
      • Set the model: "gpt-4-turbo", "gpt-4o" or "gpt-4o-mini".
        • "gpt-4o-mini" is the probably cheapest, while smartest model available out there.
      • Instructions, freely editable.
        • With solid defaults out of the box.
        • The plugin attempts to identify instruction issues that may result from tool selection.
      • Set the temperature (creativity: "0,1 less" to "2,0 much").
      • Assistant Capabilities, tools for assistants.
        • Also known as "Functions"
        • Tools like: "product_search", "get_payment_methods", etc.
        • Choose from 20 tools made and optimized for Shopwares underlying system (Symfony and vue.js).
      • Attach a vector store to the assistant.
        • According to OpenAI, you can attach up to 10,000 files to a vector store. We haven't tested this so far, though.
        • Attaching a vector store enables the "file_search" tool.
          • Perfect to process text formats like: (.txt, .md, .json, .doc, .docx, .html, .pptx, .pdf).
      • Attach files to the assistant.
        • Attached files enables the "code_interpreter" tool. The "code_interpreter" expects structured data in files.
      • Or use both, attach a vector store and files to any of your assistants.
  • List all Files
    • Not initialized.
    • Lists your files on the OpenAI API server, associated with the API-KEY.
    • Upload / Delete files from OpenAI.
      • Files uploaded here have the purpose "assistants".
      • Files can not be downloaded or viewed after the upload (OpenAI restriction).
    • If you select a file, a custom page opens.
      • Details page (though not much to see here).
      • Delete file from OpenAI.
  • List all Vector Stores
    • Not initialized.
    • Lists all your vector stores on the OpenAI API server, associated with the API-KEY.
    • Create/Delete vector stores.
    • If you select a vector store, a custom page opens, that allows:
      • Edit the name of the storage.
      • Attach pre-uploaded files to the storage (OpenAI allows to attach 10,000 files).
        • Upload from the vector_store details page.
      • Detach files from the storage.
        • Note: Adding a file to a vector store automatically parses, chunks, embeds and stores the file in a vector database that's capable of both keyword and semantic search.
      • Delete the vector store.
        • Only vector stores without attached files can be deleted.
  • Storage Manager (temp cache, internal use)
    • This is for internal use only, it stores requested data from OpenAI for further requests within the session.
      • Stores (only retrieved lists of data, no IDs), lists for: "assistants", "files", "vector_stores", "models".
    • And some processed data, to avoid processing them repeatedly within the session.

Instructions note

All occurrences of curly braces have to be escaped with a backslash. Ideally wrapped in markdown formatted blocks

* Remove leading and trailing slash
\```json
\{
    "some": "JSON data"
\}
```\