Package de.xima.fc.prompt.service.support

Interface IPromptParametersService

public interface IPromptParametersService

Service with logic related to prompt input and output parameters, such as PromptTextParameter or PromptFileSetParameter. Usage of this service is optional, but may simplify implementation of prompt service handlers. Obtain instances via CDI.

Since:

8.5.0

Method Summary

Modifier and Type	Method	Description
IPromptFileParametersDescriptorBuilder	fileParameterDescriptor()	Gets a builder for the file parameters as the input of a prompt query.
IPromptJsonAnswerDescriptorBuilder	jsonAnswerDescriptor()	Gets a builder for a JSON answer as the output of a query.
IPromptTextAnswerDescriptorBuilder	textAnswerDescriptor()	Gets a builder for a text answer as the output of a query.
IPromptTextParameterDescriptorBuilder	textParameterDescriptor()	Gets a builder for the text parameters as the input of a query.
IPromptTextInputParamsBuilder	textParameterExtractor()	Gets a builder for extracting text input parameters from a given configuration object.

Method Detail

fileParameterDescriptor

IPromptFileParametersDescriptorBuilder fileParameterDescriptor()

Gets a builder for the file parameters as the input of a prompt query. Given a set of configured file parameters, derives a suitable file value descriptor. Each key will correspond to a key in the files map of the derived file value descriptor.

Returns:

A builder for a file parameters descriptor.

jsonAnswerDescriptor

IPromptJsonAnswerDescriptorBuilder jsonAnswerDescriptor()

Gets a builder for a JSON answer as the output of a query. Given a JsonSchemaOutput model, derives the value descriptor for that JSON schema and creates a record value descriptor with a single property named "answer" of that type.

Returns:

A builder for a JSON answer descriptor.

textAnswerDescriptor

IPromptTextAnswerDescriptorBuilder textAnswerDescriptor()

Gets a builder for a text answer as the output of a query. Creates a record value descriptor with a single text property named "answer".

Returns:

A builder for a text answer descriptor.

textParameterDescriptor

IPromptTextParameterDescriptorBuilder textParameterDescriptor()

Gets a builder for the text parameters as the input of a query. Given a set of configured text parameters, derives a suitable value descriptor. This will be a record value descriptor with a field for each text parameter name.

Returns:

A builder for a text parameters descriptor.

textParameterExtractor

IPromptTextInputParamsBuilder textParameterExtractor()

Gets a builder for extracting text input parameters from a given configuration object.

Returns:

A builder for extracting text input parameters.