Package akka.javasdk.agent

Record Class MessageContent.ImageUrlMessageContent

Object

Record

akka.javasdk.agent.MessageContent.ImageUrlMessageContent

Record Components:

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'

All Implemented Interfaces:

MessageContent, MessageContent.LoadableMessageContent

Enclosing interface:

MessageContent

public static record MessageContent.ImageUrlMessageContent(URI uri, MessageContent.ImageMessageContent.DetailLevel detailLevel, Optional<String> mimeType)
extends Record
implements MessageContent.LoadableMessageContent

Image content within a user message, referenced by URI.

Nested Class Summary

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

MessageContent.ImageMessageContent, MessageContent.ImageUrlMessageContent, MessageContent.LoadableMessageContent, MessageContent.PdfMessageContent, MessageContent.PdfUrlMessageContent, MessageContent.TextMessageContent

Constructor Summary

Constructors

Constructor	Description
ImageUrlMessageContent(URI uri, MessageContent.ImageMessageContent.DetailLevel detailLevel)	Image content within a user message, referenced by URI.
ImageUrlMessageContent(URI uri, MessageContent.ImageMessageContent.DetailLevel detailLevel, Optional<String> mimeType)	Creates an instance of a ImageUrlMessageContent record class.
ImageUrlMessageContent(URL url, MessageContent.ImageMessageContent.DetailLevel detailLevel)	Deprecated, for removal: This API element is subject to removal in a future version. Use ImageUrlMessageContent(URI, ImageMessageContent.DetailLevel) instead.
ImageUrlMessageContent(URL url, MessageContent.ImageMessageContent.DetailLevel detailLevel, Optional<String> mimeType)	Deprecated, for removal: This API element is subject to removal in a future version. Use ImageUrlMessageContent(URI, ImageMessageContent.DetailLevel, Optional) instead.

Method Summary

Modifier and Type	Method	Description
static MessageContent.ImageUrlMessageContent	create(ObjectStorage bucket, String key)	Creates image content referencing an object in a bucket via the object:// URI scheme.
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.
URI	uri()	Returns the value of the uri record component.
URL	url()	Deprecated, for removal: This API element is subject to removal in a future version. Use uri() instead.

Methods inherited from class java.lang.Object

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

Constructor Details

ImageUrlMessageContent

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

Image content within a user message, referenced by URI.

Parameters:

uri - The URI pointing to the image

detailLevel - The level of detail for image processing

ImageUrlMessageContent

@Deprecated(forRemoval=true)
public ImageUrlMessageContent(URL url,
 MessageContent.ImageMessageContent.DetailLevel detailLevel,
 Optional<String> mimeType)

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

Use ImageUrlMessageContent(URI, ImageMessageContent.DetailLevel, Optional) instead.

ImageUrlMessageContent

@Deprecated(forRemoval=true)
public ImageUrlMessageContent(URL url,
 MessageContent.ImageMessageContent.DetailLevel detailLevel)

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

Use ImageUrlMessageContent(URI, ImageMessageContent.DetailLevel) instead.

ImageUrlMessageContent

public ImageUrlMessageContent(URI uri,
 MessageContent.ImageMessageContent.DetailLevel detailLevel,
 Optional<String> mimeType)

Creates an instance of a ImageUrlMessageContent record class.

Parameters:

uri - the value for the uri record component

detailLevel - the value for the detailLevel record component

mimeType - the value for the mimeType record component

Method Details

create

public static MessageContent.ImageUrlMessageContent create(ObjectStorage bucket,
 String key)

Creates image content referencing an object in a bucket via the object:// URI scheme.

Parameters:

bucket - the object-storage bucket

key - the object key within the bucket

url

@Deprecated(forRemoval=true)
public URL url()

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

Use uri() instead.

Returns the URI as a URL for backwards compatibility.

Throws:

RuntimeException - if the URI cannot be converted to a URL (e.g. for object:// URIs)

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.

uri

public URI uri()

Returns the value of the uri record component.

Returns:

the value of the uri record component

detailLevel

public MessageContent.ImageMessageContent.DetailLevel detailLevel()

Returns the value of the detailLevel record component.

Returns:

the value of the detailLevel record component

mimeType

public Optional<String> mimeType()

Returns the value of the mimeType record component.

Returns:

the value of the mimeType record component