Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- adapt(TokenStream) - Method in interface dev.langchain4j.spi.services.TokenStreamAdapter
- add(ToolSpecification, ToolExecutor) - Method in class dev.langchain4j.service.tool.ToolProviderResult.Builder
- add(Embedding) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- add(Embedding, Embedded) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- add(ChatMessage) - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
- add(ChatMessage) - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
- add(String, Embedding) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- add(String, Embedding, Embedded) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- addAll(List<Embedding>) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- addAll(List<Embedding>, List<Embedded>) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- addAll(Map<ToolSpecification, ToolExecutor>) - Method in class dev.langchain4j.service.tool.ToolProviderResult.Builder
- aiServiceClass - Variable in class dev.langchain4j.service.AiServiceContext
- AiServiceContext - Class in dev.langchain4j.service
- AiServiceContext(Class<?>) - Constructor for class dev.langchain4j.service.AiServiceContext
- AiServices<T> - Class in dev.langchain4j.service
-
AI Services provide a simpler and more flexible alternative to chains.
- AiServices(AiServiceContext) - Constructor for class dev.langchain4j.service.AiServices
- AiServicesFactory - Interface in dev.langchain4j.spi.services
- AiServiceTokenStream - Class in dev.langchain4j.service
- AiServiceTokenStream(List<ChatMessage>, List<ToolSpecification>, Map<String, ToolExecutor>, List<Content>, AiServiceContext, Object) - Constructor for class dev.langchain4j.service.AiServiceTokenStream
B
- build() - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
- build() - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory.Builder
- build() - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory.Builder
- build() - Method in class dev.langchain4j.service.AiServices
-
Constructs and returns the AI Service.
- build() - Method in class dev.langchain4j.service.tool.ToolExecution.Builder
- build() - Method in class dev.langchain4j.service.tool.ToolProviderResult.Builder
- builder() - Static method in class dev.langchain4j.chain.ConversationalRetrievalChain
- builder() - Static method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
- builder() - Static method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
- builder() - Static method in class dev.langchain4j.service.tool.ToolExecution
- builder() - Static method in class dev.langchain4j.service.tool.ToolProviderResult
- builder(Class<T>) - Static method in class dev.langchain4j.service.AiServices
-
Begins the construction of an AI Service.
- Builder() - Constructor for class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
- Builder() - Constructor for class dev.langchain4j.memory.chat.MessageWindowChatMemory.Builder
- Builder() - Constructor for class dev.langchain4j.memory.chat.TokenWindowChatMemory.Builder
- Builder() - Constructor for class dev.langchain4j.service.tool.ToolProviderResult.Builder
C
- canAdaptTokenStreamTo(Type) - Method in interface dev.langchain4j.spi.services.TokenStreamAdapter
- Chain<Input,
Output> - Interface in dev.langchain4j.chain -
Represents a chain step that takes an input and produces an output.
- chatLanguageModel(ChatLanguageModel) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
- chatLanguageModel(ChatLanguageModel) - Method in class dev.langchain4j.service.AiServices
-
Configures chat model that will be used under the hood of the AI Service.
- chatMemories - Variable in class dev.langchain4j.service.AiServiceContext
- chatMemory(ChatMemory) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
- chatMemory(ChatMemory) - Method in class dev.langchain4j.service.AiServices
-
Configures the chat memory that will be used to preserve conversation history between method calls.
- chatMemory(Object) - Method in class dev.langchain4j.service.AiServiceContext
- chatMemoryId() - Method in class dev.langchain4j.service.tool.ToolProviderRequest
- chatMemoryProvider - Variable in class dev.langchain4j.service.AiServiceContext
- chatMemoryProvider(ChatMemoryProvider) - Method in class dev.langchain4j.service.AiServices
-
Configures the chat memory provider, which provides a dedicated instance of
ChatMemory
for each user/conversation. - ChatMemoryProvider - Interface in dev.langchain4j.memory.chat
-
Provides instances of
ChatMemory
. - chatMemoryStore(ChatMemoryStore) - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory.Builder
- chatMemoryStore(ChatMemoryStore) - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory.Builder
- chatModel - Variable in class dev.langchain4j.service.AiServiceContext
- classify(Document) - Method in interface dev.langchain4j.classification.TextClassifier
-
Classify the given
Document
. - classify(TextSegment) - Method in interface dev.langchain4j.classification.TextClassifier
-
Classify the given
TextSegment
. - classify(String) - Method in class dev.langchain4j.classification.EmbeddingModelTextClassifier
- classify(String) - Method in interface dev.langchain4j.classification.TextClassifier
-
Classify the given text.
- clear() - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
- clear() - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
- content() - Method in class dev.langchain4j.service.Result
- contentRetriever(ContentRetriever) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
- contentRetriever(ContentRetriever) - Method in class dev.langchain4j.service.AiServices
-
Configures a content retriever to be invoked on every method call for retrieving relevant content related to the user's message from an underlying data source (e.g., an embedding store in the case of an
EmbeddingStoreContentRetriever
). - context - Variable in class dev.langchain4j.service.AiServices
- ConversationalChain - Class in dev.langchain4j.chain
-
A chain for conversing with a specified
ChatLanguageModel
while maintaining a memory of the conversation. - ConversationalRetrievalChain - Class in dev.langchain4j.chain
-
A chain for conversing with a specified
ChatLanguageModel
based on the information retrieved by a specifiedContentRetriever
. - ConversationalRetrievalChain(ChatLanguageModel, ChatMemory, PromptTemplate, Retriever<TextSegment>) - Constructor for class dev.langchain4j.chain.ConversationalRetrievalChain
-
Deprecated.
- ConversationalRetrievalChain(ChatLanguageModel, ChatMemory, ContentRetriever) - Constructor for class dev.langchain4j.chain.ConversationalRetrievalChain
- ConversationalRetrievalChain(ChatLanguageModel, ChatMemory, RetrievalAugmentor) - Constructor for class dev.langchain4j.chain.ConversationalRetrievalChain
- ConversationalRetrievalChain.Builder - Class in dev.langchain4j.chain
- create() - Method in interface dev.langchain4j.spi.store.embedding.inmemory.InMemoryEmbeddingStoreJsonCodecFactory
- create(AiServiceContext) - Method in interface dev.langchain4j.spi.services.AiServicesFactory
- create(Class<T>, ChatLanguageModel) - Static method in class dev.langchain4j.service.AiServices
-
Creates an AI Service (an implementation of the provided interface), that is backed by the provided chat model.
- create(Class<T>, StreamingChatLanguageModel) - Static method in class dev.langchain4j.service.AiServices
-
Creates an AI Service (an implementation of the provided interface), that is backed by the provided streaming chat model.
D
- DEFAULT - Static variable in class dev.langchain4j.service.AiServices
- defaultSubSplitter() - Method in class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
- defaultSubSplitter() - Method in class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
- defaultSubSplitter() - Method in class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
- defaultSubSplitter() - Method in class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
- defaultSubSplitter() - Method in class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
- defaultSubSplitter() - Method in class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
- defaultSubSplitter() - Method in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
-
The default sub-splitter to use when a single segment is too long.
- DefaultToolExecutor - Class in dev.langchain4j.service.tool
- DefaultToolExecutor(Object, ToolExecutionRequest) - Constructor for class dev.langchain4j.service.tool.DefaultToolExecutor
- DefaultToolExecutor(Object, Method) - Constructor for class dev.langchain4j.service.tool.DefaultToolExecutor
- delimiter() - Element in annotation type dev.langchain4j.service.SystemMessage
- delimiter() - Element in annotation type dev.langchain4j.service.UserMessage
- dev.langchain4j.chain - package dev.langchain4j.chain
- dev.langchain4j.classification - package dev.langchain4j.classification
- dev.langchain4j.data.document.loader - package dev.langchain4j.data.document.loader
- dev.langchain4j.data.document.parser - package dev.langchain4j.data.document.parser
- dev.langchain4j.data.document.source - package dev.langchain4j.data.document.source
- dev.langchain4j.data.document.splitter - package dev.langchain4j.data.document.splitter
- dev.langchain4j.exception - package dev.langchain4j.exception
- dev.langchain4j.memory.chat - package dev.langchain4j.memory.chat
- dev.langchain4j.service - package dev.langchain4j.service
- dev.langchain4j.service.output - package dev.langchain4j.service.output
- dev.langchain4j.service.tool - package dev.langchain4j.service.tool
- dev.langchain4j.spi.services - package dev.langchain4j.spi.services
- dev.langchain4j.spi.store.embedding.inmemory - package dev.langchain4j.spi.store.embedding.inmemory
- dev.langchain4j.store.embedding.inmemory - package dev.langchain4j.store.embedding.inmemory
- DocumentByCharacterSplitter - Class in dev.langchain4j.data.document.splitter
-
Splits the provided
Document
into characters and attempts to fit as many characters as possible into a singleTextSegment
, adhering to the limit set bymaxSegmentSize
. - DocumentByCharacterSplitter(int, int) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
- DocumentByCharacterSplitter(int, int, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
- DocumentByCharacterSplitter(int, int, Tokenizer) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
- DocumentByCharacterSplitter(int, int, Tokenizer, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
- DocumentByLineSplitter - Class in dev.langchain4j.data.document.splitter
-
Splits the provided
Document
into lines and attempts to fit as many lines as possible into a singleTextSegment
, adhering to the limit set bymaxSegmentSize
. - DocumentByLineSplitter(int, int) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
- DocumentByLineSplitter(int, int, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
- DocumentByLineSplitter(int, int, Tokenizer) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
- DocumentByLineSplitter(int, int, Tokenizer, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
- DocumentByParagraphSplitter - Class in dev.langchain4j.data.document.splitter
-
Splits the provided
Document
into paragraphs and attempts to fit as many paragraphs as possible into a singleTextSegment
, adhering to the limit set bymaxSegmentSize
. - DocumentByParagraphSplitter(int, int) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
- DocumentByParagraphSplitter(int, int, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
- DocumentByParagraphSplitter(int, int, Tokenizer) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
- DocumentByParagraphSplitter(int, int, Tokenizer, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
- DocumentByRegexSplitter - Class in dev.langchain4j.data.document.splitter
-
Splits the provided
Document
into parts using the providedregex
and attempts to fit as many parts as possible into a singleTextSegment
, adhering to the limit set bymaxSegmentSize
. - DocumentByRegexSplitter(String, String, int, int) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
- DocumentByRegexSplitter(String, String, int, int, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
- DocumentByRegexSplitter(String, String, int, int, Tokenizer) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
- DocumentByRegexSplitter(String, String, int, int, Tokenizer, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
- DocumentBySentenceSplitter - Class in dev.langchain4j.data.document.splitter
-
Splits the provided
Document
into sentences and attempts to fit as many sentences as possible into a singleTextSegment
, adhering to the limit set bymaxSegmentSize
. - DocumentBySentenceSplitter(int, int) - Constructor for class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
- DocumentBySentenceSplitter(int, int, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
- DocumentBySentenceSplitter(int, int, Tokenizer) - Constructor for class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
- DocumentBySentenceSplitter(int, int, Tokenizer, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
- DocumentByWordSplitter - Class in dev.langchain4j.data.document.splitter
-
Splits the provided
Document
into words and attempts to fit as many words as possible into a singleTextSegment
, adhering to the limit set bymaxSegmentSize
. - DocumentByWordSplitter(int, int) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
- DocumentByWordSplitter(int, int, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
- DocumentByWordSplitter(int, int, Tokenizer) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
- DocumentByWordSplitter(int, int, Tokenizer, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
- DocumentSplitters - Class in dev.langchain4j.data.document.splitter
- DocumentSplitters() - Constructor for class dev.langchain4j.data.document.splitter.DocumentSplitters
E
- EmbeddingModelTextClassifier<E> - Class in dev.langchain4j.classification
-
A
TextClassifier
that uses anEmbeddingModel
and predefined examples to perform classification. - EmbeddingModelTextClassifier(EmbeddingModel, Map<E, ? extends Collection<String>>) - Constructor for class dev.langchain4j.classification.EmbeddingModelTextClassifier
-
Creates a classifier with the default values for
EmbeddingModelTextClassifier.maxResults
(1),EmbeddingModelTextClassifier.minScore
(0) andEmbeddingModelTextClassifier.meanToMaxScoreRatio
(0.5). - EmbeddingModelTextClassifier(EmbeddingModel, Map<E, ? extends Collection<String>>, int, double, double) - Constructor for class dev.langchain4j.classification.EmbeddingModelTextClassifier
-
Creates a classifier.
- equals(Object) - Method in class dev.langchain4j.service.tool.ToolExecution
- execute(ToolExecutionRequest, Object) - Method in class dev.langchain4j.service.tool.DefaultToolExecutor
- execute(ToolExecutionRequest, Object) - Method in interface dev.langchain4j.service.tool.ToolExecutor
-
Executes a tool requests.
- execute(Input) - Method in interface dev.langchain4j.chain.Chain
-
Execute the chain step.
- execute(String) - Method in class dev.langchain4j.chain.ConversationalChain
- execute(String) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain
F
- FileSystemDocumentLoader - Class in dev.langchain4j.data.document.loader
- FileSystemSource - Class in dev.langchain4j.data.document.source
- FileSystemSource(Path) - Constructor for class dev.langchain4j.data.document.source.FileSystemSource
- finishReason() - Method in class dev.langchain4j.service.Result
- from(File) - Static method in class dev.langchain4j.data.document.source.FileSystemSource
- from(String) - Static method in class dev.langchain4j.data.document.source.FileSystemSource
- from(String) - Static method in class dev.langchain4j.data.document.source.UrlSource
- from(URI) - Static method in class dev.langchain4j.data.document.source.FileSystemSource
- from(URI) - Static method in class dev.langchain4j.data.document.source.UrlSource
- from(URL) - Static method in class dev.langchain4j.data.document.source.UrlSource
- from(Path) - Static method in class dev.langchain4j.data.document.source.FileSystemSource
- fromFile(String) - Static method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- fromFile(Path) - Static method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- fromJson(String) - Method in class dev.langchain4j.store.embedding.inmemory.GsonInMemoryEmbeddingStoreJsonCodec
- fromJson(String) - Static method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- fromJson(String) - Method in interface dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStoreJsonCodec
- fromResource() - Element in annotation type dev.langchain4j.service.SystemMessage
-
The resource from which to read the prompt template.
- fromResource() - Element in annotation type dev.langchain4j.service.UserMessage
-
The resource from which to read the prompt template.
G
- get(Object) - Method in interface dev.langchain4j.memory.chat.ChatMemoryProvider
-
Provides an instance of
ChatMemory
. - getRawClass(Type) - Static method in class dev.langchain4j.service.TypeUtils
- GsonInMemoryEmbeddingStoreJsonCodec - Class in dev.langchain4j.store.embedding.inmemory
- GsonInMemoryEmbeddingStoreJsonCodec() - Constructor for class dev.langchain4j.store.embedding.inmemory.GsonInMemoryEmbeddingStoreJsonCodec
H
- hasChatMemory() - Method in class dev.langchain4j.service.AiServiceContext
- hashCode() - Method in class dev.langchain4j.service.tool.ToolExecution
- HierarchicalDocumentSplitter - Class in dev.langchain4j.data.document.splitter
-
Base class for hierarchical document splitters.
- HierarchicalDocumentSplitter(int, int) - Constructor for class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
-
Creates a new instance of
HierarchicalDocumentSplitter
. - HierarchicalDocumentSplitter(int, int, HierarchicalDocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
-
Creates a new instance of
HierarchicalDocumentSplitter
. - HierarchicalDocumentSplitter(int, int, Tokenizer) - Constructor for class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
-
Creates a new instance of
HierarchicalDocumentSplitter
. - HierarchicalDocumentSplitter(int, int, Tokenizer, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
-
Creates a new instance of
HierarchicalDocumentSplitter
.
I
- id() - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
- id() - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
- id(Object) - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory.Builder
- id(Object) - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory.Builder
- ignoreErrors() - Method in class dev.langchain4j.service.AiServiceTokenStream
- ignoreErrors() - Method in interface dev.langchain4j.service.TokenStream
-
All errors during streaming will be ignored (but will be logged with a WARN log level).
- illegalConfiguration(String) - Static method in exception class dev.langchain4j.exception.IllegalConfigurationException
- illegalConfiguration(String, Object...) - Static method in exception class dev.langchain4j.exception.IllegalConfigurationException
- IllegalConfigurationException - Exception Class in dev.langchain4j.exception
- IllegalConfigurationException(String) - Constructor for exception class dev.langchain4j.exception.IllegalConfigurationException
- InMemoryEmbeddingStore<Embedded> - Class in dev.langchain4j.store.embedding.inmemory
-
An
EmbeddingStore
that stores embeddings in memory. - InMemoryEmbeddingStore() - Constructor for class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- InMemoryEmbeddingStoreJsonCodec - Interface in dev.langchain4j.store.embedding.inmemory
- InMemoryEmbeddingStoreJsonCodecFactory - Interface in dev.langchain4j.spi.store.embedding.inmemory
- inputStream() - Method in class dev.langchain4j.data.document.source.FileSystemSource
- inputStream() - Method in class dev.langchain4j.data.document.source.UrlSource
J
- joinDelimiter() - Method in class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
- joinDelimiter() - Method in class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
- joinDelimiter() - Method in class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
- joinDelimiter() - Method in class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
- joinDelimiter() - Method in class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
- joinDelimiter() - Method in class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
- joinDelimiter() - Method in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
-
Delimiter string to use to re-join the parts.
- jsonSchemaFrom(Type) - Static method in class dev.langchain4j.service.output.JsonSchemas
- JsonSchemas - Class in dev.langchain4j.service.output
- JsonSchemas() - Constructor for class dev.langchain4j.service.output.JsonSchemas
L
- load(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.UrlDocumentLoader
-
Loads a document from the specified URL.
- load(URL, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.UrlDocumentLoader
-
Loads a document from the specified URL.
- loadDocument(String) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads a
Document
from the specified file path. - loadDocument(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads a
Document
from the specified file path. - loadDocument(Path) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads a
Document
from the specified filePath
. - loadDocument(Path, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads a
Document
from the specified filePath
. - loadDocuments(String) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads
Document
s from the specified directory. - loadDocuments(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads
Document
s from the specified directory. - loadDocuments(String, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads matching
Document
s from the specified directory. - loadDocuments(String, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads matching
Document
s from the specified directory. - loadDocuments(Path) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads
Document
s from the specified directory. - loadDocuments(Path, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads
Document
s from the specified directory. - loadDocuments(Path, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads matching
Document
s from the specified directory. - loadDocuments(Path, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Loads matching
Document
s from the specified directory. - loadDocumentsRecursively(String) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads
Document
s from the specified directory and its subdirectories. - loadDocumentsRecursively(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads
Document
s from the specified directory and its subdirectories. - loadDocumentsRecursively(String, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads matching
Document
s from the specified directory and its subdirectories. - loadDocumentsRecursively(String, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads matching
Document
s from the specified directory and its subdirectories. - loadDocumentsRecursively(Path) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads
Document
s from the specified directory and its subdirectories. - loadDocumentsRecursively(Path, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads
Document
s from the specified directory and its subdirectories. - loadDocumentsRecursively(Path, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads matching
Document
s from the specified directory and its subdirectories. - loadDocumentsRecursively(Path, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader
-
Recursively loads matching
Document
s from the specified directory and its subdirectories.
M
- maxMessages(Integer) - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory.Builder
- maxOverlapSize - Variable in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
- maxSegmentSize - Variable in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
- maxTokens(Integer, Tokenizer) - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory.Builder
- MemoryId - Annotation Type in dev.langchain4j.service
-
The value of a method parameter annotated with @MemoryId will be used to find the memory belonging to that user/conversation.
- merge(InMemoryEmbeddingStore<Embedded>, InMemoryEmbeddingStore<Embedded>) - Static method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
-
Merges given
InMemoryEmbeddingStore
s into a singleInMemoryEmbeddingStore
, copying all entries from each store. - merge(Collection<InMemoryEmbeddingStore<Embedded>>) - Static method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
-
Merges given
InMemoryEmbeddingStore
s into a singleInMemoryEmbeddingStore
, copying all entries from each store. - messages() - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
- messages() - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
- MessageWindowChatMemory - Class in dev.langchain4j.memory.chat
-
This chat memory operates as a sliding window of
MessageWindowChatMemory.maxMessages
messages. - MessageWindowChatMemory.Builder - Class in dev.langchain4j.memory.chat
- metadata() - Method in class dev.langchain4j.data.document.source.FileSystemSource
- metadata() - Method in class dev.langchain4j.data.document.source.UrlSource
- Moderate - Annotation Type in dev.langchain4j.service
-
When a method in the AI Service is annotated with @Moderate, each invocation of this method will call not only the LLM, but also the moderation model (which must be provided during the construction of the AI Service) in parallel.
- ModerationException - Exception Class in dev.langchain4j.service
-
Thrown when content moderation fails, i.e., when content is flagged by the moderation model.
- ModerationException(String) - Constructor for exception class dev.langchain4j.service.ModerationException
- moderationModel - Variable in class dev.langchain4j.service.AiServiceContext
- moderationModel(ModerationModel) - Method in class dev.langchain4j.service.AiServices
-
Configures a moderation model to be used for automatic content moderation.
O
- onComplete(Consumer<Response<AiMessage>>) - Method in class dev.langchain4j.service.AiServiceTokenStream
- onComplete(Consumer<Response<AiMessage>>) - Method in interface dev.langchain4j.service.TokenStream
-
The provided consumer will be invoked when a language model finishes streaming a response.
- onError(Consumer<Throwable>) - Method in class dev.langchain4j.service.AiServiceTokenStream
- onError(Consumer<Throwable>) - Method in interface dev.langchain4j.service.TokenStream
-
The provided consumer will be invoked when an error occurs during streaming.
- onNext(Consumer<String>) - Method in class dev.langchain4j.service.AiServiceTokenStream
- onNext(Consumer<String>) - Method in interface dev.langchain4j.service.TokenStream
-
The provided consumer will be invoked every time a new token from a language model is available.
- onRetrieved(Consumer<List<Content>>) - Method in class dev.langchain4j.service.AiServiceTokenStream
- onRetrieved(Consumer<List<Content>>) - Method in interface dev.langchain4j.service.TokenStream
-
The provided consumer will be invoked when/if contents have been retrieved using
RetrievalAugmentor
. - outputFormatInstructions(Type) - Method in class dev.langchain4j.service.output.ServiceOutputParser
P
- parse(Response<AiMessage>, Type) - Method in class dev.langchain4j.service.output.ServiceOutputParser
- parse(InputStream) - Method in class dev.langchain4j.data.document.parser.TextDocumentParser
- path - Variable in class dev.langchain4j.data.document.source.FileSystemSource
- performBasicValidation() - Method in class dev.langchain4j.service.AiServices
- promptTemplate(PromptTemplate) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
-
Deprecated.
- provideTools(ToolProviderRequest) - Method in interface dev.langchain4j.service.tool.ToolProvider
-
Provides tools for the request to the LLM.
R
- recursive(int, int) - Static method in class dev.langchain4j.data.document.splitter.DocumentSplitters
-
This is a recommended
DocumentSplitter
for generic text. - recursive(int, int, Tokenizer) - Static method in class dev.langchain4j.data.document.splitter.DocumentSplitters
-
This is a recommended
DocumentSplitter
for generic text. - removeAll() - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- removeAll(Filter) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- removeAll(Collection<String>) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- removeToolMessages(List<ChatMessage>) - Static method in class dev.langchain4j.service.AiServices
- request() - Method in class dev.langchain4j.service.tool.ToolExecution
-
Returns the request of the tool execution.
- request(ToolExecutionRequest) - Method in class dev.langchain4j.service.tool.ToolExecution.Builder
- resolveFirstGenericParameterClass(Type) - Static method in class dev.langchain4j.service.TypeUtils
- result() - Method in class dev.langchain4j.service.tool.ToolExecution
-
Returns the result of the tool execution.
- result(String) - Method in class dev.langchain4j.service.tool.ToolExecution.Builder
- Result<T> - Class in dev.langchain4j.service
-
Represents the result of an AI Service invocation.
- Result(T, TokenUsage, List<Content>, FinishReason, List<ToolExecution>) - Constructor for class dev.langchain4j.service.Result
- retrievalAugmentor - Variable in class dev.langchain4j.service.AiServiceContext
- retrievalAugmentor(RetrievalAugmentor) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
- retrievalAugmentor(RetrievalAugmentor) - Method in class dev.langchain4j.service.AiServices
-
Configures a retrieval augmentor to be invoked on every method call.
- retriever(Retriever<TextSegment>) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
-
Deprecated.
- retriever(Retriever<TextSegment>) - Method in class dev.langchain4j.service.AiServices
-
Deprecated.
S
- search(EmbeddingSearchRequest) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- serializeToFile(String) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- serializeToFile(Path) - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- serializeToJson() - Method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
- ServiceOutputParser - Class in dev.langchain4j.service.output
- ServiceOutputParser() - Constructor for class dev.langchain4j.service.output.ServiceOutputParser
- sources() - Method in class dev.langchain4j.service.Result
- split(Document) - Method in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
- split(String) - Method in class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
- split(String) - Method in class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
- split(String) - Method in class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
- split(String) - Method in class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
- split(String) - Method in class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
- split(String) - Method in class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
- split(String) - Method in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
-
Splits the provided text into parts.
- start() - Method in class dev.langchain4j.service.AiServiceTokenStream
- start() - Method in interface dev.langchain4j.service.TokenStream
-
Completes the current token stream building and starts processing.
- streamingChatLanguageModel(StreamingChatLanguageModel) - Method in class dev.langchain4j.service.AiServices
-
Configures streaming chat model that will be used under the hood of the AI Service.
- streamingChatModel - Variable in class dev.langchain4j.service.AiServiceContext
- subSplitter - Variable in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
- SystemMessage - Annotation Type in dev.langchain4j.service
-
Specifies either a complete system message (prompt) or a system message template to be used each time an AI service is invoked.
- systemMessageProvider - Variable in class dev.langchain4j.service.AiServiceContext
- systemMessageProvider(Function<Object, String>) - Method in class dev.langchain4j.service.AiServices
-
Configures the system message provider, which provides a system message to be used each time an AI service is invoked.
T
- TextClassifier<E> - Interface in dev.langchain4j.classification
-
Classifies given text according to specified enum.
- TextDocumentParser - Class in dev.langchain4j.data.document.parser
- TextDocumentParser() - Constructor for class dev.langchain4j.data.document.parser.TextDocumentParser
- TextDocumentParser(Charset) - Constructor for class dev.langchain4j.data.document.parser.TextDocumentParser
- toJson(InMemoryEmbeddingStore<?>) - Method in class dev.langchain4j.store.embedding.inmemory.GsonInMemoryEmbeddingStoreJsonCodec
- toJson(InMemoryEmbeddingStore<?>) - Method in interface dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStoreJsonCodec
- tokenizer - Variable in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
- TokenStream - Interface in dev.langchain4j.service
-
Represents a token stream from language model to which you can subscribe and receive updates when a new token is available, when language model finishes streaming, or when an error occurs during streaming.
- TokenStreamAdapter - Interface in dev.langchain4j.spi.services
- tokenUsage() - Method in class dev.langchain4j.service.Result
- TokenWindowChatMemory - Class in dev.langchain4j.memory.chat
-
This chat memory operates as a sliding window of
TokenWindowChatMemory.maxTokens
tokens. - TokenWindowChatMemory.Builder - Class in dev.langchain4j.memory.chat
- ToolExecution - Class in dev.langchain4j.service.tool
-
Represents the execution of a tool, including the request and the result.
- ToolExecution.Builder - Class in dev.langchain4j.service.tool
- toolExecutions() - Method in class dev.langchain4j.service.Result
- ToolExecutor - Interface in dev.langchain4j.service.tool
-
A low-level executor/handler of a
ToolExecutionRequest
. - toolExecutors - Variable in class dev.langchain4j.service.AiServiceContext
- toolProvider - Variable in class dev.langchain4j.service.AiServiceContext
- toolProvider(ToolProvider) - Method in class dev.langchain4j.service.AiServices
-
Configures the tool provider that the LLM can use
- ToolProvider - Interface in dev.langchain4j.service.tool
-
A tool provider.
- ToolProviderRequest - Class in dev.langchain4j.service.tool
- ToolProviderRequest(Object, UserMessage) - Constructor for class dev.langchain4j.service.tool.ToolProviderRequest
- ToolProviderResult - Class in dev.langchain4j.service.tool
- ToolProviderResult(Map<ToolSpecification, ToolExecutor>) - Constructor for class dev.langchain4j.service.tool.ToolProviderResult
- ToolProviderResult.Builder - Class in dev.langchain4j.service.tool
- tools() - Method in class dev.langchain4j.service.tool.ToolProviderResult
- tools(Object...) - Method in class dev.langchain4j.service.AiServices
-
Configures the tools that the LLM can use.
- tools(List<Object>) - Method in class dev.langchain4j.service.AiServices
-
Configures the tools that the LLM can use.
- tools(Map<ToolSpecification, ToolExecutor>) - Method in class dev.langchain4j.service.AiServices
-
Configures the tools that the LLM can use.
- toolSpecifications - Variable in class dev.langchain4j.service.AiServiceContext
- toString() - Method in class dev.langchain4j.service.tool.ToolExecution
- typeHasRawClass(Type, Class<?>) - Static method in class dev.langchain4j.service.TypeUtils
- TypeUtils - Class in dev.langchain4j.service
- TypeUtils() - Constructor for class dev.langchain4j.service.TypeUtils
U
- UrlDocumentLoader - Class in dev.langchain4j.data.document.loader
- UrlDocumentLoader() - Constructor for class dev.langchain4j.data.document.loader.UrlDocumentLoader
- UrlSource - Class in dev.langchain4j.data.document.source
- UrlSource(URL) - Constructor for class dev.langchain4j.data.document.source.UrlSource
- userMessage() - Method in class dev.langchain4j.service.tool.ToolProviderRequest
- UserMessage - Annotation Type in dev.langchain4j.service
-
Specifies either a complete user message or a user message template to be used each time an AI service is invoked.
- UserName - Annotation Type in dev.langchain4j.service
-
The value of a method parameter annotated with @UserName will be injected into the field 'name' of a UserMessage.
V
- V - Annotation Type in dev.langchain4j.service
-
When a parameter of a method in an AI Service is annotated with
@V
, it becomes a prompt template variable. - validateReturnTypesAreProperlyParametrized(String, Type) - Static method in class dev.langchain4j.service.TypeUtils
-
Ensures that no wildcard and/or parametrized types are being used as service method return type.
- value() - Element in annotation type dev.langchain4j.service.SystemMessage
-
Prompt template can be defined in one line or multiple lines.
- value() - Element in annotation type dev.langchain4j.service.UserMessage
-
Prompt template can be defined in one line or multiple lines.
- value() - Element in annotation type dev.langchain4j.service.V
-
Name of a variable (placeholder) in a prompt template.
- verifyModerationIfNeeded(Future<Moderation>) - Static method in class dev.langchain4j.service.AiServices
W
- withMaxMessages(int) - Static method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
- withMaxTokens(int, Tokenizer) - Static method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form