Package bg.codexio.ai.openai.api.sdk.message

Record Class MessageResult

java.lang.Object

java.lang.Record

bg.codexio.ai.openai.api.sdk.message.MessageResult

public record MessageResult(String message, FileResult.Builder fileResult, String imageFileId)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MessageResult.Builder

Constructor Summary

Constructors

Constructor	Description
MessageResult(String message, FileResult.Builder fileResult, String imageFileId)	Creates an instance of a MessageResult record class.

Method Summary

Modifier and Type	Method	Description
static MessageResult.Builder	builder()
String	download(File targetFolder)
String	download(File targetFolder, RetrieveFileContentHttpExecutor httpExecutor)
String	download(File targetFolder, HttpExecutorContext context)
String	download(File targetFolder, SdkAuth auth)
static MessageResult	empty()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FileResult	file()
FileResult.Builder	fileResult()	Returns the value of the fileResult record component.
final int	hashCode()	Returns a hash code value for this object.
String	imageFileId()	Returns the value of the imageFileId record component.
String	message()	Returns the value of the message 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

MessageResult

public MessageResult(String message,
 FileResult.Builder fileResult,
 String imageFileId)

Creates an instance of a MessageResult record class.

Parameters:

message - the value for the message record component

fileResult - the value for the fileResult record component

imageFileId - the value for the imageFileId record component

Method Details

empty

public static MessageResult empty()

builder

public static MessageResult.Builder builder()

file

public FileResult file()

download

public String download(File targetFolder)
                throws IOException

Throws:

IOException

download

public String download(File targetFolder,
 SdkAuth auth)
                throws IOException

Throws:

IOException

download

public String download(File targetFolder,
 HttpExecutorContext context)
                throws IOException

Throws:

IOException

download

public String download(File targetFolder,
 RetrieveFileContentHttpExecutor httpExecutor)
                throws IOException

Throws:

IOException

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.

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

fileResult

public FileResult.Builder fileResult()

Returns the value of the fileResult record component.

Returns:

the value of the fileResult record component

imageFileId

public String imageFileId()

Returns the value of the imageFileId record component.

Returns:

the value of the imageFileId record component