Package com.azure.ai.openai.assistants.models

Class FilePurpose

java.lang.Object

com.azure.core.util.ExpandableStringEnum<FilePurpose>

com.azure.ai.openai.assistants.models.FilePurpose

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class FilePurpose
extends com.azure.core.util.ExpandableStringEnum<FilePurpose>

The possible values denoting the intended usage of a file.

Field Summary

Fields

Modifier and Type	Field	Description
static final FilePurpose	ASSISTANTS	Indicates a file is used as input to assistants.
static final FilePurpose	ASSISTANTS_OUTPUT	Indicates a file is used as output by assistants.
static final FilePurpose	BATCH	Indicates a file is used as input to .
static final FilePurpose	BATCH_OUTPUT	Indicates a file is used as output by a vector store batch operation.
static final FilePurpose	FINE_TUNE	Indicates a file is used for fine tuning input.
static final FilePurpose	FINE_TUNE_RESULTS	Indicates a file is used for fine tuning results.
static final FilePurpose	VISION	Indicates a file is used as input to a vision operation.

Constructor Summary

Constructors

Constructor	Description
FilePurpose()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static FilePurpose	fromString(String name)	Creates or finds a FilePurpose from its string representation.
static Collection<FilePurpose>	values()	Gets known FilePurpose values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

FINE_TUNE

public static final FilePurpose FINE_TUNE

Indicates a file is used for fine tuning input.

FINE_TUNE_RESULTS

public static final FilePurpose FINE_TUNE_RESULTS

Indicates a file is used for fine tuning results.

ASSISTANTS

public static final FilePurpose ASSISTANTS

Indicates a file is used as input to assistants.

ASSISTANTS_OUTPUT

public static final FilePurpose ASSISTANTS_OUTPUT

Indicates a file is used as output by assistants.

BATCH

public static final FilePurpose BATCH

Indicates a file is used as input to .

BATCH_OUTPUT

public static final FilePurpose BATCH_OUTPUT

Indicates a file is used as output by a vector store batch operation.

VISION

public static final FilePurpose VISION

Indicates a file is used as input to a vision operation.

Constructor Details

FilePurpose

@Deprecated
public FilePurpose()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of FilePurpose value.

Method Details

fromString

public static FilePurpose fromString(String name)

Creates or finds a FilePurpose from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding FilePurpose.

values

public static Collection<FilePurpose> values()

Gets known FilePurpose values.

Returns:

known FilePurpose values.