Package de.xima.fc.prompt.service
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
-
ClassDescriptionException thrown when executing a prompt query could not be executed for an unknown reason.Builder for a
ExecutionFailedException.Exception thrown when executing a prompt query whose configuration is invalid.Builder for aInvalidConfigurationException.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.Builder for aInvalidInputParamsException.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.Builder for aInvalidOutputParamsException.IPrepareViewForConnectionParams<Config>Parameters passed to aprompt connection beanwhen a connection is selected, seeprepareViewForConnection.IPrepareViewForQueryParams<ConnectionConfig, QueryConfig>Parameters passed to aprompt query beanwhen a query is selected, seeprepareViewForQuery.IPromptComputeQueryInputParams<ConnectionConfig, QueryConfig>Parameters for computing the input parameter descriptors of a prompt query, seecomputeQueryInput.The return value ofhandler.computeQueryInput.IPromptComputeQueryOutputParams<ConnectionConfig, QueryConfig>Parameters for computing the output parameter descriptors of a prompt query, seecomputeQueryOutput.The return value ofhandler.computeQueryOutput.IPromptConnectionBean<ConnectionConfig>Base interface for GUI beans that manage prompt connections.Context used during execution of a prompt query.IPromptExecutionParams<ConnectionConfig, QueryConfig>Input parameters for executing a prompt query, seeexecutePromptQuery.Replacer for placeholders within strings, used during prompt execution.A replacer bound to specific settings, allowing multiple replacements with the same configuration.Resolver for context placeholders.Escaper for replaced values, used during prompt execution.Builder for a replacer that can replace placeholders in strings, used during prompt execution.The return value ofhandler.executePromptQuery.Storage used during prompt execution to store binary data.A writer that writes binary data to an output stream.IPromptQueryBean<ConnectionConfig, QueryConfig>Base interface for GUI beans that manage prompt queries.The input descriptor that defines the structure of the data that passed to a prompt query upon execution.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.Base interface for all prompt query I/O objects, i.e. request and response objects.The output descriptor that defines the structure of the data that returned when executing the prompt query.A single parameter value passed to a prompt query upon execution, seehandler.executePromptQuery.A single value returned when executing a prompt query, seehandler.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.Represents the result ofIPromptFileStorage.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, seetestConnection.Represents the return value of a prompt connection test, seetestConnection.IRetrieveConnectionModelParams<ConnectionConfig>Parameters forprepareViewForConnection.IRetrieveConnectionModelRetVal<ConnectionConfig>Return value ofretrieveConnectionModel.IRetrieveQueryModelParams<QueryConfig>Parameters forprepareViewForQuery.IRetrieveQueryModelRetVal<QueryConfig>Return value ofretrieveQueryModel.Exception thrown when executing a prompt query for which no prompt service implementation could be found.Base class for all exceptions that occur during the execution of a prompt query.PromptExecutionException.Builder<Instance,Builder> Base builder class for prompt execution exceptions.Exception thrown when there is an error during the serialization or deserialization of prompt configurations.Exception thrown when executing a prompt query against a prompt service whose rate limit has been exceeded.Builder for aRateLimitExceededException.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.Builder for aRequestRefusedException.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.Builder for aResponseRefusedException.Represents a serialized prompt configuration, with plain text and binary values.A builder for creating instances ofSerializedPromptConfig.Exception thrown when executing a prompt query against a prompt service that is currently unavailable.Builder for aServiceUnavailableException.Exception thrown when executing a prompt query against a prompt service and the service rejected the request due to unauthorized access.Builder for aUnauthorizedPromptRequestException.