Package org.springframework.ai.converter

Interface StructuredOutputConverter<T>

Type Parameters:
T - Specifies the desired response type.
All Superinterfaces:
org.springframework.core.convert.converter.Converter<String,T>, FormatProvider
All Known Implementing Classes:
AbstractConversionServiceOutputConverter, AbstractMessageOutputConverter, BeanOutputConverter, ListOutputConverter, MapOutputConverter
public interface StructuredOutputConverter<T> extends org.springframework.core.convert.converter.Converter<String,T>, FormatProvider
Converts the (raw) LLM output into a structured responses of type. The FormatProvider.getFormat() method should provide the LLM prompt description of the desired format.
Author:
Mark Pollack, Christian Tzolov, Filip Hrisafov

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NO_JSON_SCHEMA
    Constant for when there is no JSON schema available.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getJsonSchema()
    Returns the JSON schema for the structured output of an LLM call.

    Methods inherited from interface org.springframework.core.convert.converter.Converter

    andThen, convert

    Methods inherited from interface org.springframework.ai.converter.FormatProvider

    getFormat

  • Field Details

    • NO_JSON_SCHEMA

      static final String NO_JSON_SCHEMA
      Constant for when there is no JSON schema available.
      See Also:

  • Method Details

    • getJsonSchema

      default String getJsonSchema()
      Returns the JSON schema for the structured output of an LLM call.
      Returns:
      the JSON schema or NO_JSON_SCHEMA if not available
      Since:
      2.0.0