AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class Batch

    Inheritance
    object
    ModelResponse
    Batch
    Inherited Members
    ModelResponse.Id
    ModelResponse.Object
    ModelResponse.Model
    ModelResponse.CreatedAt
    ModelResponse.Metadata
    ModelResponse.Usage
    Namespace: Glitch9.AIDevKit.OpenAI
    Assembly: .dll
    Syntax
    public class Batch : ModelResponse

    Properties

    CancelledAt

    The Unix timestamp (in seconds) for when the batch was cancelled.

    Declaration
    public UnixTime? CancelledAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    CancellingAt

    The Unix timestamp (in seconds) for when the batch started cancelling.

    Declaration
    public UnixTime? CancellingAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    CompletedAt

    The Unix timestamp (in seconds) for when the batch was completed.

    Declaration
    public UnixTime? CompletedAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    CompletionWindow

    The time frame within which the batch should be processed.

    Declaration
    public string CompletionWindow { get; set; }
    Property Value
    Type Description
    string

    Endpoint

    The OpenAI API endpoint used by the batch.

    Declaration
    public string Endpoint { get; set; }
    Property Value
    Type Description
    string

    ErrorFileId

    The ID of the file containing the outputs of requests with errors.

    Declaration
    public string ErrorFileId { get; set; }
    Property Value
    Type Description
    string

    Errors

    The errors that occurred during the batch.

    Declaration
    public BatchErrors Errors { get; set; }
    Property Value
    Type Description
    BatchErrors

    ExpiredAt

    The Unix timestamp (in seconds) for when the batch expired.

    Declaration
    public UnixTime? ExpiredAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    ExpiresAt

    The Unix timestamp (in seconds) for when the batch started processing.

    Declaration
    public UnixTime? ExpiresAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    FailedAt

    The Unix timestamp (in seconds) for when the batch failed.

    Declaration
    public UnixTime? FailedAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    FinalizingAt

    The Unix timestamp (in seconds) for when the batch started finalizing.

    Declaration
    public UnixTime? FinalizingAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    InProgressAt

    The Unix timestamp (in seconds) for when the batch was created.

    Declaration
    public UnixTime? InProgressAt { get; set; }
    Property Value
    Type Description
    UnixTime?

    InputFileId

    The ID of the input file for the batch.

    Declaration
    public string InputFileId { get; set; }
    Property Value
    Type Description
    string

    OutputFileId

    The ID of the file containing the outputs of successfully executed requests.

    Declaration
    public string OutputFileId { get; set; }
    Property Value
    Type Description
    string

    RequestCounts

    The request counts for different statuses within the batch.

    Declaration
    public RequestCounts RequestCounts { get; set; }
    Property Value
    Type Description
    RequestCounts

    Status

    The current status of the batch.

    Declaration
    public string Status { get; set; }
    Property Value
    Type Description
    string
    In this article
    Back to top Generated by DocFX