Uses of Annotation Interface
dev.langchain4j.Experimental

Packages that use Experimental

Package	Description
dev.langchain4j.data.audio
dev.langchain4j.data.message
dev.langchain4j.data.pdf
dev.langchain4j.data.text
dev.langchain4j.data.video
dev.langchain4j.exception
dev.langchain4j.experimental.rag.content.retriever.sql
dev.langchain4j.model.chat
dev.langchain4j.model.chat.listener
dev.langchain4j.model.chat.request
dev.langchain4j.model.chat.request.json
dev.langchain4j.model.chat.response
dev.langchain4j.model.googleai
dev.langchain4j.model.openai
dev.langchain4j.rag
dev.langchain4j.rag.content.aggregator
dev.langchain4j.rag.content.injector
dev.langchain4j.rag.query.router
dev.langchain4j.rag.query.transformer
dev.langchain4j.service
dev.langchain4j.service.output
dev.langchain4j.store.embedding
dev.langchain4j.store.embedding.filter.builder.sql
dev.langchain4j.store.embedding.filter.parser.sql

Uses of Experimental in dev.langchain4j.data.audio

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

Modifier and Type	Class	Description
class	Audio

Uses of Experimental in dev.langchain4j.data.message

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

Modifier and Type	Class	Description
class	AudioContent
class	PdfFileContent
class	TextFileContent
class	VideoContent

Uses of Experimental in dev.langchain4j.data.pdf

Classes in dev.langchain4j.data.pdf with annotations of type Experimental

Modifier and Type	Class	Description
class	PdfFile

Uses of Experimental in dev.langchain4j.data.text

Classes in dev.langchain4j.data.text with annotations of type Experimental

Modifier and Type	Class	Description
class	TextFile

Uses of Experimental in dev.langchain4j.data.video

Classes in dev.langchain4j.data.video with annotations of type Experimental

Modifier and Type	Class	Description
class	Video

Uses of Experimental in dev.langchain4j.exception

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

Modifier and Type	Class	Description
class	UnsupportedFeatureException

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! Although fun and exciting, this class is dangerous to use! Do not ever use this in production! The database user must have very limited READ-ONLY permissions! Although the generated SQL is somewhat validated (to ensure that the SQL is a SELECT statement) using JSqlParser, this class does not guarantee that the SQL will be harmless.

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, ChatLanguageModel chatLanguageModel, Integer maxRetries)	Creates an instance of a SqlDatabaseContentRetriever.

Uses of Experimental in dev.langchain4j.model.chat

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

Modifier and Type	Class	Description
enum	Capability	Represents a capability of a ChatLanguageModel or StreamingChatLanguageModel.

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

Modifier and Type	Method	Description
default ChatResponse	ChatLanguageModel.chat(ChatRequest chatRequest)	This is the main API to interact with the chat model.
default String	ChatLanguageModel.chat(String userMessage)
default void	StreamingChatLanguageModel.chat(ChatRequest chatRequest, StreamingChatResponseHandler handler)	This is the main API to interact with the chat model.
default ChatRequestParameters	ChatLanguageModel.defaultRequestParameters()
default ChatRequestParameters	StreamingChatLanguageModel.defaultRequestParameters()
default Set<Capability>	ChatLanguageModel.supportedCapabilities()
default Set<Capability>	StreamingChatLanguageModel.supportedCapabilities()

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

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

Modifier and Type	Class	Description
class	ChatModelErrorContext	The error context.
interface	ChatModelListener	A ChatLanguageModel listener that listens for requests, responses and errors.
class	ChatModelRequest	A request to the ChatLanguageModel or StreamingChatLanguageModel, intended to be used with ChatModelListener.
class	ChatModelRequestContext	The request context.
class	ChatModelResponse	A response from the ChatLanguageModel or StreamingChatLanguageModel, intended to be used with ChatModelListener.
class	ChatModelResponseContext	The response context.

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

Modifier and Type	Method	Description
default void	ChatModelListener.onError(ChatModelErrorContext errorContext)	This method is called when an error occurs during interaction with the model.
default void	ChatModelListener.onRequest(ChatModelRequestContext requestContext)	This method is called before the request is sent to the model.
default void	ChatModelListener.onResponse(ChatModelResponseContext responseContext)	This method is called after the response is received from the model.

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

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

