Package org.springframework.ai.openai.api

Enum Class OpenAiFileApi.Purpose

java.lang.Object

java.lang.Enum<OpenAiFileApi.Purpose>

org.springframework.ai.openai.api.OpenAiFileApi.Purpose

All Implemented Interfaces:

Serializable, Comparable<OpenAiFileApi.Purpose>, Constable

Enclosing class:

OpenAiFileApi

public static enum OpenAiFileApi.Purpose
extends Enum<OpenAiFileApi.Purpose>

The intended purpose of the uploaded file

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSISTANTS	Used in the Assistants API
BATCH	Used in the Batch API
EVALS	Used for eval data sets
FINE_TUNE	Used for fine-tuning
USER_DATA	Flexible file type for any purpose
VISION	Images used for vision fine-tuning

Method Summary

Modifier and Type	Method	Description
String	getValue()
static OpenAiFileApi.Purpose	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAiFileApi.Purpose[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASSISTANTS

public static final OpenAiFileApi.Purpose ASSISTANTS

Used in the Assistants API

BATCH

public static final OpenAiFileApi.Purpose BATCH

Used in the Batch API

FINE_TUNE

public static final OpenAiFileApi.Purpose FINE_TUNE

Used for fine-tuning

VISION

public static final OpenAiFileApi.Purpose VISION

Images used for vision fine-tuning

USER_DATA

public static final OpenAiFileApi.Purpose USER_DATA

Flexible file type for any purpose

EVALS

public static final OpenAiFileApi.Purpose EVALS

Used for eval data sets

Method Details

values

public static OpenAiFileApi.Purpose[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OpenAiFileApi.Purpose valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()