Package de.xima.fc.prompt.service

Contains the API for a prompt service that abstract the details of a particular provider. A prompt service is usually a REST API that can answer prompts. Each prompt service has a type, and each type must have a corresponding implementation of IPromptServiceHandler. This allows the core to implement the prompt feature in a provider-agnostic way, while still allowing for different providers to be used.

Since:

8.5.0

Interface Summary

Interface	Description
IPrepareViewForConnectionParams<Config>	Parameters passed to a prompt connection bean when a connection is selected, see prepareViewForConnection.
IPrepareViewForQueryParams<ConnectionConfig,QueryConfig>	Parameters passed to a prompt query bean when a query is selected, see prepareViewForQuery.
IPromptBinaryData
IPromptComputeQueryInputParams<ConnectionConfig,QueryConfig>	Parameters for computing the input parameter descriptors of a prompt query, see computeQueryInput.
IPromptComputeQueryInputRetVal	The return value of handler.computeQueryInput.
IPromptComputeQueryOutputParams<ConnectionConfig,QueryConfig>	Parameters for computing the output parameter descriptors of a prompt query, see computeQueryOutput.
IPromptComputeQueryOutputRetVal	The return value of handler.computeQueryOutput.
IPromptConnectionBean<ConnectionConfig>	Base interface for GUI beans that manage prompt connections.
IPromptExecutionContext	Context used during execution of a prompt query.
IPromptExecutionParams<ConnectionConfig,QueryConfig>	Input parameters for executing a prompt query, see executePromptQuery.
IPromptExecutionReplacer	Replacer for placeholders within strings, used during prompt execution.
IPromptExecutionReplacerBound	A replacer bound to specific settings, allowing multiple replacements with the same configuration.
IPromptExecutionReplacerContextResolver	Resolver for context placeholders.
IPromptExecutionReplacerEscaper	Escaper for replaced values, used during prompt execution.
IPromptExecutionReplacerSettings	Builder for a replacer that can replace placeholders in strings, used during prompt execution.
IPromptExecutionRetVal	The return value of handler.executePromptQuery.
IPromptFileStorage	Storage used during prompt execution to store binary data.
IPromptFileWriter	A writer that writes binary data to an output stream.
IPromptQueryBean<ConnectionConfig,QueryConfig>	Base interface for GUI beans that manage prompt queries.
IPromptQueryInputDescriptor	The input descriptor that defines the structure of the data that passed to a prompt query upon execution.
IPromptQueryIoDescriptor	Base interface for input and output descriptors that define the structure of the data passed to a prompt query upon execution and the data returned from a prompt query upon execution.
IPromptQueryIoObject	Base interface for all prompt query I/O objects, i.e. request and response objects.
IPromptQueryOutputDescriptor	The output descriptor that defines the structure of the data that returned when executing the prompt query.
IPromptQueryRequestObject	A single parameter value passed to a prompt query upon execution, see handler.executePromptQuery.
IPromptQueryResponseObject	A single value returned when executing a prompt query, see handler.executePromptQuery.
IPromptServiceHandler<ConnectionConfig,QueryConfig>	Handler interface for a prompt service that allows for natural language or media data queries, backed by technologies such as large language models (LLMs) or image generation models.
IPromptStoredData	Represents the result of IPromptFileStorage.storeBinaryData(InputStream), i.e. stored binary data, together with the size of the stored data.
IPromptTestConnectionParams<ConnectionConfig>	Represents the parameters of a prompt connection test, see testConnection.
IPromptTestConnectionRetVal	Represents the return value of a prompt connection test, see testConnection.
IRetrieveConnectionModelParams<ConnectionConfig>	Parameters for prepareViewForConnection.
IRetrieveConnectionModelRetVal<ConnectionConfig>	Return value of retrieveConnectionModel.
IRetrieveQueryModelParams<QueryConfig>	Parameters for prepareViewForQuery.
IRetrieveQueryModelRetVal<QueryConfig>	Return value of retrieveQueryModel.

Class Summary

Class	Description
ExecutionFailedException.Builder	Builder for a ExecutionFailedException.
InvalidConfigurationException.Builder	Builder for a InvalidConfigurationException.
InvalidInputParamsException.Builder	Builder for a InvalidInputParamsException.
InvalidOutputParamsException.Builder	Builder for a InvalidOutputParamsException.
MissingPromptServiceException.Builder
PromptExecutionException.Builder<Instance,Builder>	Base builder class for prompt execution exceptions.
RateLimitExceededException.Builder	Builder for a RateLimitExceededException.
RequestRefusedException.Builder	Builder for a RequestRefusedException.
ResponseRefusedException.Builder	Builder for a ResponseRefusedException.
SerializedPromptConfig	Represents a serialized prompt configuration, with plain text and binary values.
SerializedPromptConfig.Builder	A builder for creating instances of SerializedPromptConfig.
ServiceUnavailableException.Builder	Builder for a ServiceUnavailableException.
UnauthorizedPromptRequestException.Builder	Builder for a UnauthorizedPromptRequestException.

Exception Summary

Exception	Description
ExecutionFailedException	Exception thrown when executing a prompt query could not be executed for an unknown reason.
InvalidConfigurationException	Exception thrown when executing a prompt query whose configuration is invalid.
InvalidInputParamsException	Exception thrown when executing a prompt query with input parameters that are invalid and do not match the input expected by the prompt query, e.g. because a required parameter is missing or an image file was provided when image files are not allowed.
InvalidOutputParamsException	Exception thrown when executing a prompt query and the query produces unexpected output that does not match the expected output format, e.g. because the response from the AI service was malformed or incomplete.
MissingPromptServiceException	Exception thrown when executing a prompt query for which no prompt service implementation could be found.
PromptExecutionException	Base class for all exceptions that occur during the execution of a prompt query.
PromptSerializationException	Exception thrown when there is an error during the serialization or deserialization of prompt configurations.
RateLimitExceededException	Exception thrown when executing a prompt query against a prompt service whose rate limit has been exceeded.
RequestRefusedException	Exception thrown when executing a prompt query and the prompt service refuses to process the request, e.g. because violates its usage policies or contains inappropriate content.
ResponseRefusedException	Exception thrown when executing a prompt query and the system refused to accept the response from the prompt service, e.g. because violates the system's policies or contains unsafe content such as malware.
ServiceUnavailableException	Exception thrown when executing a prompt query against a prompt service that is currently unavailable.
UnauthorizedPromptRequestException	Exception thrown when executing a prompt query against a prompt service and the service rejected the request due to unauthorized access.