Modifier and Type	Class	Description
class	ChatRequest
interface	ChatRequestParameters	Represents common chat request parameters supported by most LLM providers.
class	DefaultChatRequestParameters
class	ResponseFormat
enum	ResponseFormatType
enum	ToolChoice

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

Modifier and Type	Method	Description
ChatRequest.Builder	ChatRequest.Builder.parameters(ChatRequestParameters parameters)
ChatRequestParameters	ChatRequest.parameters()

Uses of Experimental in dev.langchain4j.model.chat.request.json

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

Modifier and Type	Class	Description
class	JsonAnyOfSchema
class	JsonArraySchema
class	JsonBooleanSchema
class	JsonEnumSchema
class	JsonIntegerSchema
class	JsonNumberSchema
class	JsonObjectSchema
class	JsonReferenceSchema	Can reference JsonObjectSchema when recursion is required.
class	JsonSchema
interface	JsonSchemaElement	A base interface for a JSON schema element.
class	JsonStringSchema

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	ChatResponse
class	ChatResponseMetadata	Represents common chat response metadata supported by most LLM providers.

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

Modifier and Type	Method	Description
ChatResponseMetadata	ChatResponse.metadata()

Uses of Experimental in dev.langchain4j.model.googleai

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

Modifier and Type	Class	Description
class	GoogleAiEmbeddingModel
class	GoogleAiGeminiChatModel
class	GoogleAiGeminiStreamingChatModel

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	OpenAiChatRequestParameters
class	OpenAiChatResponseMetadata
class	OpenAiTokenUsage
static final record	OpenAiTokenUsage.InputTokensDetails
static final record	OpenAiTokenUsage.OutputTokensDetails

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

Modifier and Type	Method	Description
OpenAiTokenUsage.Builder	OpenAiTokenUsage.Builder.inputTokensDetails(OpenAiTokenUsage.InputTokensDetails inputTokensDetails)
OpenAiTokenUsage.InputTokensDetails	OpenAiTokenUsage.inputTokensDetails()
OpenAiTokenUsage.Builder	OpenAiTokenUsage.Builder.outputTokensDetails(OpenAiTokenUsage.OutputTokensDetails outputTokensDetails)
OpenAiTokenUsage.OutputTokensDetails	OpenAiTokenUsage.outputTokensDetails()

Uses of Experimental in dev.langchain4j.rag

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

Modifier and Type	Interface	Description
interface	RetrievalAugmentor	Augments the provided ChatMessage with retrieved Contents.

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

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

Modifier and Type	Interface	Description
interface	ContentAggregator	Aggregates all Contents retrieved from all ContentRetrievers using all Querys.

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

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

Modifier and Type	Interface	Description
interface	ContentInjector	Injects given Contents into a given UserMessage.

Uses of Experimental in dev.langchain4j.rag.query.router

Classes in dev.langchain4j.rag.query.router with annotations of type Experimental

Modifier and Type	Interface	Description
interface	QueryRouter	Routes the given Query to one or multiple ContentRetrievers.

Uses of Experimental in dev.langchain4j.rag.query.transformer

Classes in dev.langchain4j.rag.query.transformer with annotations of type Experimental

Modifier and Type	Interface	Description
interface	QueryTransformer	Transforms the given Query into one or multiple Querys.

Uses of Experimental in dev.langchain4j.service

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

Modifier and Type	Method	Description
TokenStream	TokenStream.onCompleteResponse(Consumer<ChatResponse> completeResponseHandler)	The provided handler will be invoked when a language model finishes streaming a response.
TokenStream	TokenStream.onPartialResponse(Consumer<String> partialResponseHandler)	The provided consumer will be invoked every time a new partial response (usually a single token) from a language model is available.

Uses of Experimental in dev.langchain4j.service.output

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

Modifier and Type	Class	Description
class	JsonSchemas

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 void	EmbeddingStore.remove(String id)	Removes a single embedding from the store by ID.
default void	EmbeddingStore.removeAll()	Removes all embeddings from the store.
default void	EmbeddingStore.removeAll(Filter filter)	Removes all embeddings that match the specified Filter from the store.
default void	EmbeddingStore.removeAll(Collection<String> ids)	Removes all embeddings that match the specified IDs from the store.

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.