Package io.jmix.aitools.dataload.generation

Class EntityDataLoadGenerationRequest

java.lang.Object
io.jmix.aitools.dataload.generation.EntityDataLoadGenerationRequest
public class EntityDataLoadGenerationRequest extends Object
A generation request carrying, besides the natural-language prompt, the constraints a caller knows as data: the parameters the query may reference and how each is bound, and the result columns it must expose under fixed aliases. All constraints are optional; a request with only a prompt generates exactly as free text does.

  • Field Details

  • Constructor Details

    • EntityDataLoadGenerationRequest

      public EntityDataLoadGenerationRequest(String prompt)

  • Method Details

    • setAvailableParameters

      public EntityDataLoadGenerationRequest setAvailableParameters(@Nullable List<EntityDataLoadQueryParameter> availableParameters)
      Sets the parameters the generated query may reference.
      Parameters:
      availableParameters - the parameters, or null for none
      Returns:
      this request

    • setRequiredResultProperties

      public EntityDataLoadGenerationRequest setRequiredResultProperties(@Nullable List<String> requiredResultProperties)
      Sets the aliases the generated query must select and expose, verbatim.
      Parameters:
      requiredResultProperties - the required aliases, or null for none
      Returns:
      this request

    • getPrompt

      public String getPrompt()
      Returns the text the caller asks the model to answer.
      Returns:
      the natural-language prompt

    • getAvailableParameters

      public List<EntityDataLoadQueryParameter> getAvailableParameters()
      Returns the parameters the generated query may reference.
      Returns:
      the parameters; empty when none were given

    • getRequiredResultProperties

      public List<String> getRequiredResultProperties()
      Returns the aliases the generated query must select and expose verbatim.
      Returns:
      the required aliases; empty when none were given