Uses of Annotation Interface
dev.langchain4j.Experimental

Packages that use Experimental

Package	Description
dev.langchain4j.agent.tool
dev.langchain4j.data.message
dev.langchain4j.experimental.rag.content.retriever.sql
dev.langchain4j.http.client
dev.langchain4j.http.client.sse
dev.langchain4j.micrometer.metrics.listeners
dev.langchain4j.model.anthropic
dev.langchain4j.model.audio
dev.langchain4j.model.azure
dev.langchain4j.model.batch
dev.langchain4j.model.catalog	Contains interfaces and classes for model catalog functionality.
dev.langchain4j.model.chat
dev.langchain4j.model.chat.response
dev.langchain4j.model.embedding
dev.langchain4j.model.embedding.listener
dev.langchain4j.model.google.genai
dev.langchain4j.model.googleai
dev.langchain4j.model.image
dev.langchain4j.model.ollama
dev.langchain4j.model.openai
dev.langchain4j.model.openaiofficial
dev.langchain4j.observability.api.event
dev.langchain4j.observability.event
dev.langchain4j.observation.listener
dev.langchain4j.rag.content.retriever
dev.langchain4j.rag.content.retriever.hibernate
dev.langchain4j.rag.content.retriever.listener
dev.langchain4j.service
dev.langchain4j.service.tool
dev.langchain4j.service.tool.search
dev.langchain4j.service.tool.search.simple
dev.langchain4j.service.tool.search.vector
dev.langchain4j.skills
dev.langchain4j.skills.shell
dev.langchain4j.store.embedding
dev.langchain4j.store.embedding.filter.builder.sql
dev.langchain4j.store.embedding.filter.parser.sql
dev.langchain4j.store.embedding.listener

Packages with annotations of type Experimental

Package	Description
dev.langchain4j.observability.api
dev.langchain4j.observability.api.event
dev.langchain4j.observability.event
dev.langchain4j.guardrail
dev.langchain4j.service.guardrail
dev.langchain4j.observability.api.listener

Uses of Experimental in dev.langchain4j.agent.tool

Classes in dev.langchain4j.agent.tool with annotations of type Experimental

Modifier and Type	Class	Description
enum	ReturnBehavior	Per-tool setting controlling what happens with a tool's result after execution.
enum	SearchBehavior	Defines the behavior of a tool when dev.langchain4j.service.tool.search.ToolSearchStrategy is configured for an AI Service.

Uses of Experimental in dev.langchain4j.data.message

Methods in dev.langchain4j.data.message with annotations of type Experimental

Modifier and Type	Method	Description
<T> T	AiMessage.attribute(String key, Class<T> type)	Returns additional attribute by it's key.
<T> T	UserMessage.attribute(String key, Class<T> type)	Returns additional attribute by it's key.
Map<String,Object>	AiMessage.attributes()	Returns additional attributes, typically provider-specific.
AiMessage.Builder	AiMessage.Builder.attributes(Map<String,Object> attributes)
Map<String,Object>	UserMessage.attributes()	Returns additional attributes.
ToolExecutionResultMessage.Builder	ToolExecutionResultMessage.Builder.contents(Content... contents)	Sets the contents of the tool execution result.
ToolExecutionResultMessage.Builder	ToolExecutionResultMessage.Builder.contents(List<Content> contents)	Sets the contents of the tool execution result.
List<Content>	ToolExecutionResultMessage.contents()	Returns the Contents of the tool execution result.
boolean	ToolExecutionResultMessage.hasSingleText()	Whether this message contains a single TextContent.
AiMessage.Builder	AiMessage.Builder.thinking(String thinking)
String	AiMessage.thinking()	Get the thinking/reasoning text of the message.

Uses of Experimental in dev.langchain4j.experimental.rag.content.retriever.sql

Classes in dev.langchain4j.experimental.rag.content.retriever.sql with annotations of type Experimental

Modifier and Type	Class	Description
class	SqlDatabaseContentRetriever	WARNING!

Constructors in dev.langchain4j.experimental.rag.content.retriever.sql with annotations of type Experimental

Modifier	Constructor	Description
	SqlDatabaseContentRetriever(DataSource dataSource, String sqlDialect, String databaseStructure, PromptTemplate promptTemplate, ChatModel chatModel, Integer maxRetries)	Creates an instance of a SqlDatabaseContentRetriever.

