prompt-structure/ai.koog.prompt.structure/StructuredRequestConfig

StructuredRequestConfig

data class StructuredRequestConfig<T>(val default: StructuredRequest<T>? = null, val byProvider: Map<LLMProvider, StructuredRequest<T>> = emptyMap(), val fixingParser: StructureFixingParser? = null)(source)

Configures structured output behavior. Defines which structures in which modes should be used for each provider when requesting a structured output.

Constructors

constructor(default: StructuredRequest<T>? = null, byProvider: Map<LLMProvider, StructuredRequest<T>> = emptyMap(), fixingParser: StructureFixingParser? = null)

Properties

byProvider

val byProvider: Map<LLMProvider, StructuredRequest<T>>

A map matching LLMProvider to compatible StructuredRequest definitions. Each provider may require different schema formats. E.g. for JsonStructure this means you have to use the appropriate JsonSchemaGenerator implementation for each provider for StructuredRequest.Native, or fallback to StructuredRequest.Manual

default

val default: StructuredRequest<T>?

Fallback StructuredRequest to be used when there's no suitable structure found in byProvider for a requested LLMProvider. Defaults to null, meaning structured output would fail with error in such a case.

fixingParser

val fixingParser: StructureFixingParser?

Optional parser that handles malformed responses by using an auxiliary LLM to intelligently fix parsing errors. When specified, parsing errors trigger additional LLM calls with error context to attempt correction of the structure format.

Functions

structure

fun structure(model: LLModel): Structure<T, *>

Retrieves the structured data configuration for a specific large language model (LLM).

updatePrompt

fun updatePrompt(model: LLModel, prompt: Prompt): Prompt

Updates a given prompt to configure structured output using the specified large language model (LLM). Depending on the model's support for structured outputs, the prompt is updated either manually or natively.