Package io.jmix.aitools.dataload.generation

Interface EntityDataLoadUserMessageComposer

All Known Implementing Classes:
DefaultEntityDataLoadUserMessageComposer
public interface EntityDataLoadUserMessageComposer
Composes the user message a generation request is sent to the model as: the natural-language prompt followed by the constraints of the request — the available parameters and how each is bound, the required result properties, the row-count hint — phrased for the model. Keeps that phrasing, and the add-on rules it implies, inside the add-on rather than at each caller.

An implementation supplies only the constraints wording (composeConstraints(io.jmix.aitools.dataload.generation.EntityDataLoadGenerationRequest)); how the message is assembled from it is the default of compose(io.jmix.aitools.dataload.generation.EntityDataLoadGenerationRequest).

  • Method Details

    • composeConstraints

      String composeConstraints(EntityDataLoadGenerationRequest request)
      Phrases the constraints of a request for the model.
      Parameters:
      request - the generation request
      Returns:
      the constraints part of the user message, or "" when the request carries none

    • compose

      default String compose(EntityDataLoadGenerationRequest request)
      Composes the whole user message for a request.
      Parameters:
      request - the generation request
      Returns:
      the prompt followed by its constraints, or the prompt alone when the request carries none