Package io.jmix.reports.llm

Class LlmQueryGenerationRequest

java.lang.Object

io.jmix.reports.llm.LlmQueryGenerationRequest

public class LlmQueryGenerationRequest
extends Object

Request to generate a query for a data set prompt.

See Also:

• LlmDataQueryService.generate(LlmQueryGenerationRequest)

Field Summary

Fields

Modifier and Type	Field	Description
protected List<LlmQueryParameter>	availableParameters
protected String	prompt
protected List<String>	requiredResultProperties

Constructor Summary

Constructors

Constructor	Description
LlmQueryGenerationRequest(String prompt, @Nullable List<LlmQueryParameter> availableParameters, @Nullable List<String> requiredResultProperties)

Method Summary

Modifier and Type	Method	Description
List<LlmQueryParameter>	getAvailableParameters()	Returns the parameters the generated query may reference.
String	getPrompt()
List<String>	getRequiredResultProperties()	Returns the result aliases the generated query has to select.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

prompt

protected String prompt

availableParameters

protected List<LlmQueryParameter> availableParameters

requiredResultProperties

protected List<String> requiredResultProperties

Constructor Details

LlmQueryGenerationRequest

public LlmQueryGenerationRequest(String prompt,
 @Nullable List<LlmQueryParameter> availableParameters,
 @Nullable List<String> requiredResultProperties)

Method Details

getPrompt

public String getPrompt()

Returns:

the data set prompt in natural language

getAvailableParameters

public List<LlmQueryParameter> getAvailableParameters()

Returns the parameters the generated query may reference. Their values are irrelevant here: the generated query must reference them by name and receives values only at execution time.

Returns:

the parameters the generated query may reference

getRequiredResultProperties

public List<String> getRequiredResultProperties()

Returns the result aliases the generated query has to select. A cross-tab cell query uses them to link each row to its axes; an ordinary band requires none.

Returns:

result aliases required by the data set context