Embabel Agent Documentation/com.embabel.common.ai.model/NativeStructuredOutputMode

NativeStructuredOutputMode

enum NativeStructuredOutputMode : Enum<NativeStructuredOutputMode>

Per-call native structured-output mode.

This is intentionally small and additive: it lets callers override the runtime decision without changing the public LlmOptions data shape.

Entries

DEFAULT

Check schema compatibility before using the native path. If the schema is not conservatively compatible, fall back to prompt-based extraction and log at DEBUG. Use ENABLED to force the native path regardless, or DISABLED to opt out entirely.

ENABLED

Always use the native structured-output path when the provider supports it, bypassing the schema compatibility check. The schema must still be valid for the provider.

DISABLED

Always use prompt-based extraction; never use the native path.

Properties

name

val name: String

ordinal

val ordinal: Int

Functions

applyTo

fun applyTo(options: LlmOptions): LlmOptions

Apply this native structured-output mode to options.

valueOf

fun valueOf(value: String): NativeStructuredOutputMode

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<NativeStructuredOutputMode>

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