Package io.openliberty.mcp.content

Record Class AudioContent

java.lang.Object

java.lang.Record

io.openliberty.mcp.content.AudioContent

Record Components:

data - a base64-encoded string representing the audio data (must not be null)

mimeType - the mime type of the audio (must not be null)

_meta - the optional metadata

All Implemented Interfaces:

Content

public record AudioContent(String data, String mimeType, Map<MetaKey,Object> _meta)
extends Record
implements Content

An audio content provided to or from an LLM.

Nested Class Summary

Nested classes/interfaces inherited from interface io.openliberty.mcp.content.Content

Content.Type

Constructor Summary

Constructors

Constructor	Description
AudioContent(String data, String mimeType)
AudioContent(String data, String mimeType, Map<MetaKey,Object> _meta)	Creates an instance of a AudioContent record class.

Method Summary

Modifier and Type	Method	Description
Map<MetaKey,Object>	_meta()	Returns the value of the _meta record component.
AudioContent	asAudio()	Casts and returns this object as an audio content, or throws an IllegalArgumentException if the content object does not represent a AudioContent.
String	data()	Returns the value of the data 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.
String	mimeType()	Returns the value of the mimeType record component.
final String	toString()	Returns a string representation of this record class.
Content.Type	type()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.openliberty.mcp.content.Content

asImage, asText, getType

Constructor Details

AudioContent

public AudioContent(String data,
 String mimeType)

AudioContent

public AudioContent(String data,
 String mimeType,
 Map<MetaKey,Object> _meta)

Creates an instance of a AudioContent record class.

Parameters:

data - the value for the data record component

mimeType - the value for the mimeType record component

_meta - the value for the _meta record component

Method Details

type

public Content.Type type()

Specified by:

type in interface Content

Returns:

the type of the content

asAudio

public AudioContent asAudio()

Description copied from interface: Content

Casts and returns this object as an audio content, or throws an IllegalArgumentException if the content object does not represent a AudioContent.

Specified by:

asAudio in interface Content

Returns:

the audio content

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 String data()

Returns the value of the data record component.

Returns:

the value of the data record component

mimeType

public String mimeType()

Returns the value of the mimeType record component.

Returns:

the value of the mimeType record component

_meta

public Map<MetaKey,Object> _meta()

Returns the value of the _meta record component.

Returns:

the value of the _meta record component