FilePurpose Class

Package:

com.azure.ai.openai.models

Maven Artifact:

com.azure:azure-ai-openai:1.0.0-beta.12

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.openai.models.FilePurpose

public final class FilePurpose
extends ExpandableStringEnum<FilePurpose>

The possible values denoting the intended usage of a file.

Field Summary

Modifier and Type	Field and 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

Constructor	Description
FilePurpose()	Deprecated Use the fromString(String name) factory method. Creates a new instance of FilePurpose value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

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.

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.

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 name) 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 values()

Gets known FilePurpose values.

Returns:

known FilePurpose values.