Package org.springframework.ai.chat.client

Interface ChatClient.EntityParamSpec

All Known Implementing Classes:

DefaultChatClient.DefaultEntityParamSpec

Enclosing interface:

ChatClient

public static interface ChatClient.EntityParamSpec

Configures optional behaviour for entity(...) calls. Options may be combined.

Method Summary

Modifier and Type	Method	Description
ChatClient.EntityParamSpec	useProviderStructuredOutput()	Delivers the JSON schema to the AI provider as an API-level constraint rather than appending it as prompt text.
ChatClient.EntityParamSpec	validateSchema()	Validates the model's JSON response against the entity schema and retries with the error feedback on failure, up to maxRepeatAttempts times (default: 3).

Method Details

useProviderStructuredOutput

ChatClient.EntityParamSpec useProviderStructuredOutput()

Delivers the JSON schema to the AI provider as an API-level constraint rather than appending it as prompt text. Has no effect if the underlying ChatModel does not support StructuredOutputChatOptions.

validateSchema

ChatClient.EntityParamSpec validateSchema()

Validates the model's JSON response against the entity schema and retries with the error feedback on failure, up to maxRepeatAttempts times (default: 3). Streaming is not supported.