Interface IPromptQueryParametersProviding

All Known Subinterfaces:
IPromptQueryWithParameters
All Known Implementing Classes:
FcPromptQueryProps
public interface IPromptQueryParametersProviding
Interface for classes that provide prompt query parameters. These are split into four categories:
  • Single JSON parameters (key-value pairs where the value is a single JSON object)
  • Multi JSON parameters (key-value pairs where the value is a list of JSON objects)
  • Single file parameters (key-value pairs where the value is a single file)
  • Multi file parameters (key-value pairs where the value is a list of files)
Since:
8.5.0

  • Method Details

    • getJsonParameters

      Object getJsonParameters()
      Gets the configured JSON parameters for the prompt query. These parameters will be passed on to the prompt query upon execution.
      Returns:
      The configured single parameters for the prompt query.

    • getMultiFileParameters

      Map<String, MultiFile> getMultiFileParameters()
      Gets the configured multi file parameters for the prompt query, indexed by their ID. These parameters will be passed on to the prompt query upon execution. Note that while this model class maintains a separate map for single and multi file parameters, the keys must be mutually exclusive across both maps.
      Returns:
      The configured multi file parameters for the prompt query.

    • getSingleFileParameters

      Map<String, SingleFile> getSingleFileParameters()
      Gets the configured single file parameters for the prompt query, indexed by their ID. These parameters will be passed on to the prompt query upon execution. Note that while this model class maintains a separate map for single and multi file parameters, the keys must be mutually exclusive across both maps.
      Returns:
      The configured single file parameters for the prompt query.