程序包 dev.langchain4j.rag.content.injector

类 DefaultContentInjector

java.lang.Object

dev.langchain4j.rag.content.injector.DefaultContentInjector

所有已实现的接口:

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().

字段概要

字段

修饰符和类型	字段	说明
static final PromptTemplate	DEFAULT_PROMPT_TEMPLATE

构造器概要

构造器

构造器	说明
DefaultContentInjector()
DefaultContentInjector(PromptTemplate promptTemplate)
DefaultContentInjector(PromptTemplate promptTemplate, List<String> metadataKeysToInclude)
DefaultContentInjector(List<String> metadataKeysToInclude)

方法概要

修饰符和类型	方法	说明
protected Prompt	createPrompt(ChatMessage chatMessage, List<Content> contents)
protected Prompt	createPrompt(UserMessage userMessage, List<Content> contents)	已过时。 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)	已过时。 use inject(List, ChatMessage) instead.

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_PROMPT_TEMPLATE

public static final PromptTemplate DEFAULT_PROMPT_TEMPLATE

构造器详细资料

DefaultContentInjector

public DefaultContentInjector()

DefaultContentInjector

public DefaultContentInjector(List<String> metadataKeysToInclude)

DefaultContentInjector

public DefaultContentInjector(PromptTemplate promptTemplate)

DefaultContentInjector

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

方法详细资料

inject

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

从接口复制的说明: 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.

指定者:

inject 在接口中 ContentInjector

参数:

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.

返回:

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)

已过时。

use inject(List, ChatMessage) instead.

从接口复制的说明: ContentInjector

Injects given Contents into a given UserMessage.

指定者:

inject 在接口中 ContentInjector

参数:

contents - The list of Content to be injected.

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

返回:

The UserMessage with the injected Contents.

createPrompt

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

已过时。

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)