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

Class FileState

java.lang.Object
com.azure.core.util.ExpandableStringEnum<FileState>
com.azure.ai.openai.assistants.models.FileState
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class FileState extends com.azure.core.util.ExpandableStringEnum<FileState>
The state of the file.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final FileState
    DELETED
    The entity has been deleted but may still be referenced by other entities predating the deletion.
    static final FileState
    DELETING
    The entity is in the process to be deleted.
    static final FileState
    ERROR
    The operation has completed processing with a failure and cannot be further consumed.
    static final FileState
    PENDING
    The operation was created and is not queued to be processed in the future.
    static final FileState
    PROCESSED
    The operation has successfully processed and is ready for consumption.
    static final FileState
    RUNNING
    The operation has started to be processed.
    static final FileState
    UPLOADED
    The file has been uploaded but it's not yet processed.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static FileState
    fromString(String name)
    Creates or finds a FileState from its string representation.
    static Collection<FileState>
    values()
    Gets known FileState 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

    • UPLOADED

      public static final FileState UPLOADED
      The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state.

    • PENDING

      public static final FileState PENDING
      The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state.

    • RUNNING

      public static final FileState RUNNING
      The operation has started to be processed. It can be categorized as an active state.

    • PROCESSED

      public static final FileState PROCESSED
      The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state.

    • ERROR

      public static final FileState ERROR
      The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state.

    • DELETING

      public static final FileState DELETING
      The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state.

    • DELETED

      public static final FileState DELETED
      The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state.

  • Constructor Details

  • Method Details

    • fromString

      public static FileState fromString(String name)
      Creates or finds a FileState from its string representation.
      Parameters:
      name - a name to look for.
      Returns:
      the corresponding FileState.

    • values

      public static Collection<FileState> values()
      Gets known FileState values.
      Returns:
      known FileState values.