Class FileObject.Purpose
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class FileObject.Purpose implements Enum
The intended purpose of the file. Supported values are
assistants
,assistants_output
,batch
,batch_output
,fine-tune
,fine-tune-results
andvision
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
FileObject.Purpose.Known
An enum containing Purpose's known values.
public enum
FileObject.Purpose.Value
An enum containing Purpose's known values, as well as an _UNKNOWN member.
An instance of Purpose can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static FileObject.Purpose
ASSISTANTS
public final static FileObject.Purpose
ASSISTANTS_OUTPUT
public final static FileObject.Purpose
BATCH
public final static FileObject.Purpose
BATCH_OUTPUT
public final static FileObject.Purpose
FINE_TUNE
public final static FileObject.Purpose
FINE_TUNE_RESULTS
public final static FileObject.Purpose
VISION
-
Method Summary
Modifier and Type Method Description final JsonField<String>
_value()
Returns this class instance's raw value. final FileObject.Purpose.Value
value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final FileObject.Purpose.Known
known()
Returns an enum member corresponding to this class instance's value. final String
asString()
Returns this class instance's primitive wire representation. final FileObject.Purpose
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static FileObject.Purpose
of(String value)
-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final FileObject.Purpose.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final FileObject.Purpose.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final FileObject.Purpose validate()
-
of
final static FileObject.Purpose of(String value)
-
-
-
-