Uses of Experimental in dev.langchain4j.http.client

Classes in dev.langchain4j.http.client with annotations of type Experimental

Modifier and Type	Class	Description
class	FormDataFile

Methods in dev.langchain4j.http.client with annotations of type Experimental

Modifier and Type	Method	Description
HttpRequest.Builder	HttpRequest.Builder.addFormDataField(String name, String value)
HttpRequest.Builder	HttpRequest.Builder.addFormDataFile(String name, String fileName, String contentType, byte[] content)
HttpRequest.Builder	HttpRequest.Builder.formDataFields(Map<String,String> formDataFields)
Map<String,String>	HttpRequest.formDataFields()
HttpRequest.Builder	HttpRequest.Builder.formDataFiles(Map<String, FormDataFile> formDataFiles)
Map<String, FormDataFile>	HttpRequest.formDataFiles()

Uses of Experimental in dev.langchain4j.http.client.sse

Classes in dev.langchain4j.http.client.sse with annotations of type Experimental

Modifier and Type	Class	Description
class	ServerSentEventContext
interface	ServerSentEventParsingHandle	Handle that can be used to cancel the parsing of server-sent events.

Methods in dev.langchain4j.http.client.sse with annotations of type Experimental

Modifier and Type	Method	Description
default void	ServerSentEventListener.onEvent(ServerSentEvent event, ServerSentEventContext context)	Handles server-sent event.

Uses of Experimental in dev.langchain4j.micrometer.metrics.listeners

Classes in dev.langchain4j.micrometer.metrics.listeners with annotations of type Experimental

Modifier and Type	Class	Description
class	MicrometerMetricsChatModelListener	A ChatModelListener that uses a Micrometer MeterRegistry to collect metrics about chat model interactions following OpenTelemetry Semantic Conventions for Generative AI.

Uses of Experimental in dev.langchain4j.model.anthropic

Classes in dev.langchain4j.model.anthropic with annotations of type Experimental

Modifier and Type	Class	Description
class	AnthropicServerTool
class	AnthropicServerToolResult	Represents a result from an Anthropic server-executed tool (e.g., web_search, code_execution).
class	AnthropicTokenCountEstimator

Uses of Experimental in dev.langchain4j.model.audio

Classes in dev.langchain4j.model.audio with annotations of type Experimental

Modifier and Type	Interface	Description
interface	AudioTranscriptionModel	A model that can transcribe audio into text.
class	AudioTranscriptionRequest	Request to transcribe audio.
class	AudioTranscriptionResponse	Response containing the transcription of an audio file.

Uses of Experimental in dev.langchain4j.model.azure

Classes in dev.langchain4j.model.azure with annotations of type Experimental

Modifier and Type	Class	Description
class	AzureOpenAiAudioTranscriptionModel	Represents an Azure OpenAI audio transcription model, such as Whisper.

Uses of Experimental in dev.langchain4j.model.batch

Classes in dev.langchain4j.model.batch with annotations of type Experimental

Modifier and Type	Class	Description
final class	BatchError	Represents an error status for a failed request within a batch operation.
interface	BatchItemResult<T>	Represents the outcome of a single request within a batch operation.
class	BatchPage<T>	Represents a set of batch jobs that is potentially paginated.
final class	BatchPagination
class	BatchRequest<T>	Represents a batch of requests to be processed together.
class	BatchResponse<T>	Represents the responses of a batch operation.
enum	BatchState	Represents the possible states of a batch job.

Uses of Experimental in dev.langchain4j.model.catalog

Classes in dev.langchain4j.model.catalog with annotations of type Experimental

Modifier and Type	Interface	Description
interface	ModelCatalog	Represents a service that can discover available models from an LLM provider.
class	ModelDescription	Represents metadata about an available model from a provider.
enum	ModelType	Represents the type/category of a model.

Uses of Experimental in dev.langchain4j.model.chat

Classes in dev.langchain4j.model.chat with annotations of type Experimental

Modifier and Type	Interface	Description
interface	BatchChatModel	A model interface for processing multiple chat requests asynchronously in a batch.

