Download the PHP package sitegeist/chatterbox without Composer
On this page you can find all versions of the php package sitegeist/chatterbox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package chatterbox
Sitegeist.Chatterbox
Headless AI Chat with OpenApi backed Endpoint connecting the OpenAi-API with Neos.
Authors & Sponsors
- Bernhard Schmitt - [email protected]
- Melanie Wüst - [email protected]
- Martin Ficzel - [email protected]
The development and the public-releases of this package is generously sponsored by http://www.sitegeist.de.
Installation
Sitegeist.Chatterbox is available via packagist. Run composer require sitegeist/chatterbox to require this package.
You may also want to install flowpack/cors or any other CORS package if you are using the endpoints from different urls .
We use semantic versioning, so every breaking change will increase the major version number.
Setup
- Configure Accounts
At first the OpenAI-Api Connections that are to be used are configured.
- Configure Tools and Knowledge
The tools and knowledge and instructions that can later be assigned to assistants are configured. !!! This does not mean they are used automatically, but they can be selected afterward !!!
- Create Assistants
In the next step assistants can be created in the "Chatterbox AI Assistants" BE Module. Here you assign the account, define the instructions and select the tools knowledge and instructions available to this specific assistant.
- Update Assitants Knowledge
Once an assistant was configured the command ./flow knowledge:upload --account example
- Use API
To actually communicate with the chatbot FE Apis are provieded with a specification that can be accessed via
GET /openapi/document/chatterbox or via cli-command ./flow openapidocument:render chatterbox
The actual communication happen usesing the three endpoints:
- POST /chatterbox/chat/start ... inititate a chat. Returns the answer together with a thread-id that is used in the consecutive calls
- GET /chatterbox/chat/history ... read a full thread
- POST /chatterbox/chat/post ... add a message to a thread
Tools con return metadata in addition to the response that is sent to the OpenAI-API. This allows communicating with the frontend without sending the data to an AI that may or may not be trusted.
Contribution
We will gladly accept contributions. Please send us pull requests.
All versions of chatterbox with dependencies
neos/neos Version *
sitegeist/flow-openaiclientfactory Version ^0.19.0
sitegeist/schemeonyou Version ^1.4.0
symfony/http-client Version ^6.4
league/commonmark Version ~2.4
league/html-to-markdown Version ^5.0