Index (LangChain4j 1.3.0 API)

A B C D E F G H I J L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractGuardrailService - Class in dev.langchain4j.service.guardrail: Responsible for managing and applying input and output guardrails to methods of a specified AI service class.
AbstractGuardrailService(Class<?>, Map<Object, InputGuardrailExecutor>, Map<Object, OutputGuardrailExecutor>) - Constructor for class dev.langchain4j.service.guardrail.AbstractGuardrailService
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<String>, 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
aggregateResponse() - Method in class dev.langchain4j.service.tool.ToolServiceResult
aggregateTokenUsage() - Method in class dev.langchain4j.service.tool.ToolServiceResult
aggregateTokenUsage(TokenUsage) - Method in class dev.langchain4j.service.tool.ToolServiceResult.Builder
aiServiceClass - Variable in class dev.langchain4j.service.AiServiceContext
aiServiceClass() - Method in class dev.langchain4j.service.guardrail.AbstractGuardrailService
aiServiceClass() - Method in interface dev.langchain4j.service.guardrail.GuardrailService: Retrieves the class representing the AI service to which the guardrails apply.
AiServiceContext - Class in dev.langchain4j.service
AiServiceContext(Class<?>) - Constructor for class dev.langchain4j.service.AiServiceContext
AiServices<T> - Class in dev.langchain4j.service: AI Services is a high-level API of LangChain4j to interact with ChatModel and StreamingChatModel.
AiServices(AiServiceContext) - Constructor for class dev.langchain4j.service.AiServices
AiServicesFactory - Interface in dev.langchain4j.spi.services
AiServiceTokenStream - Class in dev.langchain4j.service
AiServiceTokenStream(AiServiceTokenStreamParameters) - Constructor for class dev.langchain4j.service.AiServiceTokenStream: Creates a new instance of AiServiceTokenStream with the given parameters.
AiServiceTokenStreamParameters - Class in dev.langchain4j.service: Parameters for creating an AiServiceTokenStream.
AiServiceTokenStreamParameters(AiServiceTokenStreamParameters.Builder) - Constructor for class dev.langchain4j.service.AiServiceTokenStreamParameters
AiServiceTokenStreamParameters.Builder - Class in dev.langchain4j.service: Builder for AiServiceTokenStreamParameters.
apply(ToolExecutionRequest) - Method in enum class dev.langchain4j.service.tool.HallucinatedToolNameStrategy
applyToolHallucinationStrategy(ToolExecutionRequest) - Method in class dev.langchain4j.service.tool.ToolService

B

