Interface IPromptQueryConfig_Files

public interface 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. Usually it is more common for prompt queries to allow file parameters, so that files can be passed dynamically to the query upon execution, but in some cases it might be useful to include static files that are always included.

This mixin is intended to be used for the main set of files used by prompt queries. If you need additional files for a particular task (e.g. an optional mask image for an "edit image" or "inpaint image" task), consider defining a separate property of type PromptFiles in your query configuration model.

Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.

See also the <xp:singleFile/> and <xp:multiFile/> Faces components from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

Since:
8.5.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_FILES
    The name of the files attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    PromptFiles
    getFiles()
    Gets the configuration for the files needed by the prompt query.
    void
    setFiles(PromptFiles files)
    Sets the configuration for the files needed by the prompt query.

  • Field Details

    • ATTR_FILES

      static final String ATTR_FILES
      The name of the files attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
      See Also:

  • Method Details

    • getFiles

      PromptFiles getFiles()
      Gets the configuration for the files needed by the prompt query.
      Returns:
      The configuration for the files.

    • setFiles

      void setFiles(PromptFiles files)
      Sets the configuration for the files needed by the prompt query.
      Parameters:
      files - The configuration for the files.