Skip to main content
v1

Local Development

Prerequisites

  • Java 21
  • Spring-compatible host app
  • PostgreSQL + ConvEngine ce_* schema
  • LlmClient implementation bean

Minimal integration

Enable ConvEngine
package: your.app
JAVA
@EnableConvEngine
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}

Required runtime beans from consumer side

  • LlmClient
  • datasource + JPA config
  • any custom hooks/transformers you need
  1. Send one turn to /message
  2. Read /audit/{conversationId}
  3. Read /audit/{conversationId}/trace
  4. Tune DB rows and rerun same conversation id

Transport toggles

application.yml
YAML
When enabling STOMP

Keep SSE enabled initially. Use STOMP only when your client architecture needs bidirectional websocket semantics.

Optional feature annotations

Enable optional performance features
JAVA
@EnableConvEngine(stream = true)
@EnableConvEngineAsyncAuditDispatch
@EnableConvEngineStompBrokerRelay
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
Stream flag behavior

With @EnableConvEngine(stream = true) (default), startup fails if both SSE and STOMP are disabled.
With @EnableConvEngine(stream = false), transport flags are ignored and only REST flow is active.