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

Interface IPromptExecutionResolveFilesBuilder

public interface IPromptExecutionResolveFilesBuilder

Builder for resolving a files configuration into actual files.

Given a list of file set parameters and/or a list of configured static files, resolves those files into the actual binary data. For dynamic files (file set parameters), this method reads the files from the provided request object.

Since:

8.5.0

Method Summary

Modifier and Type	Method	Description
IPromptExecutionResolvedFiles	build()	Resolves all files according to the current settings of this builder, and returns those files.
List<IPromptBinaryData>	buildFlat()	Resolves all files according to the current settings of this builder, and returns those files as a flat list.
IPromptExecutionResolveFilesBuilder	dynamicFiles(List<PromptFileSetParameter> files)	Sets the list of dynamic files (file parameters) to resolve, by reading them from the request object.
IPromptExecutionResolveFilesBuilder	files(IPromptQueryConfig_Files files)	Sets the files to resolve.
IPromptExecutionResolveFilesBuilder	files(PromptFiles files)	Sets the files to resolve.
IPromptExecutionResolveFilesBuilder	keyPrefix(String keyPrefix)	Sets the prefix to apply when extracting dynamic files from the request object.
IPromptExecutionResolveFilesBuilder	requestObject(IPromptQueryRequestObject requestObject)	Sets the request object from which to read dynamic files (file parameters).
IPromptExecutionResolveFilesBuilder	staticFiles(List<PromptConfigFile> files)	Sets the list of static files to resolve.

Method Detail

build

IPromptExecutionResolvedFiles build()
                             throws PromptExecutionException

Resolves all files according to the current settings of this builder, and returns those files.

Throws:

PromptExecutionException - If an error occurs while resolving the files, e.g. when an I/O error occurs while reading a file; or when a required file is missing.

buildFlat

List<IPromptBinaryData> buildFlat()
                           throws PromptExecutionException

Resolves all files according to the current settings of this builder, and returns those files as a flat list. Static files appear first in the returned list, dynamic files afterward.

Returns:

The resolved files.

Throws:

PromptExecutionException - If an error occurs while resolving the files, e.g. when an I/O error occurs while reading a file; or when a required file is missing.

dynamicFiles

@CanIgnoreReturnValue
IPromptExecutionResolveFilesBuilder dynamicFiles(List<PromptFileSetParameter> files)

Sets the list of dynamic files (file parameters) to resolve, by reading them from the request object.

Parameters:

files - The dynamic files.

Returns:

This builder for chaining method calls.

files

@CanIgnoreReturnValue
IPromptExecutionResolveFilesBuilder files(IPromptQueryConfig_Files files)

Sets the files to resolve.

Parameters:

files - The files.

Returns:

This builder for chaining method calls.

files

@CanIgnoreReturnValue
IPromptExecutionResolveFilesBuilder files(PromptFiles files)

Sets the files to resolve.

Parameters:

files - The files.

Returns:

This builder for chaining method calls.

keyPrefix

@CanIgnoreReturnValue
IPromptExecutionResolveFilesBuilder keyPrefix(String keyPrefix)

Sets the prefix to apply when extracting dynamic files from the request object. This prefix is added to the key of each file parameter (with a trailing dot), then that combined key is used to look up the file in the request object's files map.

Defaults to "files", which is suitable for the main set of input files of a query. If you have a secondary set of files (such as a mask for an image inpainting task), you need to configure the key prefix accordingly (e.g. "mask").

Parameters:

keyPrefix - The key prefix, without a trailing dot.

Returns:

This builder for chaining method calls.

requestObject

@CanIgnoreReturnValue
IPromptExecutionResolveFilesBuilder requestObject(IPromptQueryRequestObject requestObject)

Sets the request object from which to read dynamic files (file parameters).

Parameters:

requestObject - The request object to read the files from.

Returns:

This builder for chaining method calls.

staticFiles

@CanIgnoreReturnValue
IPromptExecutionResolveFilesBuilder staticFiles(List<PromptConfigFile> files)

Sets the list of static files to resolve.

Parameters:

files - The static files.

Returns:

This builder for chaining method calls.