Package com.azure.ai.openai.models

Class BatchStatus

java.lang.Object
com.azure.core.util.ExpandableStringEnum<BatchStatus>
com.azure.ai.openai.models.BatchStatus
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class BatchStatus extends com.azure.core.util.ExpandableStringEnum<BatchStatus>
The status of a batch.

  • Field Details

    • VALIDATING

      public static final BatchStatus VALIDATING
      The input file is being validated before the batch can begin.

    • FAILED

      public static final BatchStatus FAILED
      The input file has failed the validation process.

    • IN_PROGRESS

      public static final BatchStatus IN_PROGRESS
      The input file was successfully validated and the batch is currently being executed.

    • FINALIZING

      public static final BatchStatus FINALIZING
      The batch has completed and the results are being prepared.

    • COMPLETED

      public static final BatchStatus COMPLETED
      The batch has been completed and the results are ready.

    • EXPIRED

      public static final BatchStatus EXPIRED
      The batch was not able to complete within the 24-hour time window.

    • CANCELLING

      public static final BatchStatus CANCELLING
      Cancellation of the batch has been initiated.

    • CANCELLED

      public static final BatchStatus CANCELLED
      The batch was cancelled.

  • Constructor Details

    • BatchStatus

      @Deprecated public BatchStatus()
      Deprecated.
      Use the fromString(String) factory method.
      Creates a new instance of BatchStatus value.

  • Method Details

    • fromString

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

    • values

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