Uses of Annotation Interface
dev.langchain4j.Experimental

Packages that use Experimental

Package	Description
dev.langchain4j.agent.tool
dev.langchain4j.data.message
dev.langchain4j.model.audio
dev.langchain4j.model.catalog	Contains interfaces and classes for model catalog functionality.
dev.langchain4j.model.chat.response
dev.langchain4j.model.embedding
dev.langchain4j.model.embedding.listener
dev.langchain4j.rag.content.retriever
dev.langchain4j.rag.content.retriever.listener
dev.langchain4j.store.embedding
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.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	Defines the behavior of a tool's return value when called by a language model.
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.
AiMessage.Builder	AiMessage.Builder.thinking(String thinking)
String	AiMessage.thinking()	Get the thinking/reasoning text of the message.

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

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