Package org.springframework.ai.chat.client.advisor

Class StructuredOutputValidationAdvisor

java.lang.Object

org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor

All Implemented Interfaces:

Advisor, CallAdvisor, StreamAdvisor, org.springframework.core.Ordered

public final class StructuredOutputValidationAdvisor
extends Object
implements CallAdvisor, StreamAdvisor

Advisor that validates the structured JSON output of a chat client response against a JSON schema derived from the configured output type or a pre-supplied schema string.

When validation fails, the advisor appends the validation error to the user message and re-invokes the model, repeating up to maxRepeatAttempts times.

Streaming responses are not supported.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StructuredOutputValidationAdvisor.Builder	Builder for StructuredOutputValidationAdvisor.

Field Summary

Fields inherited from interface org.springframework.ai.chat.client.advisor.api.Advisor

DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
ChatClientResponse	adviseCall(ChatClientRequest chatClientRequest, CallAdvisorChain callAdvisorChain)
reactor.core.publisher.Flux<ChatClientResponse>	adviseStream(ChatClientRequest chatClientRequest, StreamAdvisorChain streamAdvisorChain)
static StructuredOutputValidationAdvisor.Builder	builder()	Returns a new StructuredOutputValidationAdvisor.Builder.
String	getName()	Return the name of the advisor.
int	getOrder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getName

public String getName()

Description copied from interface: Advisor

Return the name of the advisor.

Specified by:

getName in interface Advisor

Returns:

the advisor name.

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

adviseCall

public ChatClientResponse adviseCall(ChatClientRequest chatClientRequest,
 CallAdvisorChain callAdvisorChain)

Specified by:

adviseCall in interface CallAdvisor

adviseStream

public reactor.core.publisher.Flux<ChatClientResponse> adviseStream(ChatClientRequest chatClientRequest,
 StreamAdvisorChain streamAdvisorChain)

Specified by:

adviseStream in interface StreamAdvisor

builder

public static StructuredOutputValidationAdvisor.Builder builder()

Returns a new StructuredOutputValidationAdvisor.Builder.

Returns:

a new builder instance