beforeToolExecution(Consumer<BeforeToolExecution>) - Method in class dev.langchain4j.service.AiServiceTokenStream
beforeToolExecution(Consumer<BeforeToolExecution>) - Method in interface dev.langchain4j.service.TokenStream: The provided consumer will be invoked right before a tool is executed.
BeforeToolExecution - Class in dev.langchain4j.service.tool
BeforeToolExecution.Builder - Class in dev.langchain4j.service.tool
build() - Method in class dev.langchain4j.chain.ConversationalChain.ConversationalChainBuilder
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.AiServiceTokenStreamParameters.Builder: Builds a new AiServiceTokenStreamParameters.
build() - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Builds and returns an instance of GuardrailService.
build() - Method in class dev.langchain4j.service.Result.ResultBuilder
build() - Method in class dev.langchain4j.service.tool.BeforeToolExecution.Builder
build() - Method in class dev.langchain4j.service.tool.ToolExecution.Builder
build() - Method in class dev.langchain4j.service.tool.ToolProviderResult.Builder
build() - Method in class dev.langchain4j.service.tool.ToolServiceResult.Builder
builder() - Static method in class dev.langchain4j.chain.ConversationalChain
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.AiServiceTokenStreamParameters: Creates a new builder for AiServiceTokenStreamParameters.
builder() - Static method in class dev.langchain4j.service.Result
builder() - Static method in class dev.langchain4j.service.tool.BeforeToolExecution
builder() - Static method in class dev.langchain4j.service.tool.ToolExecution
builder() - Static method in class dev.langchain4j.service.tool.ToolProviderResult
builder() - Static method in class dev.langchain4j.service.tool.ToolServiceResult
builder(AiServiceContext) - Static method in class dev.langchain4j.service.AiServices
builder(Class<?>) - Static method in interface dev.langchain4j.service.guardrail.GuardrailService: Creates a new instance of GuardrailService.Builder for the specified AI service class.
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.AiServiceTokenStreamParameters.Builder
Builder() - Constructor for class dev.langchain4j.service.tool.ToolProviderResult.Builder
Builder() - Constructor for class dev.langchain4j.service.tool.ToolServiceResult.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.
chatMemory(ChatMemory) - Method in class dev.langchain4j.chain.ConversationalChain.ConversationalChainBuilder
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.
ChatMemoryAccess - Interface in dev.langchain4j.service.memory: Allow to access the ChatMemory of any AI service extending it.
chatMemoryId() - Method in class dev.langchain4j.service.tool.ToolProviderRequest
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.
chatMemoryService - Variable in class dev.langchain4j.service.AiServiceContext
ChatMemoryService - Class in dev.langchain4j.service.memory
ChatMemoryService(ChatMemoryProvider) - Constructor for class dev.langchain4j.service.memory.ChatMemoryService
ChatMemoryService(ChatMemory) - Constructor for class dev.langchain4j.service.memory.ChatMemoryService
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
chatModel(ChatModel) - Method in class dev.langchain4j.chain.ConversationalChain.ConversationalChainBuilder
chatModel(ChatModel) - Method in class dev.langchain4j.chain.ConversationalRetrievalChain.Builder
chatModel(ChatModel) - Method in class dev.langchain4j.service.AiServices: Configures chat model that will be used under the hood of the AI Service.
chatRequestTransformer - Variable in class dev.langchain4j.service.AiServiceContext
chatRequestTransformer(BiFunction<ChatRequest, Object, ChatRequest>) - Method in class dev.langchain4j.service.AiServices: Configures a transformer that will be applied to the ChatRequest before it is sent to the LLM.
chatRequestTransformer(UnaryOperator<ChatRequest>) - Method in class dev.langchain4j.service.AiServices: Configures a transformer that will be applied to the ChatRequest before it is sent to the LLM.
chatResponse() - Method in class dev.langchain4j.service.tool.ToolServiceResult: Deprecated.
Please use ToolServiceResult.aggregateResponse() instead for clarity
ClassificationResult<L> - Class in dev.langchain4j.classification: Represent the result of classification.
ClassificationResult(List<ScoredLabel<L>>) - Constructor for class dev.langchain4j.classification.ClassificationResult
classify(Document) - Method in interface dev.langchain4j.classification.TextClassifier: Classifies the given Document.
classify(TextSegment) - Method in interface dev.langchain4j.classification.TextClassifier: Classifies the given TextSegment.
classify(String) - Method in interface dev.langchain4j.classification.TextClassifier: Classifies the given text.
classifyWithScores(Document) - Method in interface dev.langchain4j.classification.TextClassifier: Classifies the given Document and returns labels with scores.
classifyWithScores(TextSegment) - Method in interface dev.langchain4j.classification.TextClassifier: Classifies the given TextSegment and returns labels with scores.
classifyWithScores(String) - Method in class dev.langchain4j.classification.EmbeddingModelTextClassifier
classifyWithScores(String) - Method in interface dev.langchain4j.classification.TextClassifier: Classifies the given text and returns labels with scores.
classLoader() - Method in class dev.langchain4j.data.document.source.ClassPathSource: The ClassLoader that was used to load this ClassPathSource
ClassMetadataProvider - Class in dev.langchain4j.classloading: Utility class for returning metadata about a class and its methods.
ClassPathDocumentLoader - Class in dev.langchain4j.data.document.loader: DocumentLoader implementation for loading documents using a ClassPathSource
ClassPathSource - Class in dev.langchain4j.data.document.source: Specialization of a DocumentSource that knows how to read from the classpath.
ClassPathSource(URL, ClassLoader) - Constructor for class dev.langchain4j.data.document.source.ClassPathSource
clear() - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
clear() - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
clearAll() - Method in class dev.langchain4j.service.memory.ChatMemoryService
commonGuardrailParams() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters: Retrieves the common parameters shared across guardrail checks for validating interactions between a user and a language model, if available.
commonGuardrailParams(GuardrailRequestParams) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the common guardrail parameters for validating interactions between a user and a language model.
content() - Method in class dev.langchain4j.service.Result
content(T) - Method in class dev.langchain4j.service.Result.ResultBuilder
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
context() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters
context(AiServiceContext) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the AI service context.
ConversationalChain - Class in dev.langchain4j.chain: A chain for conversing with a specified ChatModel while maintaining a memory of the conversation.
ConversationalChain.ConversationalChainBuilder - Class in dev.langchain4j.chain
ConversationalRetrievalChain - Class in dev.langchain4j.chain: A chain for conversing with a specified ChatModel based on the information retrieved by a specified ContentRetriever.
ConversationalRetrievalChain(ChatModel, ChatMemory, ContentRetriever) - Constructor for class dev.langchain4j.chain.ConversationalRetrievalChain
ConversationalRetrievalChain(ChatModel, 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>, ChatModel) - 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>, StreamingChatModel) - 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.
createContext(Object, UserMessage) - Method in class dev.langchain4j.service.tool.ToolService

D

