Enum EJsonSchemaDefinitionMethod

java.lang.Object
java.lang.Enum<EJsonSchemaDefinitionMethod>
de.xima.fc.prompt.service.support.EJsonSchemaDefinitionMethod
All Implemented Interfaces:
Serializable, Comparable<EJsonSchemaDefinitionMethod>
public enum EJsonSchemaDefinitionMethod extends Enum<EJsonSchemaDefinitionMethod>
Enumeration that defines the methods available for a user to define a JSON schema for the prompt response.
Since:
8.5.0

  • Enum Constant Details

    • BY_PROPERTY_LIST

      public static final EJsonSchemaDefinitionMethod BY_PROPERTY_LIST
      The user enters a list of top-level properties, from which the system generates a JSON schema. For each property, the user can configure certain details such as whether the property is required.

    • BY_JSON_EXAMPLE

      public static final EJsonSchemaDefinitionMethod BY_JSON_EXAMPLE
      The user enters a JSON example object from which the system generates a JSON schema.

    • BY_MANUAL_INPUT

      public static final EJsonSchemaDefinitionMethod BY_MANUAL_INPUT
      The user manually enters the JSON schema using a text or code editor.

    • BY_VISUAL_EDITOR

      public static final EJsonSchemaDefinitionMethod BY_VISUAL_EDITOR
      The user uses a visual editor to edit the JSON schema. The visual editor provides a user-friendly interface for creating and modifying JSON schemas without needing to write the schema manually. The exact editor is undefined and may change over time.

  • Method Details

    • values

      public static EJsonSchemaDefinitionMethod[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EJsonSchemaDefinitionMethod valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null