Package org.springframework.ai.model.transformer

Class SummaryMetadataEnricher

java.lang.Object

org.springframework.ai.model.transformer.SummaryMetadataEnricher

All Implemented Interfaces:

Function<List<org.springframework.ai.document.Document>,List<org.springframework.ai.document.Document>>, org.springframework.ai.document.DocumentTransformer

public class SummaryMetadataEnricher
extends Object
implements org.springframework.ai.document.DocumentTransformer

Title extractor with adjacent sharing that uses generative to extract 'section_summary', 'prev_section_summary', 'next_section_summary' metadata fields.

Since:

1.0.0

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SummaryMetadataEnricher.SummaryType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SUMMARY_EXTRACT_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
SummaryMetadataEnricher(ChatModel chatModel, List<SummaryMetadataEnricher.SummaryType> summaryTypes)
SummaryMetadataEnricher(ChatModel chatModel, List<SummaryMetadataEnricher.SummaryType> summaryTypes, String summaryTemplate, org.springframework.ai.document.MetadataMode metadataMode)

Method Summary

Modifier and Type	Method	Description
List<org.springframework.ai.document.Document>	apply(List<org.springframework.ai.document.Document> documents)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.document.DocumentTransformer

transform

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

DEFAULT_SUMMARY_EXTRACT_TEMPLATE

public static final String DEFAULT_SUMMARY_EXTRACT_TEMPLATE

See Also:

• Constant Field Values

Constructor Details

SummaryMetadataEnricher

public SummaryMetadataEnricher(ChatModel chatModel,
 List<SummaryMetadataEnricher.SummaryType> summaryTypes)

SummaryMetadataEnricher

public SummaryMetadataEnricher(ChatModel chatModel,
 List<SummaryMetadataEnricher.SummaryType> summaryTypes,
 String summaryTemplate,
 org.springframework.ai.document.MetadataMode metadataMode)

Method Details

apply

public List<org.springframework.ai.document.Document> apply(List<org.springframework.ai.document.Document> documents)

Specified by:

apply in interface Function<List<org.springframework.ai.document.Document>,List<org.springframework.ai.document.Document>>