DEFAULT - Static variable in class dev.langchain4j.service.memory.ChatMemoryService
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
DefaultToolExecutor(Object, Method, Method) - Constructor for class dev.langchain4j.service.tool.DefaultToolExecutor: When methods annotated with @Tool are wrapped into proxies (AOP), the parameters of the proxied method do not retain their original names.
delimiter() - Element in annotation interface dev.langchain4j.service.SystemMessage
delimiter() - Element in annotation interface dev.langchain4j.service.UserMessage
dev.langchain4j.chain - package dev.langchain4j.chain
dev.langchain4j.classification - package dev.langchain4j.classification
dev.langchain4j.classloading - package dev.langchain4j.classloading
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.memory.chat - package dev.langchain4j.memory.chat
dev.langchain4j.service - package dev.langchain4j.service
dev.langchain4j.service.guardrail - package dev.langchain4j.service.guardrail
dev.langchain4j.service.guardrail.spi - package dev.langchain4j.service.guardrail.spi
dev.langchain4j.service.memory - package dev.langchain4j.service.memory
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 single TextSegment, adhering to the limit set by maxSegmentSize.
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, TokenCountEstimator) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByCharacterSplitter
DocumentByCharacterSplitter(int, int, TokenCountEstimator, 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 single TextSegment, adhering to the limit set by maxSegmentSize.
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, TokenCountEstimator) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByLineSplitter
DocumentByLineSplitter(int, int, TokenCountEstimator, 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 single TextSegment, adhering to the limit set by maxSegmentSize.
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, TokenCountEstimator) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByParagraphSplitter
DocumentByParagraphSplitter(int, int, TokenCountEstimator, 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 provided regex and attempts to fit as many parts as possible into a single TextSegment, adhering to the limit set by maxSegmentSize.
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, TokenCountEstimator) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByRegexSplitter
DocumentByRegexSplitter(String, String, int, int, TokenCountEstimator, 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 single TextSegment, adhering to the limit set by maxSegmentSize.
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, TokenCountEstimator) - Constructor for class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
DocumentBySentenceSplitter(int, int, TokenCountEstimator, DocumentSplitter) - Constructor for class dev.langchain4j.data.document.splitter.DocumentBySentenceSplitter
DocumentBySentenceSplitter(int, int, TokenCountEstimator, DocumentSplitter, SentenceModel) - 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 single TextSegment, adhering to the limit set by maxSegmentSize.
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, TokenCountEstimator) - Constructor for class dev.langchain4j.data.document.splitter.DocumentByWordSplitter
DocumentByWordSplitter(int, int, TokenCountEstimator, 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<L> - Class in dev.langchain4j.classification: A TextClassifier that uses an EmbeddingModel and predefined examples to perform classification.
EmbeddingModelTextClassifier(EmbeddingModel, Map<L, ? extends Collection<String>>) - Constructor for class dev.langchain4j.classification.EmbeddingModelTextClassifier: Creates a classifier with the default values for EmbeddingModelTextClassifier.maxResults (1), EmbeddingModelTextClassifier.minScore (0) and EmbeddingModelTextClassifier.meanToMaxScoreRatio (0.5).
EmbeddingModelTextClassifier(EmbeddingModel, Map<L, ? extends Collection<String>>, int, double, double) - Constructor for class dev.langchain4j.classification.EmbeddingModelTextClassifier: Creates a classifier.
equals(Object) - Method in class dev.langchain4j.classification.ClassificationResult
equals(Object) - Method in class dev.langchain4j.classification.ScoredLabel
equals(Object) - Method in class dev.langchain4j.service.tool.BeforeToolExecution
equals(Object) - Method in class dev.langchain4j.service.tool.ToolExecution
equals(Object) - Method in class dev.langchain4j.service.tool.ToolServiceContext
equals(Object) - Method in class dev.langchain4j.service.tool.ToolServiceResult
evictChatMemory(Object) - Method in interface dev.langchain4j.service.memory.ChatMemoryAccess: Evicts the ChatMemory with the given id.
evictChatMemory(Object) - Method in class dev.langchain4j.service.memory.ChatMemoryService
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
executeGuardrails(MethodKey, InputGuardrailRequest) - Method in interface dev.langchain4j.service.guardrail.GuardrailService: Executes the input guardrails associated with the given method and parameters, and retrieves a modified or validated UserMessage based on the result.
executeGuardrails(MethodKey, OutputGuardrailRequest) - Method in interface dev.langchain4j.service.guardrail.GuardrailService: Executes the guardrails associated with a given method and parameters, returning the appropriate response.
executeInferenceAndToolsLoop(ChatResponse, ChatRequestParameters, List<ChatMessage>, ChatModel, ChatMemory, Object, Map<String, ToolExecutor>) - Method in class dev.langchain4j.service.tool.ToolService
executeInputGuardrails(MethodKey, InputGuardrailRequest) - Method in class dev.langchain4j.service.guardrail.AbstractGuardrailService
executeInputGuardrails(MethodKey, InputGuardrailRequest) - Method in interface dev.langchain4j.service.guardrail.GuardrailService: Executes the input guardrails associated with a given Method
executeOutputGuardrails(MethodKey, OutputGuardrailRequest) - Method in class dev.langchain4j.service.guardrail.AbstractGuardrailService
executeOutputGuardrails(MethodKey, OutputGuardrailRequest) - Method in interface dev.langchain4j.service.guardrail.GuardrailService: Executes the output guardrails associated with a given Method.

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
finalResponse() - Method in class dev.langchain4j.service.Result: Returns final chat response returned by the ChatModel.
finalResponse() - Method in class dev.langchain4j.service.tool.ToolServiceResult
finalResponse(ChatResponse) - Method in class dev.langchain4j.service.Result.ResultBuilder
finalResponse(ChatResponse) - Method in class dev.langchain4j.service.tool.ToolServiceResult.Builder
findTemplateVariables(String, Method, Object[]) - Static method in class dev.langchain4j.service.InternalReflectionVariableResolver
finishReason() - Method in class dev.langchain4j.service.Result: Returns finish reason of the final ChatModel response (taken from Result.finalResponse()).
finishReason(FinishReason) - Method in class dev.langchain4j.service.Result.ResultBuilder
from(File) - Static method in class dev.langchain4j.data.document.source.FileSystemSource
from(String) - Static method in class dev.langchain4j.data.document.source.ClassPathSource: Creates a new instance of ClassPathSource from the given classpath resource string, using Thread.currentThread().getContextClassLoader() as the class loader.
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(String, ClassLoader) - Static method in class dev.langchain4j.data.document.source.ClassPathSource: Creates a new instance of ClassPathSource from the given classpath resource and classloader.
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) - 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 interface dev.langchain4j.service.SystemMessage: The resource from which to read the prompt template.
fromResource() - Element in annotation interface 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.
getAnnotation(Class<?>, Class<T>) - Method in class dev.langchain4j.classloading.ReflectionBasedClassMetadataProviderFactory
getAnnotation(Method, Class<T>) - Method in class dev.langchain4j.classloading.ReflectionBasedClassMetadataProviderFactory
getBoundedLongValue(Object, String, Class<?>, long, long) - Static method in class dev.langchain4j.service.tool.DefaultToolExecutor
getBuilder(Class<?>) - Method in interface dev.langchain4j.service.guardrail.spi.GuardrailServiceBuilderFactory: Gets an instance of the GuardrailService.Builder
getChatMemories() - Method in class dev.langchain4j.service.memory.ChatMemoryService
getChatMemory(Object) - Method in interface dev.langchain4j.service.memory.ChatMemoryAccess: Returns the ChatMemory with the given id for this AI service or null if such memory doesn't exist.
getChatMemory(Object) - Method in class dev.langchain4j.service.memory.ChatMemoryService
getChatMemoryIDs() - Method in class dev.langchain4j.service.memory.ChatMemoryService
getClassMetadataProviderFactory() - Static method in class dev.langchain4j.classloading.ClassMetadataProvider: Retrieves an implementation of a ClassMetadataProviderFactory.
getNonStaticMethodsOnClass(Class<?>) - Method in class dev.langchain4j.classloading.ReflectionBasedClassMetadataProviderFactory
getOrCreateChatMemory(Object) - Method in class dev.langchain4j.service.memory.ChatMemoryService
getRawClass(Type) - Static method in class dev.langchain4j.service.TypeUtils
gretrievedContents() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters
guardrailService() - Method in class dev.langchain4j.service.AiServiceContext
GuardrailService - Interface in dev.langchain4j.service.guardrail: Defines a service for executing guardrails associated with methods in an AI service.
GuardrailService.Builder - Interface in dev.langchain4j.service.guardrail: Builder class for building GuardrailService instances
guardrailServiceBuilder - Variable in class dev.langchain4j.service.AiServiceContext
GuardrailServiceBuilderFactory - Interface in dev.langchain4j.service.guardrail.spi: A factory for providing instances of GuardrailService.Builder

