Package dev.langchain4j.chain

Class ConversationalRetrievalChain

java.lang.Object

dev.langchain4j.chain.ConversationalRetrievalChain

All Implemented Interfaces:

Chain<String,String>

public class ConversationalRetrievalChain
extends Object
implements Chain<String,String>

A chain for conversing with a specified ChatLanguageModel based on the information retrieved by a specified ContentRetriever. Includes a default ChatMemory (a message window with maximum 10 messages), which can be overridden. You can fully customize RAG behavior by providing an instance of a RetrievalAugmentor, such as DefaultRetrievalAugmentor, or your own custom implementation.
Chains are not going to be developed further, it is recommended to use AiServices instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConversationalRetrievalChain.Builder

Constructor Summary

Constructors

Constructor	Description
ConversationalRetrievalChain(ChatLanguageModel chatLanguageModel, ChatMemory chatMemory, PromptTemplate promptTemplate, Retriever<TextSegment> retriever)	Deprecated, for removal: This API element is subject to removal in a future version. Please use another constructor with a new ContentRetriever instead.
ConversationalRetrievalChain(ChatLanguageModel chatLanguageModel, ChatMemory chatMemory, ContentRetriever contentRetriever)
ConversationalRetrievalChain(ChatLanguageModel chatLanguageModel, ChatMemory chatMemory, RetrievalAugmentor retrievalAugmentor)

Method Summary

Modifier and Type	Method	Description
static ConversationalRetrievalChain.Builder	builder()
String	execute(String query)	Execute the chain step.

Methods inherited from class java.lang.Object

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

Constructor Details

ConversationalRetrievalChain

public ConversationalRetrievalChain(ChatLanguageModel chatLanguageModel,
 ChatMemory chatMemory,
 ContentRetriever contentRetriever)

ConversationalRetrievalChain

public ConversationalRetrievalChain(ChatLanguageModel chatLanguageModel,
 ChatMemory chatMemory,
 RetrievalAugmentor retrievalAugmentor)

ConversationalRetrievalChain

@Deprecated(forRemoval=true)
public ConversationalRetrievalChain(ChatLanguageModel chatLanguageModel,
 ChatMemory chatMemory,
 PromptTemplate promptTemplate,
 Retriever<TextSegment> retriever)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use another constructor with a new ContentRetriever instead.

Method Details

execute

public String execute(String query)

Description copied from interface: Chain

Execute the chain step.

Specified by:

execute in interface Chain<String,String>

Parameters:

query - the input

Returns:

the output

builder

public static ConversationalRetrievalChain.Builder builder()