Uses of Experimental in dev.langchain4j.model.chat.response

Classes in dev.langchain4j.model.chat.response with annotations of type Experimental

Modifier and Type	Class	Description
class	CompleteToolCall	Represents a complete tool call.
class	PartialResponse
class	PartialResponseContext
class	PartialThinking
class	PartialThinkingContext
class	PartialToolCall	Represents a partial tool call.
class	PartialToolCallContext
interface	StreamingHandle	Handle that can be used to cancel the streaming done via StreamingChatResponseHandler.

Methods in dev.langchain4j.model.chat.response with annotations of type Experimental

Modifier and Type	Method	Description
default void	StreamingChatResponseHandler.onCompleteToolCall(CompleteToolCall completeToolCall)	Invoked when the model has finished streaming a single tool call.
default void	StreamingChatResponseHandler.onPartialResponse(PartialResponse partialResponse, PartialResponseContext context)	Invoked each time the model generates a partial textual response, usually a single token.
default void	StreamingChatResponseHandler.onPartialThinking(PartialThinking partialThinking)	Invoked each time the model generates a partial thinking/reasoning text, usually a single token.
default void	StreamingChatResponseHandler.onPartialThinking(PartialThinking partialThinking, PartialThinkingContext context)	Invoked each time the model generates a partial thinking/reasoning text, usually a single token.
default void	StreamingChatResponseHandler.onPartialToolCall(PartialToolCall partialToolCall)	This callback is invoked each time the model generates a partial tool call, which contains a single token of the tool's arguments.
default void	StreamingChatResponseHandler.onPartialToolCall(PartialToolCall partialToolCall, PartialToolCallContext context)	This callback is invoked each time the model generates a partial tool call, which contains a single token of the tool's arguments.

Uses of Experimental in dev.langchain4j.model.embedding

Classes in dev.langchain4j.model.embedding with annotations of type Experimental

Modifier and Type	Interface	Description
interface	BatchEmbeddingModel	Used for processing multiple embedding requests asynchronously in a batch.

Methods in dev.langchain4j.model.embedding with annotations of type Experimental

Modifier and Type	Method	Description
default EmbeddingModel	EmbeddingModel.addListener(EmbeddingModelListener listener)	Wraps this EmbeddingModel with a listening model that dispatches events to the provided listener.
default EmbeddingModel	EmbeddingModel.addListeners(List<EmbeddingModelListener> listeners)	Wraps this EmbeddingModel with a listening model that dispatches events to the provided listeners.

Uses of Experimental in dev.langchain4j.model.embedding.listener

Classes in dev.langchain4j.model.embedding.listener with annotations of type Experimental

Modifier and Type	Class	Description
class	EmbeddingModelErrorContext	The embedding model error context.
static class	EmbeddingModelErrorContext.Builder	Builder for EmbeddingModelErrorContext.
interface	EmbeddingModelListener	An EmbeddingModel listener that listens for requests, responses and errors.
class	EmbeddingModelRequestContext	The embedding model request context.
static class	EmbeddingModelRequestContext.Builder	Builder for EmbeddingModelRequestContext.
class	EmbeddingModelResponseContext	The embedding model response context.
static class	EmbeddingModelResponseContext.Builder	Builder for EmbeddingModelResponseContext.

Uses of Experimental in dev.langchain4j.model.google.genai

Classes in dev.langchain4j.model.google.genai with annotations of type Experimental

Modifier and Type	Class	Description
final class	GoogleGenAiBatchChatModel	Provides an interface for interacting with the Google GenAI Batch API for Chat models.
final class	GoogleGenAiBatchEmbeddingModel	Provides an interface for interacting with the Google GenAI Batch API for Embedding models.
final class	GoogleGenAiBatchImageModel	Provides an interface for interacting with the Google GenAI Batch API for Image generation models.
class	GoogleGenAiChatModel
class	GoogleGenAiEmbeddingModel
class	GoogleGenAiImageModel	Represents a Google GenAI model for image generation and editing using the official com.google.genai SDK.
class	GoogleGenAiStreamingChatModel

Uses of Experimental in dev.langchain4j.model.googleai

Classes in dev.langchain4j.model.googleai with annotations of type Experimental

