Package com.vaadin.flow.component.ai.orchestrator

Class AIOrchestrator.Builder

java.lang.Object

com.vaadin.flow.component.ai.orchestrator.AIOrchestrator.Builder

Enclosing class:

AIOrchestrator

public static class AIOrchestrator.Builder
extends Object

Builder for configuring and creating an AIOrchestrator instance.

The builder requires an LLMProvider and a system prompt. All other settings are optional:

• withInput(AIInput) or withInput(MessageInput) – connects a text input component so that user submissions are automatically forwarded to the LLM. If omitted, use AIOrchestrator.prompt(String) to send messages programmatically.
• withMessageList(AIMessageList) or withMessageList(MessageList) – connects a message list component to display the conversation. If omitted, responses are still streamed but not rendered.
• withFileReceiver(AIFileReceiver) or withFileReceiver(UploadManager) – enables file upload support. Uploaded files are sent to the LLM as attachments with the next prompt.
• withTools(Object...) – registers objects containing vendor-specific tool-annotated methods (e.g. LangChain4j's @Tool or Spring AI's @Tool) that the LLM can invoke.
• withUserName(String) – sets the display name for user messages (defaults to "You").
• withAssistantName(String) – sets the display name for assistant messages (defaults to "Assistant").

Both Flow components (MessageInput, MessageList, UploadManager) and custom implementations of the AI interfaces (AIInput, AIMessageList, AIFileReceiver) are accepted.

Method Summary

Modifier and Type	Method	Description
AIOrchestrator	build()	Builds the orchestrator.
AIOrchestrator.Builder	withAssistantName(String assistantName)	Sets the display name for AI assistant messages in the message list.
AIOrchestrator.Builder	withFileReceiver(AIFileReceiver fileReceiver)	Sets the file receiver component for file uploads.
AIOrchestrator.Builder	withFileReceiver(UploadManager uploadManager)	Sets the file receiver component using a Flow UploadManager.
AIOrchestrator.Builder	withInput(AIInput input)	Sets the input component.
AIOrchestrator.Builder	withInput(MessageInput messageInput)	Sets the input component using a Flow MessageInput component.
AIOrchestrator.Builder	withMessageList(AIMessageList messageList)	Sets the message list component.
AIOrchestrator.Builder	withMessageList(MessageList messageList)	Sets the message list component using a Flow MessageList component.
AIOrchestrator.Builder	withTools(Object... tools)	Sets the objects containing vendor-specific tool-annotated methods that will be available to the LLM.
AIOrchestrator.Builder	withUserName(String userName)	Sets the display name for user messages in the message list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withMessageList

public AIOrchestrator.Builder withMessageList(AIMessageList messageList)

Sets the message list component.

Parameters:

messageList - the message list

Returns:

this builder

withMessageList

public AIOrchestrator.Builder withMessageList(MessageList messageList)

Sets the message list component using a Flow MessageList component.

Parameters:

messageList - the Flow MessageList component

Returns:

this builder

withInput

public AIOrchestrator.Builder withInput(AIInput input)

Sets the input component.

Parameters:

input - the input component

Returns:

this builder

withInput

public AIOrchestrator.Builder withInput(MessageInput messageInput)

Sets the input component using a Flow MessageInput component.

Parameters:

messageInput - the Flow MessageInput component

Returns:

this builder

withFileReceiver

public AIOrchestrator.Builder withFileReceiver(AIFileReceiver fileReceiver)

Sets the file receiver component for file uploads.

Parameters:

fileReceiver - the file receiver

Returns:

this builder

withFileReceiver

public AIOrchestrator.Builder withFileReceiver(UploadManager uploadManager)

Sets the file receiver component using a Flow UploadManager. The provided manager should not have an UploadHandler set beforehand.

Parameters:

uploadManager - the Flow UploadManager

Returns:

this builder

Throws:

IllegalArgumentException - if the UploadManager already has an

invalid reference

UploadHandler

withTools

public AIOrchestrator.Builder withTools(Object... tools)

Sets the objects containing vendor-specific tool-annotated methods that will be available to the LLM.

For LangChain4j, use @dev.langchain4j.agent.tool.Tool. For Spring AI, use @org.springframework.ai.tool.annotation.Tool.

Parameters:

tools - the objects containing tool methods

Returns:

this builder

withUserName

public AIOrchestrator.Builder withUserName(String userName)

Sets the display name for user messages in the message list.

This name is shown as the author of messages sent by the user. If not set, defaults to "You".

Parameters:

userName - the display name for user messages, not null

Returns:

this builder

withAssistantName

public AIOrchestrator.Builder withAssistantName(String assistantName)

Sets the display name for AI assistant messages in the message list.

This name is shown as the author of messages generated by the AI. If not set, defaults to "Assistant".

Parameters:

assistantName - the display name for AI messages, not null

Returns:

this builder

build

public AIOrchestrator build()

Builds the orchestrator.

Returns:

the configured orchestrator