Package akka.javasdk.agent

Record Class MessageContent.ImageMessageContent

Object

Record

akka.javasdk.agent.MessageContent.ImageMessageContent

Enclosing interface:

MessageContent

public static record MessageContent.ImageMessageContent()
extends Record

Factory methods for creating image message content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MessageContent.ImageMessageContent.DetailLevel	Controls the level of detail used when processing images.

Constructor Summary

Constructors

Constructor	Description
ImageMessageContent()	Creates an instance of a ImageMessageContent record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static MessageContent.ImageBytesMessageContent	fromBytes(byte[] data, String mimeType)	Creates inline image content from raw bytes, for returning an image from a @FunctionTool.
static MessageContent.ImageBytesMessageContent	fromBytes(byte[] data, String mimeType, MessageContent.ImageMessageContent.DetailLevel detailLevel)	Creates inline image content from raw bytes with an explicit detail level, for returning an image from a @FunctionTool.
static MessageContent.ImageUrlMessageContent	fromUri(String uri)	Creates image content from a URI string with automatic detail level.
static MessageContent.ImageUrlMessageContent	fromUri(URI uri)	Creates image content from a URI with automatic detail level.
static MessageContent.ImageUrlMessageContent	fromUri(URI uri, MessageContent.ImageMessageContent.DetailLevel detailLevel)	Creates image content from a URI with a specific detail level.
static MessageContent.ImageUrlMessageContent	fromUri(URI uri, MessageContent.ImageMessageContent.DetailLevel detailLevel, String mimeType)	Creates image content from a URI with a specific detail level and explicit mime type.
static MessageContent.ImageUrlMessageContent	fromUrl(String url)	Deprecated, for removal: This API element is subject to removal in a future version. Use fromUri(String) instead.
static MessageContent.ImageUrlMessageContent	fromUrl(URL url)	Deprecated, for removal: This API element is subject to removal in a future version. Use fromUri(URI) instead.
static MessageContent.ImageUrlMessageContent	fromUrl(URL url, MessageContent.ImageMessageContent.DetailLevel detailLevel)	Deprecated, for removal: This API element is subject to removal in a future version. Use fromUri(URI, DetailLevel) instead.
static MessageContent.ImageUrlMessageContent	fromUrl(URL url, MessageContent.ImageMessageContent.DetailLevel detailLevel, String mimeType)	Deprecated, for removal: This API element is subject to removal in a future version. Use fromUri(URI, DetailLevel, String) instead.
final int	hashCode()	Returns a hash code value for this object.
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

ImageMessageContent

public ImageMessageContent()

Creates an instance of a ImageMessageContent record class.

Method Details

fromUri

public static MessageContent.ImageUrlMessageContent fromUri(String uri)

Creates image content from a URI string with automatic detail level.

Parameters:

uri - The URI string pointing to the image. Supports http(s):// as well as custom schemes resolved by a ContentLoader and object://bucket/key backed by object storage.

Returns:

A new ImageUrlMessageContent instance with AUTO detail level

fromUri

public static MessageContent.ImageUrlMessageContent fromUri(URI uri)

Creates image content from a URI with automatic detail level.

Parameters:

uri - The URI pointing to the image

Returns:

A new ImageUrlMessageContent instance with AUTO detail level

fromUri

public static MessageContent.ImageUrlMessageContent fromUri(URI uri,
 MessageContent.ImageMessageContent.DetailLevel detailLevel)

Creates image content from a URI with a specific detail level.

Parameters:

uri - The URI pointing to the image

detailLevel - The level of detail for image processing

Returns:

A new ImageUrlMessageContent instance

fromUri

public static MessageContent.ImageUrlMessageContent fromUri(URI uri,
 MessageContent.ImageMessageContent.DetailLevel detailLevel,
 String mimeType)

Creates image content from a URI with a specific detail level and explicit mime type.

Parameters:

uri - The URI pointing to the image

detailLevel - The level of detail for image processing

mimeType - The mimeType of the image, e.g. 'image/jpeg', 'image/png'

Returns:

A new ImageUrlMessageContent instance

fromBytes

public static MessageContent.ImageBytesMessageContent fromBytes(byte[] data,
 String mimeType)

Creates inline image content from raw bytes, for returning an image from a @FunctionTool. Not valid as model input — reference images by URI in a UserMessage.

Parameters:

data - the raw image bytes; must be effectively immutable — do not modify after passing it in

mimeType - the image media type, e.g. image/png

fromBytes

public static MessageContent.ImageBytesMessageContent fromBytes(byte[] data,
 String mimeType,
 MessageContent.ImageMessageContent.DetailLevel detailLevel)

Creates inline image content from raw bytes with an explicit detail level, for returning an image from a @FunctionTool. Not valid as model input.

Parameters:

data - the raw image bytes; must be effectively immutable — do not modify after passing it in

mimeType - the image media type, e.g. image/png

detailLevel - the level of detail for image processing

fromUrl

@Deprecated(forRemoval=true,
            since="3.6.0")
public static MessageContent.ImageUrlMessageContent fromUrl(String url)

Deprecated, for removal: This API element is subject to removal in a future version.

Use fromUri(String) instead.

fromUrl

@Deprecated(forRemoval=true,
            since="3.6.0")
public static MessageContent.ImageUrlMessageContent fromUrl(URL url)

Deprecated, for removal: This API element is subject to removal in a future version.

Use fromUri(URI) instead.

fromUrl

@Deprecated(forRemoval=true,
            since="3.6.0")
public static MessageContent.ImageUrlMessageContent fromUrl(URL url,
 MessageContent.ImageMessageContent.DetailLevel detailLevel)

Deprecated, for removal: This API element is subject to removal in a future version.

Use fromUri(URI, DetailLevel) instead.

fromUrl

@Deprecated(forRemoval=true,
            since="3.6.0")
public static MessageContent.ImageUrlMessageContent fromUrl(URL url,
 MessageContent.ImageMessageContent.DetailLevel detailLevel,
 String mimeType)

Deprecated, for removal: This API element is subject to removal in a future version.

Use fromUri(URI, DetailLevel, String) instead.

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.

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.