All Implemented Interfaces:

dev.langchain4j.data.message.ChatMessage
```
public class AiMessage
 implements ChatMessage
                    
```
Represents a response message from an AI (language model). The message can contain either a textual response or a request to execute one/multiple tool(s). In the case of tool execution, the response to this message should be one/multiple ToolExecutionResultMessage.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`AiMessage.Builder`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`AiMessage(String text)`	Create a new AiMessage with the given text.
`AiMessage(List<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given tool execution requests.
`AiMessage(String text, List<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given text and tool execution requests.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`text()`	Get the text of the message.
`List<ToolExecutionRequest>`	`toolExecutionRequests()`	Get the tool execution requests of the message.
`boolean`	`hasToolExecutionRequests()`	Check if the message has ToolExecutionRequests.
`ChatMessageType`	`type()`	The type of the message.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`toString()`
`static AiMessage.Builder`	`builder()`
`static AiMessage`	`from(String text)`	Create a new AiMessage with the given text.
`static AiMessage`	`from(Array<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given tool execution requests.
`static AiMessage`	`from(List<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given tool execution requests.
`static AiMessage`	`from(String text, List<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given text and tool execution requests.
`static AiMessage`	`aiMessage(String text)`	Create a new AiMessage with the given text.
`static AiMessage`	`aiMessage(Array<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given tool execution requests.
`static AiMessage`	`aiMessage(List<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given tool execution requests.
`static AiMessage`	`aiMessage(String text, List<ToolExecutionRequest> toolExecutionRequests)`	Create a new AiMessage with the given text and tool execution requests.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AiMessage
```
AiMessage(String text)
```
    Create a new AiMessage with the given text.
    
    Parameters:
    
    text - the text of the message.
  - AiMessage
```
AiMessage(List<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given tool execution requests.
    
    Parameters:
    
    toolExecutionRequests - the tool execution requests of the message.
  - AiMessage
```
AiMessage(String text, List<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given text and tool execution requests.
    
    Parameters:
    
    text - the text of the message.
    
    toolExecutionRequests - the tool execution requests of the message.
- Method Detail
  - text
```
 String text()
```
    Get the text of the message.
    
    Returns:
    
    the text of the message.
  - toolExecutionRequests
```
 List<ToolExecutionRequest> toolExecutionRequests()
```
    Get the tool execution requests of the message.
    
    Returns:
    
    the tool execution requests of the message.
  - hasToolExecutionRequests
```
 boolean hasToolExecutionRequests()
```
    Check if the message has ToolExecutionRequests.
    
    Returns:
    
    true if the message has ToolExecutionRequests, false otherwise.
  - type
```
 ChatMessageType type()
```
    The type of the message.
    
    Returns:
    
    the type of the message
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 static AiMessage.Builder builder()
```
  - from
```
 static AiMessage from(String text)
```
    Create a new AiMessage with the given text.
    
    Parameters:
    
    text - the text of the message.
    
    Returns:
    
    the new AiMessage.
  - from
```
 static AiMessage from(Array<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given tool execution requests.
    
    Parameters:
    
    toolExecutionRequests - the tool execution requests of the message.
    
    Returns:
    
    the new AiMessage.
  - from
```
 static AiMessage from(List<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given tool execution requests.
    
    Parameters:
    
    toolExecutionRequests - the tool execution requests of the message.
    
    Returns:
    
    the new AiMessage.
  - from
```
 static AiMessage from(String text, List<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given text and tool execution requests.
    
    Parameters:
    
    text - the text of the message.
    
    toolExecutionRequests - the tool execution requests of the message.
    
    Returns:
    
    the new AiMessage.
  - aiMessage
```
 static AiMessage aiMessage(String text)
```
    Create a new AiMessage with the given text.
    
    Parameters:
    
    text - the text of the message.
    
    Returns:
    
    the new AiMessage.
  - aiMessage
```
 static AiMessage aiMessage(Array<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given tool execution requests.
    
    Parameters:
    
    toolExecutionRequests - the tool execution requests of the message.
    
    Returns:
    
    the new AiMessage.
  - aiMessage
```
 static AiMessage aiMessage(List<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given tool execution requests.
    
    Parameters:
    
    toolExecutionRequests - the tool execution requests of the message.
    
    Returns:
    
    the new AiMessage.
  - aiMessage
```
 static AiMessage aiMessage(String text, List<ToolExecutionRequest> toolExecutionRequests)
```
    Create a new AiMessage with the given text and tool execution requests.
    
    Parameters:
    
    text - the text of the message.
    
    toolExecutionRequests - the tool execution requests of the message.
    
    Returns:
    
    the new AiMessage.

Class AiMessage

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AiMessage

AiMessage

AiMessage

Method Detail

text

toolExecutionRequests

hasToolExecutionRequests

type

equals

hashCode

toString

builder

from

from

from

from

aiMessage

aiMessage

aiMessage

aiMessage