Package de.espirit.firstspirit.ai.dto

Interface JsonSchema

public interface JsonSchema
JSON schema definition for a JSON value type.
Since:
5.2.251104

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    JsonSchema.Builder
    Builder for a JsonSchema definition.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull JsonSchema.Builder
    builder()
    Creates a new builder for creating a JsonSchema definition.
    @NotNull String
    getJson()
    Returns the JSON schema definition as JSON String.
    @NotNull Map<String,Object>
    getProperties()
    JSON Schema descriptor for the type of object this parameter contains.

  • Method Details

    • builder

      @NotNull static @NotNull JsonSchema.Builder builder()
      Creates a new builder for creating a JsonSchema definition.
      Returns:
      The new builder instance.
      Since:
      5.2.251104

    • getJson

      @NotNull @NotNull String getJson()
      Returns the JSON schema definition as JSON String.
      Returns:
      The JSON schema as string.
      Since:
      5.2.251303

    • getProperties

      @NotNull @NotNull Map<String,Object> getProperties()
      JSON Schema descriptor for the type of object this parameter contains.
      Returns:
      The JSON schema descriptor.
      Since:
      5.2.251104