Uses of Package
de.xima.fc.prompt.service

Packages that use de.xima.fc.prompt.service

Package	Description
de.xima.fc.prompt.mgmt.defaults
de.xima.fc.prompt.mgmt.gui.bean
de.xima.fc.prompt.mgmt.gui.logic
de.xima.fc.prompt.mgmt.gui.model
de.xima.fc.prompt.mgmt.internal
de.xima.fc.prompt.mgmt.service
de.xima.fc.prompt.ms.impl.service.generic_oai.service.bean	Contains the UI controller beans for the prompt connection and query configuration UI of the Generic OAI prompt service.
de.xima.fc.prompt.ms.impl.service.generic_oai.service.logic	Contains the internal logic needed to implement the Generic OAI prompt service handler.
de.xima.fc.prompt.plugin
de.xima.fc.prompt.service	Contains the API for a prompt service that abstract the details of a particular provider.
de.xima.fc.prompt.service.defaults	Contains default implementations for various interfaces defined by the handler API.
de.xima.fc.prompt.service.support	The prompt API is kept intentionally low-level to support a wide range of use cases.
de.xima.fc.prompt.service.support.internal

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.mgmt.defaults

Class	Description
IPromptExecutionContext	Context used during execution of a 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.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.mgmt.gui.bean

Class	Description
IPromptBinaryData
IPromptConnectionBean	Base interface for GUI beans that manage prompt connections.
IPromptQueryBean	Base interface for GUI beans that manage prompt queries.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.mgmt.gui.logic

Class	Description
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.
IPromptBinaryData
IPromptFileStorage	Storage used during prompt execution to store binary data.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.mgmt.gui.model

Class	Description
IPromptBinaryData
IPromptConnectionBean	Base interface for GUI beans that manage prompt connections.
IPromptQueryBean	Base interface for GUI beans that manage prompt queries.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.mgmt.internal

Class	Description
PromptExecutionException	Base class for all exceptions that occur during the execution of a prompt query.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.mgmt.service

Class	Description
IPromptComputeQueryInputRetVal	The return value of handler.computeQueryInput.
IPromptComputeQueryOutputRetVal	The return value of handler.computeQueryOutput.
IPromptConnectionBean	Base interface for GUI beans that manage prompt connections.
IPromptExecutionContext	Context used during execution of a prompt query.
IPromptQueryBean	Base interface for GUI beans that manage prompt queries.
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	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.
PromptExecutionException	Base class for all exceptions that occur during the execution of a prompt query.
SerializedPromptConfig	Represents a serialized prompt configuration, with plain text and binary values.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.ms.impl.service.generic_oai.service.bean

Class	Description
IPrepareViewForConnectionParams	Parameters passed to a prompt connection bean when a connection is selected, see prepareViewForConnection.
IPrepareViewForQueryParams	Parameters passed to a prompt query bean when a query is selected, see prepareViewForQuery.
IPromptConnectionBean	Base interface for GUI beans that manage prompt connections.
IPromptFileStorage	Storage used during prompt execution to store binary data.
IPromptQueryBean	Base interface for GUI beans that manage prompt queries.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.ms.impl.service.generic_oai.service.logic

Class	Description
IPromptComputeQueryInputParams	Parameters for computing the input parameter descriptors of a prompt query, see computeQueryInput.
IPromptComputeQueryInputRetVal	The return value of handler.computeQueryInput.
IPromptComputeQueryOutputParams	Parameters for computing the output parameter descriptors of a prompt query, see computeQueryOutput.
IPromptComputeQueryOutputRetVal	The return value of handler.computeQueryOutput.
IPromptExecutionParams	Input parameters for executing a prompt query, see executePromptQuery.
IPromptExecutionRetVal	The return value of handler.executePromptQuery.
IPromptServiceHandler	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.
IPromptTestConnectionParams	Represents the parameters of a prompt connection test, see testConnection.
IPromptTestConnectionRetVal	Represents the return value of a prompt connection test, see testConnection.
PromptExecutionException	Base class for all exceptions that occur during the execution of a prompt query.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.plugin

Class	Description
IPromptServiceHandler	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.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.service