Modifier and Type	Class	Description
final class	GoogleAiGeminiBatchChatModel	Provides an interface for interacting with the Gemini Batch API, an asynchronous service designed for processing large volumes of requests at a reduced cost (50% of standard).
final class	GoogleAiGeminiBatchEmbeddingModel	Batch embedding model for Google AI Gemini.
final class	GoogleAiGeminiBatchImageModel	Provides an interface for batch image generation using the Gemini Batch API.
class	GoogleAiGeminiImageModel	Represents a Google AI Gemini model for image generation and editing.

Uses of Experimental in dev.langchain4j.model.image

Classes in dev.langchain4j.model.image with annotations of type Experimental

Modifier and Type	Interface	Description
interface	BatchImageModel	A model interface for processing multiple image generation requests asynchronously in a batch.

Uses of Experimental in dev.langchain4j.model.ollama

Classes in dev.langchain4j.model.ollama with annotations of type Experimental

Modifier and Type	Class	Description
class	OllamaImageModel	Experimental Ollama image generation model.

Uses of Experimental in dev.langchain4j.model.openai

Classes in dev.langchain4j.model.openai with annotations of type Experimental

Modifier and Type	Class	Description
class	OpenAiAudioTranscriptionModel	Represents an OpenAI audio model with a transcription interface, only gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1 (which is powered by our open source Whisper V2 model), and gpt-4o-transcribe-diarize are supported.
enum	OpenAiAudioTranscriptionModelName
class	OpenAiResponsesChatModel
class	OpenAiResponsesStreamingChatModel

Uses of Experimental in dev.langchain4j.model.openaiofficial

Classes in dev.langchain4j.model.openaiofficial with annotations of type Experimental

Modifier and Type	Class	Description
class	OpenAiOfficialChatRequestParameters
class	OpenAiOfficialChatResponseMetadata
class	OpenAiOfficialResponsesChatModel	ChatModel implementation using the official OpenAI Java client for the Responses API.
class	OpenAiOfficialResponsesChatRequestParameters
class	OpenAiOfficialResponsesChatResponseMetadata
class	OpenAiOfficialResponsesStreamingChatModel	StreamingChatModel implementation using the official OpenAI Java client for the Responses API.

Uses of Experimental in dev.langchain4j.observability.api.event

Methods in dev.langchain4j.observability.api.event with annotations of type Experimental

Modifier and Type	Method	Description
List<Content>	ToolExecutedEvent.resultContents()	Returns the contents of the tool execution result.
ToolExecutedEvent.ToolExecutedEventBuilder	ToolExecutedEvent.ToolExecutedEventBuilder.resultContents(List<Content> resultContents)	Sets the tool execution result contents.

Uses of Experimental in dev.langchain4j.observability.event

Methods in dev.langchain4j.observability.event with annotations of type Experimental

Modifier and Type	Method	Description
List<Content>	DefaultToolExecutedEvent.resultContents()

Uses of Experimental in dev.langchain4j.observation.listener

Classes in dev.langchain4j.observation.listener with annotations of type Experimental

Modifier and Type	Class	Description
class	ObservationChatModelListener	Will use observations and micrometer metrics to generate telemetry based on the ChatModelListener lifecycle.

Uses of Experimental in dev.langchain4j.rag.content.retriever

Methods in dev.langchain4j.rag.content.retriever with annotations of type Experimental

Modifier and Type	Method	Description
default ContentRetriever	ContentRetriever.addListener(ContentRetrieverListener listener)	Wraps this ContentRetriever with a listening retriever that dispatches events to the provided listener.
default ContentRetriever	ContentRetriever.addListeners(Collection<ContentRetrieverListener> listeners)	Wraps this ContentRetriever with a listening retriever that dispatches events to the provided listeners.

Uses of Experimental in dev.langchain4j.rag.content.retriever.hibernate

Classes in dev.langchain4j.rag.content.retriever.hibernate with annotations of type Experimental

Modifier and Type	Class	Description
class	HibernateContentRetriever	Using the SessionFactory and the ChatModel, this ContentRetriever attempts to generate and execute Hibernate queries for given natural language queries.

Constructors in dev.langchain4j.rag.content.retriever.hibernate with annotations of type Experimental

