Package dev.langchain4j.model.localai

Class LocalAiChatModel

java.lang.Object

dev.langchain4j.model.localai.LocalAiChatModel

All Implemented Interfaces:

ChatLanguageModel

public class LocalAiChatModel
extends Object
implements ChatLanguageModel

See LocalAI documentation for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocalAiChatModel.LocalAiChatModelBuilder

Constructor Summary

Constructors

Constructor	Description
LocalAiChatModel(String baseUrl, String modelName, Double temperature, Double topP, Integer maxTokens, Duration timeout, Integer maxRetries, Boolean logRequests, Boolean logResponses)

Method Summary

Modifier and Type	Method	Description
static LocalAiChatModel.LocalAiChatModelBuilder	builder()
Response<AiMessage>	generate(List<ChatMessage> messages)	Generates a response from the model based on a sequence of messages.
Response<AiMessage>	generate(List<ChatMessage> messages, ToolSpecification toolSpecification)	Generates a response from the model based on a list of messages and a single tool specification.
Response<AiMessage>	generate(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications)	Generates a response from the model based on a list of messages and a list of tool specifications.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.chat.ChatLanguageModel

chat, generate, generate, supportedCapabilities

Constructor Details

LocalAiChatModel

public LocalAiChatModel(String baseUrl,
 String modelName,
 Double temperature,
 Double topP,
 Integer maxTokens,
 Duration timeout,
 Integer maxRetries,
 Boolean logRequests,
 Boolean logResponses)

Method Details

generate

public Response<AiMessage> generate(List<ChatMessage> messages)

Description copied from interface: ChatLanguageModel

Generates a response from the model based on a sequence of messages. Typically, the sequence contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Specified by:

generate in interface ChatLanguageModel

Parameters:

messages - A list of messages.

Returns:

The response generated by the model.

generate

public Response<AiMessage> generate(List<ChatMessage> messages,
 List<ToolSpecification> toolSpecifications)

Description copied from interface: ChatLanguageModel

Generates a response from the model based on a list of messages and a list of tool specifications. The response may either be a text message or a request to execute one of the specified tools. Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Specified by:

generate in interface ChatLanguageModel

Parameters:

messages - A list of messages.

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

Returns:

The response generated by the model. AiMessage can contain either a textual response or a request to execute one of the tools.

generate

public Response<AiMessage> generate(List<ChatMessage> messages,
 ToolSpecification toolSpecification)

Description copied from interface: ChatLanguageModel

Generates a response from the model based on a list of messages and a single tool specification. The model is forced to execute the specified tool. This is usually achieved by setting `tool_choice=ANY` in the LLM provider API.
Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...

Specified by:

generate in interface ChatLanguageModel

Parameters:

messages - A list of messages.

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

Returns:

The response generated by the model. AiMessage contains a request to execute the specified tool.

builder

public static LocalAiChatModel.LocalAiChatModelBuilder builder()