Package dev.langchain4j.model.workersai
Class WorkersAiChatModel
java.lang.Object
dev.langchain4j.model.workersai.client.AbstractWorkersAIModel
dev.langchain4j.model.workersai.WorkersAiChatModel
- All Implemented Interfaces:
ChatLanguageModel
WorkerAI Chat model.
...
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class dev.langchain4j.model.workersai.client.AbstractWorkersAIModel
accountId, modelName, workerAiClient
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor with Builder.WorkersAiChatModel
(String accountId, String modelName, String apiToken) Constructor with Builder. -
Method Summary
Modifier and TypeMethodDescriptionstatic WorkersAiChatModel.Builder
builder()
Builder access.generate
(@NonNull ChatMessage... messages) Generates a response from the model based on a sequence of messages.Generates a response from the model based on a message from a user.generate
(List<ChatMessage> messages) Generates a response from the model based on a sequence of messages.generate
(List<ChatMessage> messages, ToolSpecification toolSpecification) Generates a response from the model based on a list of messages and a single tool specification.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 dev.langchain4j.model.workersai.client.AbstractWorkersAIModel
processErrors
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, supportedCapabilities
-
Constructor Details
-
WorkersAiChatModel
Constructor with Builder.- Parameters:
builder
- builder.
-
WorkersAiChatModel
Constructor with Builder.- Parameters:
accountId
- account identifiermodelName
- model nameapiToken
- api token
-
-
Method Details
-
builder
Builder access.- Returns:
- builder instance
-
generate
Generates a response from the model based on a message from a user. This is a convenience method that receives the message from a user as a String and returns only the generated response.- Specified by:
generate
in interfaceChatLanguageModel
- Parameters:
userMessage
- The message from the user.- Returns:
- The response generated by the model.
-
generate
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 interfaceChatLanguageModel
- Parameters:
messages
- An array of messages.- Returns:
- The response generated by the model.
-
generate
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 interfaceChatLanguageModel
- Parameters:
messages
- A list of messages.- Returns:
- The response generated by the model.
-
generate
public 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. 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 interfaceChatLanguageModel
- 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) 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. Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...- Specified by:
generate
in interfaceChatLanguageModel
- 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.
-