Modifier	Constructor	Description
	HibernateContentRetriever(org.hibernate.SessionFactory sessionFactory, ChatModel chatModel, String databaseStructure, PromptTemplate promptTemplate, Integer maxRetries)	Creates an instance of a HibernateContentRetriever.

Uses of Experimental in dev.langchain4j.rag.content.retriever.listener

Classes in dev.langchain4j.rag.content.retriever.listener with annotations of type Experimental

Modifier and Type	Class	Description
class	ContentRetrieverErrorContext	The content retriever error context.
static class	ContentRetrieverErrorContext.Builder	Builder for ContentRetrieverErrorContext.
interface	ContentRetrieverListener	A ContentRetriever listener that listens for requests, responses and errors.
class	ContentRetrieverRequestContext	The content retriever request context.
static class	ContentRetrieverRequestContext.Builder	Builder for ContentRetrieverRequestContext.
class	ContentRetrieverResponseContext	The content retriever response context.
static class	ContentRetrieverResponseContext.Builder	Builder for ContentRetrieverResponseContext.

Uses of Experimental in dev.langchain4j.service

Methods in dev.langchain4j.service with annotations of type Experimental

Modifier and Type	Method	Description
default TokenStream	TokenStream.onPartialResponseWithContext(BiConsumer<PartialResponse, PartialResponseContext> handler)	The provided consumer will be invoked every time a new partial textual response (usually a single token) from a language model is available.
default TokenStream	TokenStream.onPartialThinking(Consumer<PartialThinking> partialThinkingHandler)	The provided consumer will be invoked every time a new partial thinking/reasoning text (usually a single token) from a language model is available.
default TokenStream	TokenStream.onPartialThinkingWithContext(BiConsumer<PartialThinking, PartialThinkingContext> handler)	The provided consumer will be invoked every time a new partial thinking/reasoning text (usually a single token) from a language model is available.
default TokenStream	TokenStream.onPartialToolCall(Consumer<PartialToolCall> partialToolCallHandler)	The provided consumer will be invoked every time a new partial tool call (usually containing a single token of the tool's arguments) from a language model is available.
default TokenStream	TokenStream.onPartialToolCallWithContext(BiConsumer<PartialToolCall, PartialToolCallContext> handler)	The provided consumer will be invoked every time a new partial tool call (usually containing a single token of the tool's arguments) from a language model is available.

Uses of Experimental in dev.langchain4j.service.tool

Classes in dev.langchain4j.service.tool with annotations of type Experimental

Modifier and Type	Class	Description
class	BeforeToolExecution

Methods in dev.langchain4j.service.tool with annotations of type Experimental

Modifier and Type	Method	Description
List<Content>	ToolExecution.resultContents()	Returns the contents of the tool execution result.
ToolExecutionResult.Builder	ToolExecutionResult.Builder.resultContents(List<Content> resultContents)	Sets the contents of the tool execution result.
List<Content>	ToolExecutionResult.resultContents()	Returns the contents of the tool execution result that will be sent to the LLM.

Uses of Experimental in dev.langchain4j.service.tool.search

Classes in dev.langchain4j.service.tool.search with annotations of type Experimental

Modifier and Type	Class	Description
class	ToolSearchRequest	A request to search for tools.
class	ToolSearchResult	The result of a tool search.
interface	ToolSearchStrategy	Strategy for discovering tools dynamically by an LLM during an AI Service invocation.

Uses of Experimental in dev.langchain4j.service.tool.search.simple

Classes in dev.langchain4j.service.tool.search.simple with annotations of type Experimental

Modifier and Type	Class	Description
class	SimpleToolSearchStrategy	A ToolSearchStrategy that allows an LLM to search for available tools using simple case-insensitive contains matching.

Uses of Experimental in dev.langchain4j.service.tool.search.vector

Classes in dev.langchain4j.service.tool.search.vector with annotations of type Experimental

Modifier and Type	Class	Description
class	VectorToolSearchStrategy	A ToolSearchStrategy that uses vector similarity search to find relevant tools based on the semantic meaning of their names and descriptions.

Uses of Experimental in dev.langchain4j.skills

Classes in dev.langchain4j.skills with annotations of type Experimental

Modifier and Type	Class	Description
class	AbstractSkill
class	ActivateSkillToolConfig
class	ClassPathSkillLoader	Loads skills from the classpath (including cases when they are packaged inside a JAR file that is on the classpath).
class	DefaultFileSystemSkill
class	DefaultSkill
class	DefaultSkillResource
interface	FileSystemSkill	A Skill backed by the file system.
class	FileSystemSkillLoader	Loads skills from the file system.
class	ReadResourceToolConfig
interface	Skill	Represents a skill that can be used by an LLM.
interface	SkillResource	An additional resource associated with a Skill, such as a reference file, asset, or template that the LLM can read on demand.
class	Skills	Configures and exposes a set of Skills to an LLM.

Uses of Experimental in dev.langchain4j.skills.shell

Classes in dev.langchain4j.skills.shell with annotations of type Experimental

Modifier and Type	Class	Description
class	RunShellCommandToolConfig
class	ShellSkills	Configures and exposes a set of FileSystemSkills to an LLM using shell commands.

Uses of Experimental in dev.langchain4j.store.embedding

Methods in dev.langchain4j.store.embedding with annotations of type Experimental

Modifier and Type	Method	Description
default EmbeddingStore<Embedded>	EmbeddingStore.addListener(EmbeddingStoreListener listener)	Wraps this EmbeddingStore with a listening store that dispatches events to the provided listener.
default EmbeddingStore<Embedded>	EmbeddingStore.addListeners(List<EmbeddingStoreListener> listeners)	Wraps this EmbeddingStore with a listening store that dispatches events to the provided listeners.

Uses of Experimental in dev.langchain4j.store.embedding.filter.builder.sql

Classes in dev.langchain4j.store.embedding.filter.builder.sql with annotations of type Experimental

Modifier and Type	Class	Description
class	ColumnDefinition
class	LanguageModelSqlFilterBuilder	Given a natural language Query, this class creates a suitable Filter using a language model.
class	TableDefinition

Uses of Experimental in dev.langchain4j.store.embedding.filter.parser.sql

Classes in dev.langchain4j.store.embedding.filter.parser.sql with annotations of type Experimental

Modifier and Type	Class	Description
class	SqlFilterParser	Parses an SQL "WHERE" clause into a Filter object using JSqlParser.

Uses of Experimental in dev.langchain4j.store.embedding.listener

Classes in dev.langchain4j.store.embedding.listener with annotations of type Experimental

Modifier and Type	Class	Description
class	EmbeddingStoreErrorContext<Embedded>	The embedding store error context.
interface	EmbeddingStoreListener	A EmbeddingStore listener that listens for requests, responses and errors.
class	EmbeddingStoreRequestContext<Embedded>	The embedding store request context.
static final class	EmbeddingStoreRequestContext.Add<Embedded>	The add(...) request context.
static final class	EmbeddingStoreRequestContext.AddAll<Embedded>	The addAll(...) request context.
static final class	EmbeddingStoreRequestContext.Remove<Embedded>	The remove(String) request context.
static final class	EmbeddingStoreRequestContext.RemoveAll<Embedded>	The removeAll() request context.
static final class	EmbeddingStoreRequestContext.RemoveAllFilter<Embedded>	The removeAll(Filter) request context.
static final class	EmbeddingStoreRequestContext.RemoveAllIds<Embedded>	The removeAll(ids) request context.
static final class	EmbeddingStoreRequestContext.Search<Embedded>	The search(...) request context.
class	EmbeddingStoreResponseContext<Embedded>	The embedding store response context.
static final class	EmbeddingStoreResponseContext.Add<Embedded>	The add(...) response context.
static final class	EmbeddingStoreResponseContext.AddAll<Embedded>	The addAll(...) response context.
static final class	EmbeddingStoreResponseContext.Remove<Embedded>	The remove(String) response context.
static final class	EmbeddingStoreResponseContext.RemoveAll<Embedded>	The removeAll() response context.
static final class	EmbeddingStoreResponseContext.RemoveAllFilter<Embedded>	The removeAll(Filter) response context.
static final class	EmbeddingStoreResponseContext.RemoveAllIds<Embedded>	The removeAll(ids) response context.
static final class	EmbeddingStoreResponseContext.Search<Embedded>	The search(...) response context.