H

hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage>) - Method in class dev.langchain4j.service.AiServices: Configures the strategy to be used when the LLM hallucinates a tool name (i.e., attempts to call a nonexistent tool).
hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage>) - Method in class dev.langchain4j.service.tool.ToolService
HallucinatedToolNameStrategy - Enum Class in dev.langchain4j.service.tool
hasChatMemory() - Method in class dev.langchain4j.service.AiServiceContext
hashCode() - Method in class dev.langchain4j.classification.ClassificationResult
hashCode() - Method in class dev.langchain4j.classification.ScoredLabel
hashCode() - Method in class dev.langchain4j.service.tool.BeforeToolExecution
hashCode() - Method in class dev.langchain4j.service.tool.ToolExecution
hashCode() - Method in class dev.langchain4j.service.tool.ToolServiceContext
hashCode() - Method in class dev.langchain4j.service.tool.ToolServiceResult
hasInputGuardrails(MethodKey) - Method in class dev.langchain4j.service.guardrail.AbstractGuardrailService
hasInputGuardrails(MethodKey) - Method in interface dev.langchain4j.service.guardrail.GuardrailService: Whether or not a method has any input guardrails associated with it
hasOutputGuardrails(MethodKey) - Method in class dev.langchain4j.service.guardrail.AbstractGuardrailService
hasOutputGuardrails(MethodKey) - Method in interface dev.langchain4j.service.guardrail.GuardrailService: Whether or not a method has any output guardrails associated with it
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, TokenCountEstimator) - Constructor for class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter: Creates a new instance of HierarchicalDocumentSplitter.
HierarchicalDocumentSplitter(int, int, TokenCountEstimator, 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.service.IllegalConfigurationException
illegalConfiguration(String, Object...) - Static method in exception class dev.langchain4j.service.IllegalConfigurationException
IllegalConfigurationException - Exception Class in dev.langchain4j.service
IllegalConfigurationException(String) - Constructor for exception class dev.langchain4j.service.IllegalConfigurationException
initChatMemories(ChatMemoryProvider) - Method in class dev.langchain4j.service.AiServiceContext
initChatMemories(ChatMemory) - Method in class dev.langchain4j.service.AiServiceContext
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
inputGuardrailClasses(Class<? extends I>...) - Method in class dev.langchain4j.service.AiServices: Configures input guardrail classes for the AI service.
inputGuardrailClasses(Class<? extends I>...) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the classes of input guardrails for the Builder.
inputGuardrailClasses(List<Class<? extends I>>) - Method in class dev.langchain4j.service.AiServices: Configures the input guardrail classes for the AI services.
inputGuardrailClasses(List<Class<? extends I>>) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the classes of input guardrails for the Builder.
inputGuardrails(I...) - Method in class dev.langchain4j.service.AiServices: Adds the specified input guardrails to the context's guardrail service builder.
inputGuardrails(I...) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the input guardrails for the Builder.
inputGuardrails(List<I>) - Method in class dev.langchain4j.service.AiServices: Sets the input guardrails to be used by the guardrail service builder in the current context.
inputGuardrails(List<I>) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Sets the input guardrails for the Builder.
InputGuardrails - Annotation Interface in dev.langchain4j.service.guardrail: An annotation to apply input guardrails to the input of the model using the declarative AiServices approach.
inputGuardrailsConfig(InputGuardrailsConfig) - Method in class dev.langchain4j.service.AiServices: Configures the input guardrails for the AI service context by setting the provided InputGuardrailsConfig.
inputGuardrailsConfig(InputGuardrailsConfig) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the input guardrails for the builder.
inputStream() - Method in class dev.langchain4j.data.document.source.ClassPathSource
inputStream() - Method in class dev.langchain4j.data.document.source.FileSystemSource
inputStream() - Method in class dev.langchain4j.data.document.source.UrlSource
intermediateResponses() - Method in class dev.langchain4j.service.Result: Returns all intermediate chat responses that were returned by the ChatModel.
intermediateResponses() - Method in class dev.langchain4j.service.tool.ToolServiceResult
intermediateResponses(List<ChatResponse>) - Method in class dev.langchain4j.service.Result.ResultBuilder
intermediateResponses(List<ChatResponse>) - Method in class dev.langchain4j.service.tool.ToolServiceResult.Builder
InternalReflectionVariableResolver - Class in dev.langchain4j.service: Utility class responsible for resolving variable names and values for prompt templates by leveraging method parameters and their annotations.
isInsideArchive() - Method in class dev.langchain4j.data.document.source.ClassPathSource: Determines if the resource represented by this ClassPathSource is inside an archive.

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.
jsonSchema(Type) - Method in class dev.langchain4j.service.output.ServiceOutputParser
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

label() - Method in class dev.langchain4j.classification.ScoredLabel
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.ClassPathDocumentLoader: Loads a Document from the specified file path.
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.ClassPathDocumentLoader: 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(String, DocumentParser, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads a Document from the specified file path using a given class loader.
loadDocument(String, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads a Document from the specified file path using a given class loader.
loadDocument(Path) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads a Document from the specified file Path.
loadDocument(Path, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads a Document from the specified file Path.
loadDocuments(String) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads Documents from the specified directory using a given class loader.
loadDocuments(String) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads Documents from the specified directory.
loadDocuments(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads Documents from the specified directory.
loadDocuments(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads Documents from the specified directory.
loadDocuments(String, DocumentParser, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads Documents from the specified directory using a given class loader.
loadDocuments(String, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads Documents from the specified directory.
loadDocuments(String, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads matching Documents from the specified directory.
loadDocuments(String, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads matching Documents from the specified directory.
loadDocuments(String, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads matching Documents from the specified directory.
loadDocuments(String, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads matching Documents from the specified directory.
loadDocuments(String, PathMatcher, DocumentParser, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads matching Documents from the specified directory using a given class loader.
loadDocuments(String, PathMatcher, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Loads matching Documents from the specified directory using a given class loader.
loadDocuments(Path) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads Documents from the specified directory.
loadDocuments(Path, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads Documents from the specified directory.
loadDocuments(Path, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads matching Documents from the specified directory.
loadDocuments(Path, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Loads matching Documents from the specified directory.
loadDocumentsRecursively(String) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String, DocumentParser, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories using a given class loader.
loadDocumentsRecursively(String, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories using a specified classloader.
loadDocumentsRecursively(String, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads matching Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads matching Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads matching Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads matching Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(String, PathMatcher, DocumentParser, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads matching Documents from the specified directory and its subdirectories using a given class loader.
loadDocumentsRecursively(String, PathMatcher, ClassLoader) - Static method in class dev.langchain4j.data.document.loader.ClassPathDocumentLoader: Recursively loads matching Documents from the specified directory and its subdirectories using a given class loader.
loadDocumentsRecursively(Path) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(Path, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(Path, PathMatcher) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads matching Documents from the specified directory and its subdirectories.
loadDocumentsRecursively(Path, PathMatcher, DocumentParser) - Static method in class dev.langchain4j.data.document.loader.FileSystemDocumentLoader: Recursively loads matching Documents 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
maxRetries() - Element in annotation interface dev.langchain4j.service.guardrail.OutputGuardrails: The maximum number of retries to perform when an output guardrail forces a retry or reprompt.
maxSegmentSize - Variable in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
maxSequentialToolsInvocations(int) - Method in class dev.langchain4j.service.AiServices
maxSequentialToolsInvocations(int) - Method in class dev.langchain4j.service.tool.ToolService
maxTokens(Integer, TokenCountEstimator) - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory.Builder
memoryId() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters
memoryId(Object) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the memory ID.
MemoryId - Annotation Interface 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 InMemoryEmbeddingStores into a single InMemoryEmbeddingStore, copying all entries from each store.
merge(Collection<InMemoryEmbeddingStore<Embedded>>) - Static method in class dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore: Merges given InMemoryEmbeddingStores into a single InMemoryEmbeddingStore, copying all entries from each store.
messages() - Method in class dev.langchain4j.memory.chat.MessageWindowChatMemory
messages() - Method in class dev.langchain4j.memory.chat.TokenWindowChatMemory
messages() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters
messages(List<ChatMessage>) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the messages.
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.ClassPathSource
metadata() - Method in class dev.langchain4j.data.document.source.FileSystemSource
metadata() - Method in class dev.langchain4j.data.document.source.UrlSource
methodKey() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters: Retrieves the method key associated with this instance.
methodKey(Object) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the method key.
Moderate - Annotation Interface 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.
moderation() - Method in exception class dev.langchain4j.service.ModerationException
ModerationException - Exception Class in dev.langchain4j.service: Thrown when content moderation fails, i.e., when content is flagged by the moderation model.
ModerationException(String, Moderation) - 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

onCompleteResponse(Consumer<ChatResponse>) - Method in class dev.langchain4j.service.AiServiceTokenStream
onCompleteResponse(Consumer<ChatResponse>) - Method in interface dev.langchain4j.service.TokenStream: The provided consumer will be invoked when a language model finishes streaming the final chat response, as opposed to the intermediate response (see TokenStream.onIntermediateResponse(Consumer)).
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.
onIntermediateResponse(Consumer<ChatResponse>) - Method in class dev.langchain4j.service.AiServiceTokenStream
onIntermediateResponse(Consumer<ChatResponse>) - Method in interface dev.langchain4j.service.TokenStream: The provided consumer will be invoked when a language model finishes streaming the intermediate chat response, as opposed to the final response (see TokenStream.onCompleteResponse(Consumer)).
onPartialResponse(Consumer<String>) - Method in class dev.langchain4j.service.AiServiceTokenStream
onPartialResponse(Consumer<String>) - Method in interface dev.langchain4j.service.TokenStream: The provided consumer will be invoked every time a new partial textual response (usually a single token) from a language model is available.
onPartialThinking(Consumer<PartialThinking>) - Method in class dev.langchain4j.service.AiServiceTokenStream
onPartialThinking(Consumer<PartialThinking>) - Method in interface dev.langchain4j.service.TokenStream: The provided consumer will be invoked every time a new partial thinking/reasoning text (usually a single 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 if any Contents are retrieved using RetrievalAugmentor.
onToolExecuted(Consumer<ToolExecution>) - Method in class dev.langchain4j.service.AiServiceTokenStream
onToolExecuted(Consumer<ToolExecution>) - Method in interface dev.langchain4j.service.TokenStream: The provided consumer will be invoked right after a tool is executed.
outputFormatInstructions(Type) - Method in class dev.langchain4j.service.output.ServiceOutputParser
outputGuardrailClasses(Class<? extends O>...) - Method in class dev.langchain4j.service.AiServices: Sets the output guardrail classes to be used in the guardrail service.
outputGuardrailClasses(Class<? extends O>...) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the classes of output guardrails for the Builder.
outputGuardrailClasses(List<Class<? extends O>>) - Method in class dev.langchain4j.service.AiServices: Configures the output guardrail classes for the AI services.
outputGuardrailClasses(List<Class<? extends O>>) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the classes of output guardrails for the Builder.
outputGuardrails(List<O>) - Method in class dev.langchain4j.service.AiServices: Configures the output guardrails for the AI service.
outputGuardrails(List<O>) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Sets the output guardrails for the Builder.
outputGuardrails(O...) - Method in class dev.langchain4j.service.AiServices: Configures output guardrails for the AI services.
outputGuardrails(O...) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the output guardrails for the Builder.
OutputGuardrails - Annotation Interface in dev.langchain4j.service.guardrail: An annotation to apply guardrails to the output of the model using the declarative AiServices approach.
outputGuardrailsConfig(OutputGuardrailsConfig) - Method in class dev.langchain4j.service.AiServices: Configures the output guardrails for AI services.
outputGuardrailsConfig(OutputGuardrailsConfig) - Method in interface dev.langchain4j.service.guardrail.GuardrailService.Builder: Configures the output guardrails for the Builder.
OutputParsingException - Exception Class in dev.langchain4j.service.output
OutputParsingException(String, Throwable) - Constructor for exception class dev.langchain4j.service.output.OutputParsingException

P

parse(ChatResponse, Type) - Method in class dev.langchain4j.service.output.ServiceOutputParser
parse(InputStream) - Method in class dev.langchain4j.data.document.parser.TextDocumentParser
performBasicValidation() - Method in class dev.langchain4j.service.AiServices
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, TokenCountEstimator) - Static method in class dev.langchain4j.data.document.splitter.DocumentSplitters: This is a recommended DocumentSplitter for generic text.
ReflectionBasedClassMetadataProviderFactory - Class in dev.langchain4j.classloading: Implementation of the ClassMetadataProviderFactory interface using Java Reflection.
ReflectionBasedClassMetadataProviderFactory() - Constructor for class dev.langchain4j.classloading.ReflectionBasedClassMetadataProviderFactory
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.BeforeToolExecution: Returns the tool execution request that is about to be executed.
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.BeforeToolExecution.Builder
request(ToolExecutionRequest) - Method in class dev.langchain4j.service.tool.ToolExecution.Builder
resolveFirstGenericParameterClass(Type) - Static method in class dev.langchain4j.service.TypeUtils
resolveFirstGenericParameterType(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(Result.ResultBuilder<T>) - Constructor for class dev.langchain4j.service.Result
Result(T, TokenUsage, List<Content>, FinishReason, List<ToolExecution>) - Constructor for class dev.langchain4j.service.Result
Result.ResultBuilder<T> - Class in dev.langchain4j.service
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.
retrievedContents(List<Content>) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the retrieved contents.

S

score() - Method in class dev.langchain4j.classification.ScoredLabel
ScoredLabel<L> - Class in dev.langchain4j.classification: Represents a classification label with score.
ScoredLabel(L, double) - Constructor for class dev.langchain4j.classification.ScoredLabel
scoredLabels() - Method in class dev.langchain4j.classification.ClassificationResult
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: Returns all sources returned during RAG retrieval.
sources(List<Content>) - Method in class dev.langchain4j.service.Result.ResultBuilder
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.
streamingChatModel - Variable in class dev.langchain4j.service.AiServiceContext
streamingChatModel(StreamingChatModel) - Method in class dev.langchain4j.service.AiServices: Configures streaming chat model that will be used under the hood of the AI Service.
subSplitter - Variable in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
SystemMessage - Annotation Interface 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<L> - Interface in dev.langchain4j.classification: Classifies a given text based on a set of labels.
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
THROW_EXCEPTION - Enum constant in enum class dev.langchain4j.service.tool.HallucinatedToolNameStrategy
toJson(InMemoryEmbeddingStore<?>) - Method in interface dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStoreJsonCodec
tokenCountEstimator - Variable in class dev.langchain4j.data.document.splitter.HierarchicalDocumentSplitter
TokenStream - Interface in dev.langchain4j.service: Represents a token stream from the model to which you can subscribe and receive updates when a new partial response (usually a single token) is available, when the 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: Returns aggregate token usage over all calls to the ChatModel.
tokenUsage(TokenUsage) - Method in class dev.langchain4j.service.Result.ResultBuilder
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: Returns all tool executions that happened during AI Service invocation.
toolExecutions() - Method in class dev.langchain4j.service.tool.ToolServiceResult
toolExecutions(List<ToolExecution>) - Method in class dev.langchain4j.service.Result.ResultBuilder
toolExecutions(List<ToolExecution>) - Method in class dev.langchain4j.service.tool.ToolServiceResult.Builder
ToolExecutor - Interface in dev.langchain4j.service.tool: A low-level executor/handler of a ToolExecutionRequest.
toolExecutorByName(String) - Method in class dev.langchain4j.service.tool.ToolProviderResult
toolExecutors() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters
toolExecutors() - Method in class dev.langchain4j.service.tool.ToolService
toolExecutors() - Method in class dev.langchain4j.service.tool.ToolServiceContext
toolExecutors(Map<String, ToolExecutor>) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the tool executors.
toolProvider() - Method in class dev.langchain4j.service.tool.ToolService
toolProvider(ToolProvider) - Method in class dev.langchain4j.service.AiServices: Configures the tool provider that the LLM can use
toolProvider(ToolProvider) - Method in class dev.langchain4j.service.tool.ToolService
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(Collection<Object>) - Method in class dev.langchain4j.service.AiServices: Configures the tools that the LLM can use.
tools(Collection<Object>) - Method in class dev.langchain4j.service.tool.ToolService
tools(Map<ToolSpecification, ToolExecutor>) - 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.tool.ToolService
toolService - Variable in class dev.langchain4j.service.AiServiceContext
ToolService - Class in dev.langchain4j.service.tool
ToolService() - Constructor for class dev.langchain4j.service.tool.ToolService
ToolServiceContext - Class in dev.langchain4j.service.tool
ToolServiceContext(List<ToolSpecification>, Map<String, ToolExecutor>) - Constructor for class dev.langchain4j.service.tool.ToolServiceContext
ToolServiceResult - Class in dev.langchain4j.service.tool
ToolServiceResult(ChatResponse, List<ToolExecution>) - Constructor for class dev.langchain4j.service.tool.ToolServiceResult: Deprecated.
Please use ToolServiceResult(Builder) instead
ToolServiceResult(ToolServiceResult.Builder) - Constructor for class dev.langchain4j.service.tool.ToolServiceResult
ToolServiceResult.Builder - Class in dev.langchain4j.service.tool
toolSpecificationByName(String) - Method in class dev.langchain4j.service.tool.ToolProviderResult
toolSpecifications() - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters
toolSpecifications() - Method in class dev.langchain4j.service.tool.ToolService
toolSpecifications() - Method in class dev.langchain4j.service.tool.ToolServiceContext
toolSpecifications(List<ToolSpecification>) - Method in class dev.langchain4j.service.AiServiceTokenStreamParameters.Builder: Sets the tool specifications.
toString() - Method in class dev.langchain4j.classification.ClassificationResult
toString() - Method in class dev.langchain4j.classification.ScoredLabel
toString() - Method in class dev.langchain4j.data.document.source.FileSystemSource
toString() - Method in class dev.langchain4j.service.tool.BeforeToolExecution
toString() - Method in class dev.langchain4j.service.tool.ToolExecution
toString() - Method in class dev.langchain4j.service.tool.ToolServiceContext
toString() - Method in class dev.langchain4j.service.tool.ToolServiceResult
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

url() - Method in class dev.langchain4j.data.document.source.ClassPathSource: Retrieves the URL associated with this ClassPathSource.
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 Interface 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 Interface 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 Interface 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 interface dev.langchain4j.service.guardrail.InputGuardrails: The ordered list of InputGuardrails to apply to the input of the model.
value() - Element in annotation interface dev.langchain4j.service.guardrail.OutputGuardrails: The ordered list of guardrails to apply to the output of the model.
value() - Element in annotation interface dev.langchain4j.service.SystemMessage: Prompt template can be defined in one line or multiple lines.
value() - Element in annotation interface dev.langchain4j.service.UserMessage: Prompt template can be defined in one line or multiple lines.
value() - Element in annotation interface dev.langchain4j.service.V: Name of a variable (placeholder) in a prompt template.
valueOf(String) - Static method in enum class dev.langchain4j.service.tool.HallucinatedToolNameStrategy: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.langchain4j.service.tool.HallucinatedToolNameStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
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, TokenCountEstimator) - Static method in class dev.langchain4j.memory.chat.TokenWindowChatMemory

A B C D E F G H I J L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form