prompt-structure/ai.koog.prompt.structure.json/JsonStructuredData/JsonSchemaType

JsonSchemaType

enum JsonSchemaType : Enum<JsonStructuredData.JsonSchemaType> (source)

Represents the type of JSON schema that can be utilized for structured data definition. This defines the level of detail or complexity included in the schema.

Entries

FULL

Represents the complete schema type in the enumeration, typically used to indicate that the JSON schema should be fully applied or adhered to without simplification.

SIMPLE

Represents a simplified schema type used within the JsonSchemaType enumeration. This type is typically used for scenarios where a minimal representation of the schema is sufficient.

Properties

entries

val entries: EnumEntries<JsonStructuredData.JsonSchemaType>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): JsonStructuredData.JsonSchemaType

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.)

values

fun values(): Array<JsonStructuredData.JsonSchemaType>

Returns an array containing the constants of this enum type, in the order they're declared.