Skip to main content

What is EventCatalog Chat?

Added in eventcatalog@2.24.2
License: Dual-license

EventCatalog Chat is designed to save you and your team time. It's a chat interface that allows you to ask questions about your architecture. You can ask questions about your architecture, and it will return the most relevant information to you.

EventCatalog Chat

Your development teams, product managers, and architects can all benefit from EventCatalog Chat. Finding information about your architecture can be a time consuming activity. EventCatalog Chat can help you save time and get the information you need.

Example use cases:

  • Quickly get the messages related to a feature
    • "I have a new feature that does (X), what events in our architecture are related to this?"
  • Dive deeper into your architecture
    • "I want to know more about the "Order" service, what events are produced and consumed?"
  • Find resources, ask questions and dive deeper into your catalog
    • "I want to know more about the "Payment" domain, what services are related to it?"

In the example below, we are asking EventCatalog Chat to write a JSON schema for a given message following company best practices (with custom prompts).

EventCatalog Chat

With EventCatalog Chat you can bring your own keys (BYOK) for your own models, or use the default model (browser based). If you want better results, you can use your own model.

"EventCatalog is tech agnostic"

Remember, EventCatalog can be generated from any broker, API or system. So you can create your catalog powered by your broker, OpenAPI or AsyncAPI specs and then ask questions about your architecture.

Features​

  • Bring your own keys (BYOK): Bring your own keys for your own models, currently OpenAPI, Anthropic and Google.
  • In-browser models: If you prefer to use free models, you can opt into use our browser based models. If you choose to use the browser based models, your data is never sent to a server and is private.
  • Chat history: Access and manage your conversation history.
  • Code generation: Generate code from your messages, services, and domains.
  • Bring your own prompts: Bring your own prompts to customize the chat experience. Set your own company best practices. Get better results for all your teams using EventCatalog Chat.

How does it work?​

EventCatalog Chat uses the model of your choice to answer your questions. Models are configured in EventCatalog and the model will use vector embeddings to find the most relevant information in your catalog.

Getting started​

  1. Getting started using the OpenAI models
    • You will need to bring your own OpenAI API key.
  2. Getting started using the Anthropic models
    • You will need to bring your own Anthropic API key.
  3. Getting started using the Google models
    • You will need to bring your own Google API key.
  4. Getting started using the browser based models

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.