Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionMessage.MediaContent

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent

Record Components:

type - Content type, each can be of type text or image_url.

text - The text content of the message.

imageUrl - The image content of the message. You can pass multiple images by adding multiple image_url content parts. Image input is only supported when using the gpt-4-visual-preview model.

inputAudio - Audio content part.

Enclosing class:

OpenAiApi.ChatCompletionMessage

public static record OpenAiApi.ChatCompletionMessage.MediaContent(String type, String text, OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl imageUrl, OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio inputAudio, OpenAiApi.ChatCompletionMessage.MediaContent.InputFile inputFile)
extends Record

An array of content parts with a defined type. Each MediaContent can be of either "text", "image_url", or "input_audio" type. Only one option allowed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl	Shortcut constructor for an image content.
static final record	OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio
static final record	OpenAiApi.ChatCompletionMessage.MediaContent.InputFile	Constructor for base64-encoded file

Constructor Summary

Constructors

Constructor	Description
MediaContent(String text)	Shortcut constructor for a text content.
MediaContent(String type, String text, OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl imageUrl, OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio inputAudio, OpenAiApi.ChatCompletionMessage.MediaContent.InputFile inputFile)	Creates an instance of a MediaContent record class.
MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl imageUrl)	Shortcut constructor for an image content.
MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio inputAudio)	Shortcut constructor for an audio content.
MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.InputFile inputFile)	Shortcut constructor for a file content

Method Summary

Modifier and Type	Method	Description
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.
OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl	imageUrl()	Returns the value of the imageUrl record component.
OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio	inputAudio()	Returns the value of the inputAudio record component.
OpenAiApi.ChatCompletionMessage.MediaContent.InputFile	inputFile()	Returns the value of the inputFile record component.
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

MediaContent

public MediaContent(String text)

Shortcut constructor for a text content.

Parameters:

text - The text content of the message.

MediaContent

public MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl imageUrl)

Shortcut constructor for an image content.

Parameters:

imageUrl - The image content of the message.

MediaContent

public MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio inputAudio)

Shortcut constructor for an audio content.

Parameters:

inputAudio - The audio content of the message.

MediaContent

public MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.InputFile inputFile)

Shortcut constructor for a file content

Parameters:

inputFile - The file content of the message.

MediaContent

public MediaContent(String type,
 String text,
 OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl imageUrl,
 OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio inputAudio,
 OpenAiApi.ChatCompletionMessage.MediaContent.InputFile inputFile)

Creates an instance of a MediaContent record class.

Parameters:

type - the value for the type record component

text - the value for the text record component

imageUrl - the value for the imageUrl record component

inputAudio - the value for the inputAudio record component

inputFile - the value for the inputFile 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.

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

imageUrl

public OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl imageUrl()

Returns the value of the imageUrl record component.

Returns:

the value of the imageUrl record component

inputAudio

public OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio inputAudio()

Returns the value of the inputAudio record component.

Returns:

the value of the inputAudio record component

inputFile

public OpenAiApi.ChatCompletionMessage.MediaContent.InputFile inputFile()

Returns the value of the inputFile record component.

Returns:

the value of the inputFile record component