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

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

Package	Description
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.ms.impl.service.generic_oai.service.model	Contains the model classes needed by the Generic OAI prompt service handler.
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.gui.component
de.xima.fc.prompt.service.support.gui.converter
de.xima.fc.prompt.service.support.gui.view_model
de.xima.fc.prompt.service.support.internal

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

Class	Description
IJsonSchemaTransformer	A transformer that applies a series of transformation steps to a JSON schema.

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

Class	Description
IJsonSchemaTransformer	A transformer that applies a series of transformation steps to a JSON schema.
IPromptJsonSchemaService	Service for prompt service providers that provides functionality related to JSON schemas.
PromptServiceHandlerMixin_JsonConfig	Mixin interface for IPromptServiceHandler implementations that provides JSON marshalling for the prompt connection and query configuration.

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

Class	Description
IPromptConnectionConfig_ApiKey	Mixin for a prompt query configuration model that allows the user to configure the API key, i.e. the token needed to authenticate with the prompt service provider.
IPromptConnectionConfig_ApiUrl	Mixin for a prompt query configuration model that allows the user to configure the API URL, i.e. the URL of the prompt service provider.
IPromptConnectionConfig_ConnectTimeout	Mixin for a prompt query configuration model that allows the user to configure the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.
IPromptConnectionConfig_Model	Mixin for a prompt query configuration model that allows the user to configure the model, i.e. the name of the model to use for the prompt service.
IPromptConnectionConfig_ReadTimeout	Mixin for a prompt query configuration model that allows the user to configure the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.
IPromptQueryConfig_CumulativeProbabilityThreshold	Mixin for a query connection configuration model that allows the user to enter an optional cumulative probability threshold for nucleus sampling, often referred to as "top-p".
IPromptQueryConfig_EffortLevel	Mixin for a prompt query configuration model that allows the user to define amount of effort the prompt service should put into answering the prompt, sometimes also referred to as "reasoning effort" or "thinking level".
IPromptQueryConfig_Files	Mixin for a prompt query configuration model that allows the user to configure files for the prompt query, by uploading a list of static files and/or by defining a list file set parameters accepted by the query.
IPromptQueryConfig_FrequencyPenalty	Mixin for a query connection configuration model that allows the user to a frequency penalty when executing a prompt query.
IPromptQueryConfig_GeneratedTokenLimit	Mixin for a query connection configuration model that allows the user to enter the number of tokens the model should generate at most in its response to the prompt.
IPromptQueryConfig_JsonSchemaOutput	Mixin for a prompt query configuration model that allows the user to define a JSON schema for the prompt response.
IPromptQueryConfig_PresencePenalty	Mixin for a query connection configuration model that allows the user to a presence penalty when executing a prompt query.
IPromptQueryConfig_SystemPrompt	Mixin for a query connection configuration model that allows the user to enter an optional system prompt message.
IPromptQueryConfig_Temperature	Mixin for a query connection configuration model that allows the user to enter an optional temperature.
IPromptQueryConfig_TextParameters	Mixin for a prompt query configuration model that allows the user to define a list text parameters accepted by the query.
IPromptQueryConfig_UserPrompt	Mixin for a query connection configuration model that allows the user to enter a user prompt message.
JsonSchemaOutput	View model POJO for users to define a JSON schema for the prompt response.
PromptFiles	A configuration for a set of files, used by the configuration of a prompt connection or query.
PromptTextParameter
SystemPrompt	View model POJO for users to define a system prompt that is sent to the prompt provider.

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

