Package dev.langchain4j.rag.content.injector

Class DefaultContentInjector

java.lang.Object

dev.langchain4j.rag.content.injector.DefaultContentInjector

All Implemented Interfaces:

ContentInjector

public class DefaultContentInjector
extends Object
implements ContentInjector

Default implementation of ContentInjector intended to be suitable for the majority of use cases.

It's important to note that while efforts will be made to avoid breaking changes, the default behavior of this class may be updated in the future if it's found that the current behavior does not adequately serve the majority of use cases. Such changes would be made to benefit both current and future users.

This implementation appends all given Contents to the end of the given UserMessage in their order of iteration. Refer to DEFAULT_PROMPT_TEMPLATE and implementation for more details.

Configurable parameters (optional):
- promptTemplate: The prompt template that defines how the original userMessage and contents are combined into the resulting UserMessage.
- metadataKeysToInclude: A list of Metadata keys that should be included with each Content.textSegment().

Field Summary

Fields

Modifier and Type	Field	Description
static final PromptTemplate	DEFAULT_PROMPT_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
DefaultContentInjector()
DefaultContentInjector(PromptTemplate promptTemplate)
DefaultContentInjector(PromptTemplate promptTemplate, List<String> metadataKeysToInclude)
DefaultContentInjector(List<String> metadataKeysToInclude)

Method Summary

Modifier and Type	Method	Description
protected Prompt	createPrompt(ChatMessage chatMessage, List<Content> contents)
protected Prompt	createPrompt(UserMessage userMessage, List<Content> contents)	Deprecated. implement/override createPrompt(ChatMessage, List) instead.
protected String	format(Metadata metadata)
protected String	format(Content content)
protected String	format(String segmentContent, String segmentMetadata)
protected String	format(List<Content> contents)
ChatMessage	inject(List<Content> contents, ChatMessage chatMessage)	Injects given Contents into a given ChatMessage.
UserMessage	inject(List<Content> contents, UserMessage userMessage)	Deprecated. use inject(List, ChatMessage) instead.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PROMPT_TEMPLATE

public static final PromptTemplate DEFAULT_PROMPT_TEMPLATE

Constructor Details

DefaultContentInjector

public DefaultContentInjector()

DefaultContentInjector

public DefaultContentInjector(List<String> metadataKeysToInclude)

DefaultContentInjector

public DefaultContentInjector(PromptTemplate promptTemplate)

DefaultContentInjector

public DefaultContentInjector(PromptTemplate promptTemplate,
 List<String> metadataKeysToInclude)

Method Details

inject

public ChatMessage inject(List<Content> contents,
 ChatMessage chatMessage)

Description copied from interface: ContentInjector

Injects given Contents into a given ChatMessage.
This method has a default implementation in order to temporarily support current custom implementations of ContentInjector. The default implementation will be removed soon.

Specified by:

inject in interface ContentInjector

Parameters:

contents - The list of Content to be injected.

chatMessage - The ChatMessage into which the Contents are to be injected. Can be either a UserMessage or a SystemMessage.

Returns:

The UserMessage with the injected Contents.

createPrompt

protected Prompt createPrompt(ChatMessage chatMessage,
 List<Content> contents)

inject

@Deprecated
public UserMessage inject(List<Content> contents,
 UserMessage userMessage)

Deprecated.

use inject(List, ChatMessage) instead.

Description copied from interface: ContentInjector

Injects given Contents into a given UserMessage.

Specified by:

inject in interface ContentInjector

Parameters:

contents - The list of Content to be injected.

userMessage - The UserMessage into which the Contents are to be injected.

Returns:

The UserMessage with the injected Contents.

createPrompt

@Deprecated
protected Prompt createPrompt(UserMessage userMessage,
 List<Content> contents)

Deprecated.

implement/override createPrompt(ChatMessage, List) instead.

format

protected String format(List<Content> contents)

format

protected String format(Content content)

format

protected String format(Metadata metadata)

format

protected String format(String segmentContent,
 String segmentMetadata)