Index (Vaadin AI Core 25.3-SNAPSHOT API)

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

A

addAttachmentClickListener(AIMessageList.AttachmentClickCallback) - Method in interface com.vaadin.flow.component.ai.ui.AIMessageList: Adds a listener that is called when an attachment in the message list is clicked.
addMessage(String, String, List<AIAttachment>) - Method in interface com.vaadin.flow.component.ai.ui.AIMessageList: Creates a new message with the given parameters and attachments.
addSubmitListener(SerializableConsumer<String>) - Method in interface com.vaadin.flow.component.ai.ui.AIInput: Adds a listener for submit events.
AI_COMPONENTS - Static variable in class com.vaadin.flow.component.ai.AIComponentsFeatureFlagProvider: The AI components feature flag.
AIAttachment - Record Class in com.vaadin.flow.component.ai.common: Represents an attachment that can be sent to an LLM and displayed in messages.
AIAttachment(String, String, byte[]) - Constructor for record class com.vaadin.flow.component.ai.common.AIAttachment: Creates a new attachment.
AIComponentsExperimentalFeatureException - Exception Class in com.vaadin.flow.component.ai: An exception which is thrown when somebody attempts to use AI component features without activating the associated feature flag first.
AIComponentsExperimentalFeatureException() - Constructor for exception class com.vaadin.flow.component.ai.AIComponentsExperimentalFeatureException: Creates a new exception with a default message.
AIComponentsExperimentalFeatureException(String) - Constructor for exception class com.vaadin.flow.component.ai.AIComponentsExperimentalFeatureException: Creates a new exception with a message that includes the specific component name.
AIComponentsExperimentalFeatureException(String, String) - Constructor for exception class com.vaadin.flow.component.ai.AIComponentsExperimentalFeatureException: Creates a new exception with a message that includes the specific component name and feature flag ID.
AIComponentsFeatureFlagProvider - Class in com.vaadin.flow.component.ai: Provides the AI components feature flag for AI-related features such as AIOrchestrator, modular upload components, and MessageListItem attachments.
AIComponentsFeatureFlagProvider() - Constructor for class com.vaadin.flow.component.ai.AIComponentsFeatureFlagProvider
AIController - Interface in com.vaadin.flow.component.ai.orchestrator: Contributes tools and lifecycle hooks to an AIOrchestrator — domain-specific behaviour like populating a grid, building a chart, or filling a form from natural-language requests.
AIFileReceiver - Interface in com.vaadin.flow.component.ai.ui: Interface for file upload components that are used in an AI conversation.
AIInput - Interface in com.vaadin.flow.component.ai.ui: Interface for input components that are used in an AI conversation.
AIMessage - Interface in com.vaadin.flow.component.ai.ui: Represents a message in an AI conversation.
AIMessageList - Interface in com.vaadin.flow.component.ai.ui: Interface for message list components that can display AI conversation messages.
AIMessageList.AttachmentClickCallback - Interface in com.vaadin.flow.component.ai.ui: Callback for attachment click events in the message list.
AIOrchestrator - Class in com.vaadin.flow.component.ai.orchestrator: Orchestrator for AI-powered chat interfaces.
AIOrchestrator.Builder - Class in com.vaadin.flow.component.ai.orchestrator: Builder for configuring and creating an AIOrchestrator instance.
AIOrchestrator.Reconnector - Class in com.vaadin.flow.component.ai.orchestrator: Fluent API for restoring transient dependencies on an AIOrchestrator after deserialization.
appendText(String) - Method in interface com.vaadin.flow.component.ai.ui.AIMessage: Appends text to the existing message content.
apply() - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Reconnector: Applies the reconnection, restoring the provider, tools, and conversation history on the new provider.
ASSISTANT - Enum constant in enum class com.vaadin.flow.component.ai.common.ChatMessage.Role: A message sent by the AI assistant.
AttachmentClickListener - Interface in com.vaadin.flow.component.ai.orchestrator: Listener for attachment click events.
AttachmentClickListener.AttachmentClickEvent - Class in com.vaadin.flow.component.ai.orchestrator: Event fired when an attachment in the message list is clicked.
AttachmentContentType - Enum Class in com.vaadin.flow.component.ai.common: Supported content type categories for attachments.
attachments() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.LLMRequest: Gets the list of file attachments to include with the request.
AUDIO - Enum constant in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Audio content types (audio/*).

B

build() - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Builds the orchestrator.
builder(LLMProvider, String) - Static method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator: Creates a new builder for AIOrchestrator with a system prompt.

C

ChatMessage - Record Class in com.vaadin.flow.component.ai.common: Represents a chat message in a conversation history.
ChatMessage(ChatMessage.Role, String, String, Instant) - Constructor for record class com.vaadin.flow.component.ai.common.ChatMessage: Creates a new chat message.
ChatMessage.Role - Enum Class in com.vaadin.flow.component.ai.common: The role of a message sender in a conversation.
com.vaadin.flow.component.ai - package com.vaadin.flow.component.ai
com.vaadin.flow.component.ai.common - package com.vaadin.flow.component.ai.common
com.vaadin.flow.component.ai.orchestrator - package com.vaadin.flow.component.ai.orchestrator
com.vaadin.flow.component.ai.provider - package com.vaadin.flow.component.ai.provider
com.vaadin.flow.component.ai.ui - package com.vaadin.flow.component.ai.ui
content() - Method in record class com.vaadin.flow.component.ai.common.ChatMessage: Returns the value of the content record component.
createAll(DatabaseProvider) - Static method in class com.vaadin.flow.component.ai.provider.DatabaseProviderAITools: Creates all database provider tools for the given provider.

D

data() - Method in record class com.vaadin.flow.component.ai.common.AIAttachment: Returns the value of the data record component.
DatabaseProvider - Interface in com.vaadin.flow.component.ai.provider: Provider for database schema information and SQL query execution on behalf of an LLM.
DatabaseProviderAITools - Class in com.vaadin.flow.component.ai.provider: Factory for creating reusable database LLMProvider.ToolSpec instances.

E

equals(Object) - Method in record class com.vaadin.flow.component.ai.common.AIAttachment: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.vaadin.flow.component.ai.common.ChatMessage: Indicates whether some other object is "equal to" this one.
execute(JsonNode) - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.ToolSpec: Executes the tool with the given arguments.
executeQuery(String) - Method in interface com.vaadin.flow.component.ai.provider.DatabaseProvider: Executes the given SQL query and returns the results.
explicitTools() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.LLMRequest: Gets the explicit tool definitions for this request.

F

FEATURE_FLAG_ID - Static variable in class com.vaadin.flow.component.ai.AIComponentsFeatureFlagProvider: The feature flag ID for AI components.
fromMimeType(String) - Static method in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Detects the content type category from a MIME type string.

G

getAttachmentIndex() - Method in class com.vaadin.flow.component.ai.orchestrator.AttachmentClickListener.AttachmentClickEvent: Gets the index of the clicked attachment within the message.
getAttachments() - Method in class com.vaadin.flow.component.ai.orchestrator.RequestListener.RequestEvent: Gets the attachments included with the request.
getDatabaseSchema(DatabaseProvider) - Static method in class com.vaadin.flow.component.ai.provider.DatabaseProviderAITools: Creates a tool that retrieves the database schema from the DatabaseProvider.
getDescription() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.ToolSpec: Gets a human-readable description of what this tool does.
getError() - Method in class com.vaadin.flow.component.ai.orchestrator.ResponseListener.ResponseEvent: Gets the failure cause if the turn ended with an error.
getFeatures() - Method in class com.vaadin.flow.component.ai.AIComponentsFeatureFlagProvider
getHistory() - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator: Returns the conversation history.
getMessageId() - Method in class com.vaadin.flow.component.ai.orchestrator.AttachmentClickListener.AttachmentClickEvent: Gets the unique identifier for the message containing the clicked attachment.
getMessageId() - Method in class com.vaadin.flow.component.ai.orchestrator.RequestListener.RequestEvent: Gets the unique identifier assigned to this message.
getName() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.ToolSpec: Gets the unique name of this tool.
getParametersSchema() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.ToolSpec: Gets the JSON Schema describing the parameters this tool accepts.
getResponse() - Method in class com.vaadin.flow.component.ai.orchestrator.ResponseListener.ResponseEvent: Gets the assistant's response text.
getSchema() - Method in interface com.vaadin.flow.component.ai.provider.DatabaseProvider: Returns a text description of the database schema available to the LLM.
getText() - Method in interface com.vaadin.flow.component.ai.ui.AIMessage: Gets the message text.
getTime() - Method in interface com.vaadin.flow.component.ai.ui.AIMessage: Gets the timestamp of the message.
getTools() - Method in interface com.vaadin.flow.component.ai.orchestrator.AIController: Returns the tools this controller exposes to the LLM.
getUserMessage() - Method in class com.vaadin.flow.component.ai.orchestrator.RequestListener.RequestEvent: Gets the user message being submitted to the LLM.
getUserName() - Method in interface com.vaadin.flow.component.ai.ui.AIMessage: Gets the name of the message sender.

H

hashCode() - Method in record class com.vaadin.flow.component.ai.common.AIAttachment: Returns a hash code value for this object.
hashCode() - Method in record class com.vaadin.flow.component.ai.common.ChatMessage: Returns a hash code value for this object.

I

IMAGE - Enum constant in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Image content types (image/*).

L

LangChain4JLLMProvider - Class in com.vaadin.flow.component.ai.provider: LangChain4j implementation of LLMProvider.
LangChain4JLLMProvider(ChatModel) - Constructor for class com.vaadin.flow.component.ai.provider.LangChain4JLLMProvider: Constructor with a non-streaming chat model.
LangChain4JLLMProvider(StreamingChatModel) - Constructor for class com.vaadin.flow.component.ai.provider.LangChain4JLLMProvider: Constructor with a streaming chat model.
LLMProvider - Interface in com.vaadin.flow.component.ai.provider: Framework-agnostic interface for Large Language Model (LLM) providers.
LLMProvider.LLMRequest - Interface in com.vaadin.flow.component.ai.provider: Represents a request to the LLM containing all necessary context, configuration, and tools.
LLMProvider.ToolSpec - Interface in com.vaadin.flow.component.ai.provider: A framework-agnostic tool definition that the LLM can invoke.

M

messageId() - Method in record class com.vaadin.flow.component.ai.common.ChatMessage: Returns the value of the messageId record component.
mimeType() - Method in record class com.vaadin.flow.component.ai.common.AIAttachment: Returns the value of the mimeType record component.

N

name() - Method in record class com.vaadin.flow.component.ai.common.AIAttachment: Returns the value of the name record component.

O

onAttachmentClick(AttachmentClickListener.AttachmentClickEvent) - Method in interface com.vaadin.flow.component.ai.orchestrator.AttachmentClickListener: Called when an attachment in the message list is clicked.
onAttachmentClick(AIMessage, int) - Method in interface com.vaadin.flow.component.ai.ui.AIMessageList.AttachmentClickCallback: Called when an attachment in the message list is clicked.
onRequest() - Method in interface com.vaadin.flow.component.ai.orchestrator.AIController: Called synchronously on the UI thread just before the LLM stream opens.
onRequest(RequestListener.RequestEvent) - Method in interface com.vaadin.flow.component.ai.orchestrator.RequestListener: Called just before the LLM stream opens for a prompt.
onResponse(ResponseListener.ResponseEvent) - Method in interface com.vaadin.flow.component.ai.orchestrator.ResponseListener: Called when the assistant's stream has completed.
onResponse(Throwable) - Method in interface com.vaadin.flow.component.ai.orchestrator.AIController: Called on the UI thread under the session lock when the LLM stream has completed — either successfully or with an error.

P

PDF - Enum constant in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: PDF content types (application/pdf, application/x-pdf).
prompt(String) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator: Sends a prompt to the AI orchestrator programmatically.
prompt(String, List<AIAttachment>) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator: Sends a prompt with caller-supplied attachments.

R

reconnect(LLMProvider) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator: Returns a AIOrchestrator.Reconnector to restore transient dependencies after deserialization.
RequestListener - Interface in com.vaadin.flow.component.ai.orchestrator: Listener for request submission events.
RequestListener.RequestEvent - Class in com.vaadin.flow.component.ai.orchestrator: Event fired just before the LLM stream opens for a prompt.
ResponseListener - Interface in com.vaadin.flow.component.ai.orchestrator: Listener for LLM response events.
ResponseListener.ResponseEvent - Class in com.vaadin.flow.component.ai.orchestrator: Event fired after the assistant's stream has completed, on success or failure.
role() - Method in record class com.vaadin.flow.component.ai.common.ChatMessage: Returns the value of the role record component.

S

setHistory(List<ChatMessage>, Map<String, List<AIAttachment>>) - Method in class com.vaadin.flow.component.ai.provider.LangChain4JLLMProvider
setHistory(List<ChatMessage>, Map<String, List<AIAttachment>>) - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider: Restores the provider's conversation memory from a list of chat messages with their associated attachments.
setHistory(List<ChatMessage>, Map<String, List<AIAttachment>>) - Method in class com.vaadin.flow.component.ai.provider.SpringAILLMProvider
setStreaming(boolean) - Method in class com.vaadin.flow.component.ai.provider.SpringAILLMProvider: Sets whether to use streaming mode.
setText(String) - Method in interface com.vaadin.flow.component.ai.ui.AIMessage: Sets the message text.
setTime(Instant) - Method in interface com.vaadin.flow.component.ai.ui.AIMessage: Sets the timestamp of the message.
SpringAILLMProvider - Class in com.vaadin.flow.component.ai.provider: Spring AI implementation of LLMProvider.
SpringAILLMProvider(ChatClient) - Constructor for class com.vaadin.flow.component.ai.provider.SpringAILLMProvider: Constructor with a chat client.
SpringAILLMProvider(ChatModel) - Constructor for class com.vaadin.flow.component.ai.provider.SpringAILLMProvider: Constructor with a chat model.
stream(LLMProvider.LLMRequest) - Method in class com.vaadin.flow.component.ai.provider.LangChain4JLLMProvider
stream(LLMProvider.LLMRequest) - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider: Streams a response from the LLM based on the provided request.
stream(LLMProvider.LLMRequest) - Method in class com.vaadin.flow.component.ai.provider.SpringAILLMProvider
systemPrompt() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.LLMRequest: Gets the system prompt for this specific request.

T

takeAttachments() - Method in interface com.vaadin.flow.component.ai.ui.AIFileReceiver: Returns all accumulated attachments and clears the internal state.
TEXT - Enum constant in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Text content types (text/*).
time() - Method in record class com.vaadin.flow.component.ai.common.ChatMessage: Returns the value of the time record component.
tools() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.LLMRequest: Gets the tool objects for this request.
toString() - Method in record class com.vaadin.flow.component.ai.common.AIAttachment: Returns a string representation of this record class.
toString() - Method in record class com.vaadin.flow.component.ai.common.ChatMessage: Returns a string representation of this record class.

U

UNSUPPORTED - Enum constant in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Unsupported or unknown content types.
USER - Enum constant in enum class com.vaadin.flow.component.ai.common.ChatMessage.Role: A message sent by the user.
userMessage() - Method in interface com.vaadin.flow.component.ai.provider.LLMProvider.LLMRequest: Gets the user's message.

V

valueOf(String) - Static method in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.ai.common.ChatMessage.Role: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.ai.common.ChatMessage.Role: Returns an array containing the constants of this enum class, in the order they are declared.
VIDEO - Enum constant in enum class com.vaadin.flow.component.ai.common.AttachmentContentType: Video content types (video/*).

W

withAssistantName(String) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the display name for AI assistant messages in the message list.
withAttachmentClickListener(AttachmentClickListener) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets a listener that is called when an attachment in the message list is clicked.
withAttachments(Map<String, List<AIAttachment>>) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Reconnector: Sets the file attachments to restore on the new provider's conversation memory.
withController(AIController) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the controller that provides framework-agnostic tools and lifecycle hooks to the orchestrator.
withController(AIController) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Reconnector: Sets the controller to use after reconnection.
withFileReceiver(AIFileReceiver) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the file receiver component for file uploads.
withFileReceiver(Upload) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the file receiver component using a Flow Upload component.
withFileReceiver(UploadManager) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the file receiver component using a Flow UploadManager.
withHistory(List<ChatMessage>, Map<String, List<AIAttachment>>) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the conversation history and associated attachments to restore when the orchestrator is built.
withInput(AIInput) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the input component.
withInput(MessageInput) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the input component using a Flow MessageInput component.
withMessageList(AIMessageList) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the message list component.
withMessageList(MessageList) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the message list component using a Flow MessageList component.
withMetadata(SerializableSupplier<String>) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the supplier of free-form session context the LLM sees on every turn.
withRequestListener(RequestListener) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets a listener that is called on every prompt, just before the LLM stream opens.
withResponseListener(ResponseListener) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets a listener that is called once per turn when the assistant's stream has completed — successfully or with an error.
withTools(Object...) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the objects containing vendor-specific tool-annotated methods that will be available to the LLM.
withTools(Object...) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Reconnector: Sets the objects containing vendor-specific tool-annotated methods that will be available to the LLM.
withUserName(String) - Method in class com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder: Sets the display name for user messages in the message list.

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