Package akka.javasdk.agent

Record Class MessageContent.ImageBytesMessageContent

Object

Record

akka.javasdk.agent.MessageContent.ImageBytesMessageContent

All Implemented Interfaces:

MessageContent, MessageContent.DataMessageContent, MessageContent.ImageDataMessageContent

Enclosing interface:

MessageContent

public static record MessageContent.ImageBytesMessageContent(byte[] data, Optional<String> mimeType, MessageContent.ImageMessageContent.DetailLevel detailLevel)
extends Record
implements MessageContent.ImageDataMessageContent

Image content carried as inline bytes, for returning binary media from a @FunctionTool.

Inline bytes are only valid as a tool return value; they cannot be sent to the model as input. In a UserMessage reference images by URI using MessageContent.ImageUrlMessageContent.

The data array must be effectively immutable — do not modify it after passing it in.

Build via MessageContent.ImageMessageContent.fromBytes(byte[], String).

Nested Class Summary

Nested classes/interfaces inherited from interface akka.javasdk.agent.MessageContent

MessageContent.DataMessageContent, MessageContent.ImageBytesMessageContent, MessageContent.ImageDataMessageContent, MessageContent.ImageMessageContent, MessageContent.ImageUrlMessageContent, MessageContent.LoadableMessageContent, MessageContent.PdfBytesMessageContent, MessageContent.PdfDataMessageContent, MessageContent.PdfMessageContent, MessageContent.PdfUrlMessageContent, MessageContent.TextMessageContent

Constructor Summary

Constructors

Constructor	Description
ImageBytesMessageContent(byte[] data, Optional<String> mimeType, MessageContent.ImageMessageContent.DetailLevel detailLevel)	Creates an instance of a ImageBytesMessageContent record class.

Method Summary

Modifier and Type	Method	Description
byte[]	data()	Returns the value of the data record component.
MessageContent.ImageMessageContent.DetailLevel	detailLevel()	Returns the value of the detailLevel record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Optional<String>	mimeType()	Returns the value of the mimeType record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ImageBytesMessageContent

public ImageBytesMessageContent(byte[] data,
 Optional<String> mimeType,
 MessageContent.ImageMessageContent.DetailLevel detailLevel)

Creates an instance of a ImageBytesMessageContent record class.

Parameters:

data - the value for the data record component

mimeType - the value for the mimeType record component

detailLevel - the value for the detailLevel record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

data

public byte[] data()

Returns the value of the data record component.

Specified by:

data in interface MessageContent.DataMessageContent

Returns:

the value of the data record component

mimeType

public Optional<String> mimeType()

Returns the value of the mimeType record component.

Specified by:

mimeType in interface MessageContent.DataMessageContent

Returns:

the value of the mimeType record component

detailLevel

public MessageContent.ImageMessageContent.DetailLevel detailLevel()

Returns the value of the detailLevel record component.

Specified by:

detailLevel in interface MessageContent.ImageDataMessageContent

Returns:

the value of the detailLevel record component