Package org.springframework.ai.model.transformer

Class KeywordMetadataEnricher

java.lang.Object

org.springframework.ai.model.transformer.KeywordMetadataEnricher

All Implemented Interfaces:

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

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

Keyword extractor that uses generative to extract 'excerpt_keywords' metadata field.

Author:

Christian Tzolov, YunKui Lu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeywordMetadataEnricher.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_STR_PLACEHOLDER
static final String	EXCERPT_KEYWORDS_METADATA_KEY
static final String	KEYWORDS_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
KeywordMetadataEnricher(ChatModel chatModel, int keywordCount)	Create a new KeywordMetadataEnricher instance.
KeywordMetadataEnricher(ChatModel chatModel, PromptTemplate keywordsTemplate)	Create a new KeywordMetadataEnricher instance.

Method Summary

Modifier and Type	Method	Description
List<org.springframework.ai.document.Document>	apply(List<org.springframework.ai.document.Document> documents)
static KeywordMetadataEnricher.Builder	builder(ChatModel chatModel)

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

CONTEXT_STR_PLACEHOLDER

public static final String CONTEXT_STR_PLACEHOLDER

See Also:

• Constant Field Values

KEYWORDS_TEMPLATE

public static final String KEYWORDS_TEMPLATE

See Also:

• Constant Field Values

EXCERPT_KEYWORDS_METADATA_KEY

public static final String EXCERPT_KEYWORDS_METADATA_KEY

See Also:

• Constant Field Values

Constructor Details

KeywordMetadataEnricher

public KeywordMetadataEnricher(ChatModel chatModel,
 int keywordCount)

Create a new KeywordMetadataEnricher instance.

Parameters:

chatModel - the model predictor to use for keyword extraction.

keywordCount - the number of keywords to extract.

KeywordMetadataEnricher

public KeywordMetadataEnricher(ChatModel chatModel,
 PromptTemplate keywordsTemplate)

Create a new KeywordMetadataEnricher instance.

Parameters:

chatModel - the model predictor to use for keyword extraction.

keywordsTemplate - the prompt template to use for keyword extraction.

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>>

builder

public static KeywordMetadataEnricher.Builder builder(ChatModel chatModel)