Annotation Type FcPromptQueryParameters

@Documented @Constraint(validatedBy=FcPromptQueryParametersValidator.class) @Target(TYPE) @Retention(RUNTIME) @Repeatable(FcPromptQueryParameters.List.class) public @interface FcPromptQueryParameters
Constraint validation that may be applied to IPromptQueryWithParameters. Checks that the parameter values conform the constraints imposed by the prompt query.
Since:
8.5.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    FcPromptQueryParameters.List
    Defines several FcPromptQueryParameters constraints on the same element.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>[]
    groups
     
    String
    message
    Gets the default message for creating error messages in case the constraint is violated.
    String
    mismatchingJsonParameter
    Gets the message to use when a JSON parameter was that does not match the structured type defined by the prompt query.
    String
    overlappingFileParameters
    Gets the message to use for the constraint violation raised when the single and multi file parameters contain overlapping keys.
    Class<? extends javax.validation.Payload>[]
    payload
     
    String
    requiredFileParameterAbsent
    Gets the message to use when no value was provided for a file parameters defined as required by the prompt query.
    boolean
    strict
    Whether to perform a strict validation.
    String
    undefinedFileParameter
    Gets the message to use when a file parameter was found that is not defined by the prompt query.

  • Element Details

    • groups

      Class<?>[] groups
      Returns:
      Allows the specification of validation groups, to which this constraint belongs. When not specified, the constraint is placed in the Default group.
      Default:
      {}

    • message

      String message
      Gets the default message for creating error messages in case the constraint is violated.
      Returns:
      The default message.
      Default:
      "{de.xima.fc.workflow.validation.constraints.ValidPromptQueryJsonParameters.message}"

    • mismatchingJsonParameter

      String mismatchingJsonParameter
      Gets the message to use when a JSON parameter was that does not match the structured type defined by the prompt query.
      Returns:
      The message for mismatching JSON parameters.
      Default:
      "{de.xima.fc.workflow.validation.constraints.ValidPromptQueryJsonParameters.mismatchingJsonParameter}"

    • overlappingFileParameters

      String overlappingFileParameters
      Gets the message to use for the constraint violation raised when the single and multi file parameters contain overlapping keys.
      Returns:
      The message for overlapping file parameters.
      Default:
      "{de.xima.fc.workflow.validation.constraints.ValidPromptQueryJsonParameters.overlappingFileParameters}"

    • payload

      Class<? extends javax.validation.Payload>[] payload
      Returns:
      The payload that can be used by clients of the Jakarta Bean Validation API to assign custom payload objects to a constraint.
      Default:
      {}

    • requiredFileParameterAbsent

      String requiredFileParameterAbsent
      Gets the message to use when no value was provided for a file parameters defined as required by the prompt query.
      Returns:
      The message for absent required parameters.
      Default:
      "{de.xima.fc.workflow.validation.constraints.ValidPromptQueryJsonParameters.requiredFileParameterAbsent}"

    • strict

      boolean strict
      Whether to perform a strict validation. When true, ensures that the value matches exactly against the descriptor defined by the prompt query. When false, skips some checks for constraint violations that are caused by superfluous data and that can be resolved by omitting that data. In other words, ensures the existing data matches the constraint, but ignores additional data. For example, when false, allows additional undeclared parameters to be present in the maps and records; or strings that are longer than the maximum length defined by the descriptor. Defaults to false.
      Returns:
      Whether undefined parameters are allowed.
      Default:
      false

    • undefinedFileParameter

      String undefinedFileParameter
      Gets the message to use when a file parameter was found that is not defined by the prompt query.
      Returns:
      The message for undefined parameters.
      Default:
      "{de.xima.fc.workflow.validation.constraints.ValidPromptQueryJsonParameters.undefinedFileParameter}"