Class	Description
ExecutionFailedException	Exception thrown when executing a prompt query could not be executed for an unknown reason.
ExecutionFailedException.Builder	Builder for a ExecutionFailedException.
InvalidConfigurationException	Exception thrown when executing a prompt query whose configuration is invalid.
InvalidConfigurationException.Builder	Builder for a InvalidConfigurationException.
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.
InvalidInputParamsException.Builder	Builder for a InvalidInputParamsException.
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.
InvalidOutputParamsException.Builder	Builder for a InvalidOutputParamsException.
IPrepareViewForConnectionParams	Parameters passed to a prompt connection bean when a connection is selected, see prepareViewForConnection.
IPrepareViewForQueryParams	Parameters passed to a prompt query bean when a query is selected, see prepareViewForQuery.
IPromptBinaryData
IPromptComputeQueryInputParams	Parameters for computing the input parameter descriptors of a prompt query, see computeQueryInput.
IPromptComputeQueryInputRetVal	The return value of handler.computeQueryInput.
IPromptComputeQueryOutputParams	Parameters for computing the output parameter descriptors of a prompt query, see computeQueryOutput.
IPromptComputeQueryOutputRetVal	The return value of handler.computeQueryOutput.
IPromptConnectionBean	Base interface for GUI beans that manage prompt connections.
IPromptExecutionContext	Context used during execution of a prompt query.
IPromptExecutionParams	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	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.
IPromptStoredData	Represents the result of IPromptFileStorage.storeBinaryData(InputStream), i.e. stored binary data, together with the size of the stored data.
IPromptTestConnectionParams	Represents the parameters of a prompt connection test, see testConnection.
IPromptTestConnectionRetVal	Represents the return value of a prompt connection test, see testConnection.
IRetrieveConnectionModelParams	Parameters for prepareViewForConnection.
IRetrieveConnectionModelRetVal	Return value of retrieveConnectionModel.
IRetrieveQueryModelParams	Parameters for prepareViewForQuery.
IRetrieveQueryModelRetVal	Return value of retrieveQueryModel.
MissingPromptServiceException	Exception thrown when executing a prompt query for which no prompt service implementation could be found.
MissingPromptServiceException.Builder
PromptExecutionException	Base class for all exceptions that occur during the execution of a prompt query.
PromptExecutionException.Builder	Base builder class for prompt execution exceptions.
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.
RateLimitExceededException.Builder	Builder for a RateLimitExceededException.
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.
RequestRefusedException.Builder	Builder for a RequestRefusedException.
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.
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	Exception thrown when executing a prompt query against a prompt service that is currently unavailable.
ServiceUnavailableException.Builder	Builder for a ServiceUnavailableException.
UnauthorizedPromptRequestException	Exception thrown when executing a prompt query against a prompt service and the service rejected the request due to unauthorized access.
UnauthorizedPromptRequestException.Builder	Builder for a UnauthorizedPromptRequestException.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.service.defaults

Class	Description
IPromptBinaryData
IPromptComputeQueryInputRetVal	The return value of handler.computeQueryInput.
IPromptComputeQueryOutputRetVal	The return value of handler.computeQueryOutput.
IPromptExecutionContext	Context used during execution of a prompt query.
IPromptExecutionParams	Input parameters for executing a prompt query, see executePromptQuery.
IPromptExecutionReplacer	Replacer for placeholders within strings, used during prompt execution.
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.
IPromptQueryInputDescriptor	The input descriptor that defines the structure of the data that passed to a prompt query upon execution.
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.
IPromptStoredData	Represents the result of IPromptFileStorage.storeBinaryData(InputStream), i.e. stored binary data, together with the size of the stored data.
IPromptTestConnectionParams	Represents the parameters of a prompt connection test, see testConnection.
IPromptTestConnectionRetVal	Represents the return value of a prompt connection test, see testConnection.
IRetrieveConnectionModelParams	Parameters for prepareViewForConnection.
IRetrieveConnectionModelRetVal	Return value of retrieveConnectionModel.
IRetrieveQueryModelParams	Parameters for prepareViewForQuery.
IRetrieveQueryModelRetVal	Return value of retrieveQueryModel.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.service.support

Class	Description
IPromptBinaryData
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.
IPromptQueryRequestObject	A single parameter value passed to a prompt query upon execution, see handler.executePromptQuery.
IPromptServiceHandler	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.
PromptExecutionException	Base class for all exceptions that occur during the execution of a prompt query.
SerializedPromptConfig	Represents a serialized prompt configuration, with plain text and binary values.

Classes in de.xima.fc.prompt.service used by de.xima.fc.prompt.service.support.internal

Class	Description
SerializedPromptConfig	Represents a serialized prompt configuration, with plain text and binary values.