Class	Description
EJsonSchemaDefinitionMethod	Enumeration that defines the methods available for a user to define a JSON schema for the prompt response.
EJsonSchemaOutputPropertyType	Used by JsonSchemaOutputObjectProperty.
EJsonSchemaVersion	Enumeration of JSON schema versions.
EPromptConfigParamFileMultiplicity	Enumeration that defines the multiplicity of file input parameters in a prompt query configuration, e.g. how many files are allowed.
EPromptImageObjectFit	The object-fit property defines how an image should be resized to fit its canvas.
ForbidOptionalPropertiesMode	Mode that controls the behavior of the forbidOptionalProperties transform step.
IJsonSchemaTransformer	A transformer that applies a series of transformation steps to a JSON schema.
IJsonSchemaTransformerBuilder	A builder that lets you configure a set of transformation steps to be applied to a JSON schema.
IJsonValidationError	A single JSON validation error, containing a location and a message.
IJsonValidationResult	Result of validating a JSON.
IPromptExecutionObjectGraphPlaceholderReplacer	A replacer that replaces placeholders in an object graph of prompt models.
IPromptExecutionObjectGraphPlaceholderReplacerBuilder	Builder for a replacer that replaces placeholders in an object graph of a prompt model.
IPromptExecutionResolvedFiles	Represents the result of resolving a files configuration into actual files, see IPromptExecutionResolveFilesBuilder.build().
IPromptExecutionResolveFilesBuilder	Builder for resolving a files configuration into actual files.
IPromptExecutionResolveTextParametersBuilder	Builder for resolving text parameters.
IPromptFileParametersDescriptorBuilder	Builder for the file parameters descriptor of a prompt query.
IPromptImageAlphaChannelConverter	Converter that computes a new alpha channel operation based on whether the image has an alpha channel or not.
IPromptImageConvertBuilder	A builder for a converter that can post-process images.
IPromptImageConverter	A converter that can post-process images.
IPromptImageFormatConverter	Computes the new format of an image, based on its current format.
IPromptImageGeometryConverter	Computes the new geometry of an image, based on its current width and height.
IPromptImageInfo	Represents metadata of an image, such as its size or format.
IPromptJsonAnswerDescriptorBuilder	Builder for the JSON answer descriptor of a prompt query.
IPromptQueryConfig_Files	Mixin for a prompt query configuration model that allows the user to configure files for the prompt query, by uploading a list of static files and/or by defining a list file set parameters accepted by the query.
IPromptQueryConfig_JsonSchemaOutput	Mixin for a prompt query configuration model that allows the user to define a JSON schema for the prompt response.
IPromptQueryConfig_TextParameters	Mixin for a prompt query configuration model that allows the user to define a list text parameters accepted by the query.
IPromptTextAnswerDescriptorBuilder	Builder for the text answer descriptor of a prompt query.
IPromptTextInputParamsBuilder	Builder for extracting prompt text parameters from a given configuration object.
IPromptTextParameterDescriptorBuilder	Builder for the text parameters descriptor of a prompt query.
JsonSchemaOutput	View model POJO for users to define a JSON schema for the prompt response.
JsonSchemaOutputByJsonExample	View model POJO for users to define a JSON schema for the prompt response, by entering a JSON example.
JsonSchemaOutputByManualInput	View model POJO for users to define a JSON schema for the prompt response, by entering the JSON schema manually.
JsonSchemaOutputByPropertyList	View model POJO for users to define a JSON schema for the prompt response, by entering a list of properties for the object.
JsonSchemaOutputByVisualEditor	View model POJO for users to define a JSON schema for the prompt response, by using a visual JSON schema editor.
JsonSchemaOutputObjectProperty	One of the properties of a JSON object schema, used in JsonSchemaOutputByPropertyList.
JsonSchemaServiceException	Generic exception for JSON processing errors for the JSON Schema service.
PromptConfigFile	View model for a single file, intended to be used as part of the deserialized prompt connection configuration or deserialized prompt query configuration.
PromptConfigJsonDiscriminatedUnion	Annotation for model classes that represent the abstract base class of a discriminated union, intended for use with the JsonConfig mixin for prompt service handlers.
PromptConfigJsonDiscriminatedUnionMember	Annotation for a model class that represents a subclass of a discriminated union, intended for use with the JsonConfig mixin for prompt service handlers.
PromptConfigJsonDiscriminator	Annotation for the discriminator field of a model class that represents the abstract base class of a discriminated union, intended for use with the JsonConfig mixin for prompt service handlers.
PromptFiles	A configuration for a set of files, used by the configuration of a prompt connection or query.
PromptFileSetParameter	A set of files for dynamic file input parameters of a prompt query.
PromptFileSource
PromptFileType	Models a file type, which can either be defined by its file extension (e.g. ".txt") or by its kind (e.g.
PromptFileType.Extension	A PromptFileType that identifies a file by its extension, e.g. ".txt" or ".png".
PromptFileType.Kind	A PromptFileType that identifies a file by its kind, e.g.
PromptFileType.PromptFileKind	Enumeration of file kinds, which can be used to categorize files by their content type rather than by their file extension.
PromptImageGeometryData	Represents the target geometry of an image.
PromptImageGeometryData.Builder	Builder for PromptImageGeometryData.
PromptTextParameter
SingularFileMode	Enumeration for a single input or output file that describes whether the file is required, optional, or never allowed.
SystemPrompt	View model POJO for users to define a system prompt that is sent to the prompt provider.

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

Class	Description
JsonSchemaOutputObjectProperty	One of the properties of a JSON object schema, used in JsonSchemaOutputByPropertyList.
PromptConfigFile	View model for a single file, intended to be used as part of the deserialized prompt connection configuration or deserialized prompt query configuration.
PromptFileSetParameter	A set of files for dynamic file input parameters of a prompt query.
PromptFileSource
PromptFileType.PromptFileKind	Enumeration of file kinds, which can be used to categorize files by their content type rather than by their file extension.
SystemPrompt	View model POJO for users to define a system prompt that is sent to the prompt provider.

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

Class	Description
PromptFileType	Models a file type, which can either be defined by its file extension (e.g. ".txt") or by its kind (e.g.

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

Class	Description
PromptFileSetParameter	A set of files for dynamic file input parameters of a prompt query.
PromptFileType.PromptFileKind	Enumeration of file kinds, which can be used to categorize files by their content type rather than by their file extension.

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

Class	Description
IPromptImageFormatConverter	Computes the new format of an image, based on its current format.