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. The text of the template should contain the {{userMessage}} and {{contents}} variables.
- metadataKeysToInclude: A list of Metadata keys that should be included with each Content.textSegment().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultContentInjector.DefaultContentInjectorBuilder

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
static DefaultContentInjector.DefaultContentInjectorBuilder	builder()
protected Prompt	createPrompt(ChatMessage chatMessage, List<Content> contents)
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.

Methods inherited from class 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

builder

public static DefaultContentInjector.DefaultContentInjectorBuilder builder()

inject

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

Description copied from interface: ContentInjector

Injects given Contents into a given ChatMessage.

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. Currently, only UserMessage is supported.

Returns:

The ChatMessage with the injected Contents.

createPrompt

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

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)