Record Class OpenAiFileApi.UploadFileRequest

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiFileApi.UploadFileRequest

Enclosing class:

OpenAiFileApi

public static record OpenAiFileApi.UploadFileRequest(byte[] file, String fileName, String purpose)
extends Record

Author:

Sun Yuhan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiFileApi.UploadFileRequest.Builder

Constructor Summary

Constructors

Constructor	Description
UploadFileRequest(byte[] file, String fileName, String purpose)	Creates an instance of a UploadFileRequest record class.

Method Summary

Modifier and Type	Method	Description
static OpenAiFileApi.UploadFileRequest.Builder	builder()
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
byte[]	file()	Returns the value of the file record component.
String	fileName()	Returns the value of the fileName record component.
int	hashCode()	Returns a hash code value for this object.
String	purpose()	Returns the value of the purpose record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

UploadFileRequest

public UploadFileRequest(byte[] file,
 String fileName,
 String purpose)

Creates an instance of a UploadFileRequest record class.

Parameters:

file - the value for the file record component

fileName - the value for the fileName record component

purpose - the value for the purpose record component

Method Details

builder

public static OpenAiFileApi.UploadFileRequest.Builder builder()

equals

public 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.

hashCode

public 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

toString

public 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

file

public byte[] file()

Returns the value of the file record component.

Returns:

the value of the file record component

fileName

public String fileName()

Returns the value of the fileName record component.

Returns:

the value of the fileName record component

purpose

public String purpose()

Returns the value of the purpose record component.

Returns:

the value of the purpose record component