Skip to content

2.0.0 - API changes, new features, improvements and bug fixes
Compare
Choose a tag to compare
@OvidijusParsiunas OvidijusParsiunas released this 12 Jul 12:02
· 96 commits to main since this release
2.0.0
02d2f38

The long awaited release of Deep Chat 2.0 is finally here!

This release features a number of critical API changes, addition of multiple new features, improvements on the existing ones and a multitude of bug fixes. This would not have been made possible without the continuous support of our open source community and their eagerness to create the best AI chat experience for all! We hope that this version will make it easier for new and existing developers to embed Deep Chat into their website and most that their users would have the best possible chat experience.

API changes:

  • request has been renamed to connect
  • stream property has been moved to connect
  • InitialMessages property has been renamed to history
  • onNewMessage event has been renamed to onMessage. The isInitial property that is passed in the event body has been renamed to isHitory. When listening to event emission from the element, the new-message event name has been changed to message
  • request property in FilesServiceConfig interface has been renamed to connect

New features:

  • adding a new addMessage method which is used to programmatically add new messages into the chat.
  • adding a new setPlaceholderText method which is used to programmatically set the input's placeholder text.
  • the speechToText interface now has three new properties; stopAfterSubmit which is used to control whether the recording stops after user has submitted a message, submitAfterSilence which controls if a message is automatically submitted after a period of silence and events which is used to listen to events emitted by interactions with speech.
  • the openAI interface has been updated to reflect new features provided by the Open AI API.

UX improvements and multiple bug fixes:
When using the new Deep Chat component, you will notice multiple quality of life improvements, such as the ability to have line breaks for the outgoing user messages, better representation for uploaded files in the chat and many other benefits. This has all been realised and developed through consistent feedback from our Open Source community. Please checkout the issues section of our repo to find out how they were implemented.

Switching from v1 to v2:

All of the mentioned API changes are backwards compatible! So don't worry about having to update your configuration when switching to this version from a previous one. The browser console will also display warnings for properties that have been deprecated to help you switch to the new ones, however they can be ignored if they are not useful. If you are using TypeScript - the transition to the new version may introduce a couple of warnings in your build environment, they can be ignored if you want to keep using the old properties.

Thankyou to our sponsors!

The development of this project was greatly assisted by a number of very generous sponsors:

Contributors

techpeace, dorra, and 2 other contributors
Assets 2
Loading