dev.langchain4j.model.chat

Interface ChatLanguageModel

public interface ChatLanguageModel

Represents a LLM that has a chat interface.

Method Summary

Modifier and Type	Method and Description
default AiMessage	sendMessages(ChatMessage... messages) Sends a sequence of messages to the LLM and returns a response.
AiMessage	sendMessages(List<ChatMessage> messages) Sends a list of messages to the LLM and returns a response.
AiMessage	sendMessages(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications) Sends a list of messages and a list of tool specifications to the LLM and returns a response.
AiMessage	sendMessages(List<ChatMessage> messages, ToolSpecification toolSpecification) Sends a list of messages and a specification of a tool that must be executed to the LLM and returns a response that contains a request to execute specified tool.
default AiMessage	sendUserMessage(Object structuredPrompt) Sends a structured prompt as a user message to the LLM and returns a response.
default AiMessage	sendUserMessage(String userMessage) Sends a message from a user to the LLM and returns a response.
default AiMessage	sendUserMessage(UserMessage userMessage) Sends a message from a user to the LLM and returns a response.

Method Detail

sendUserMessage

default AiMessage sendUserMessage(String userMessage)

Sends a message from a user to the LLM and returns a response.

Parameters:

userMessage - A user message as a String. Will be wrapped into UserMessage under the hood.

Returns:

Response from the LLM.

sendUserMessage

default AiMessage sendUserMessage(UserMessage userMessage)

Sends a message from a user to the LLM and returns a response.

Parameters:

userMessage - A user message.

Returns:

Response from the LLM.

sendUserMessage

default AiMessage sendUserMessage(Object structuredPrompt)

Sends a structured prompt as a user message to the LLM and returns a response.

Parameters:

structuredPrompt - A user message as an object annotated with @StructuredPrompt. Will be converted into UserMessage under the hood.

Returns:

Response from the LLM.

sendMessages

default AiMessage sendMessages(ChatMessage... messages)

Sends a sequence of messages to the LLM and returns a response. Typically, the sequence contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Parameters:

messages - An array of messages to be sent.

Returns:

Response from the LLM.

sendMessages

AiMessage sendMessages(List<ChatMessage> messages)

Sends a list of messages to the LLM and returns a response. Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Parameters:

messages - A list of messages to be sent.

Returns:

Response from the LLM.

sendMessages

AiMessage sendMessages(List<ChatMessage> messages,
                       List<ToolSpecification> toolSpecifications)

Sends a list of messages and a list of tool specifications to the LLM and returns a response. Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Parameters:

messages - A list of messages to be sent.

toolSpecifications - A list of tools that the LLM is allowed to execute. The LLM autonomously decides whether to use any of these tools.

Returns:

Response from the LLM. AiMessage can contain either a textual response or a request to execute a tool.

sendMessages

AiMessage sendMessages(List<ChatMessage> messages,
                       ToolSpecification toolSpecification)

Sends a list of messages and a specification of a tool that must be executed to the LLM and returns a response that contains a request to execute specified tool. Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Parameters:

messages - A list of messages to be sent.

toolSpecification - The specification of a tool that must be executed. LLM is forced to call this tool.

Returns:

The response from the LLM, which contains a request to execute a tool.