Skip to main content

What is EventCatlaog AI assistant?

Added in eventcatalog@2.24.2
License: Dual-license
warning

EventCatalog Chat is currently in beta. If you find any issues, please let us know on Discord.

EventCatalog Chat is a chat interface that allows you to ask questions about your catalog.

You can see a demo of the feature here (note: on first load the model will be downloaded to your browser, this may take a couple of minutes).

Use cases​

  • Quickly find messages related to your features
  • Find resources, ask questions and dive deeper into your catalog
  • Code generation from your messages, services, and domains

Features​

  • In-browser privacy: All AI models run locally (client side) on your hardware, ensuring that your data is processed only on your pc. No server-side processing!
  • Chat history: Access and manage your conversation history.
  • Code generation: Generate code from your messages, services, and domains.
  • Coming soon: Bring your own keys (BYOK) for your own models

Browser support​

By default, WebGPU is enabled and supported in both Chrome and Edge. However, it is possible to enable it in Firefox and Firefox Nightly. Check the browser compatibility for more information.

Hardware requirements​

To run the models efficiently, you'll need a GPU with enough memory. 7B models require a GPU with about 6GB memory whilst 3B models require around 3GB.

Smaller models might not be able to process file embeddings as efficient as larger ones.

You can configure which model to use in the eventcatalog.config.js file.

How does it work?​

EventCatalog Chat uses a local-first approach to keep your data secure and local. Models are downloaded to your browser, and your catalog is used as a source of reference. The model will use vector embeddings to find the most relevant information in your catalog.

How it works

Quick setup​

  1. First you create the embeddings for your catalog, this is done using the @eventcatalog/generator-ai plugin.
  2. You configure your eventcatalog.config.js file to enable the AI assistant.
  3. You can now start chatting with your catalog.
    • The first time you start the chat, the model will be downloaded to your browser (this can take a couple of minutes)
    • Subsequent chats will use the model that is cached in your browser.

Commercial use​

During beta, this feature is free to use.

Once released this feature will be governed by a dual-license. To ensure the sustainability of the project.

If you would like to use this feature in a commercial product, you can purchase a license by emailing us at hello@eventcatalog.dev.

Have any questions? You can email us at hello@eventcatalog.dev.