Search Results for

    Show / Hide Table of Contents

    Class Batch

    Inheritance
    object
    OpenAIObject
    Batch
    Inherited Members
    OpenAIObject.Id
    OpenAIObject.Object
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Glitch9.AIDevKit.OpenAI
    Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll
    Syntax
    public class Batch : OpenAIObject

    Properties

    | Edit this page View Source

    CancelledAt

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

    Declaration
    [JsonProperty("cancelled_at")]
    public UnixTime? CancelledAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    CancellingAt

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

    Declaration
    [JsonProperty("cancelling_at")]
    public UnixTime? CancellingAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    CompletedAt

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

    Declaration
    [JsonProperty("completed_at")]
    public UnixTime? CompletedAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    CompletionWindow

    The time frame within which the batch should be processed.

    Declaration
    [JsonProperty("completion_window")]
    public string CompletionWindow { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Endpoint

    The OpenAI API endpoint used by the batch.

    Declaration
    [JsonProperty("endpoint")]
    public string Endpoint { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    ErrorFileId

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

    Declaration
    [JsonProperty("error_file_id")]
    public string ErrorFileId { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Errors

    The errors that occurred during the batch.

    Declaration
    [JsonProperty("errors")]
    public BatchErrors Errors { get; set; }
    Property Value
    Type Description
    BatchErrors
    | Edit this page View Source

    ExpiredAt

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

    Declaration
    [JsonProperty("expired_at")]
    public UnixTime? ExpiredAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    ExpiresAt

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

    Declaration
    [JsonProperty("expires_at")]
    public UnixTime? ExpiresAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    FailedAt

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

    Declaration
    [JsonProperty("failed_at")]
    public UnixTime? FailedAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    FinalizingAt

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

    Declaration
    [JsonProperty("finalizing_at")]
    public UnixTime? FinalizingAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    InProgressAt

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

    Declaration
    [JsonProperty("in_progress_at")]
    public UnixTime? InProgressAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    InputFileId

    The ID of the input file for the batch.

    Declaration
    [JsonProperty("input_file_id")]
    public string InputFileId { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    OutputFileId

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

    Declaration
    [JsonProperty("output_file_id")]
    public string OutputFileId { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    RequestCounts

    The request counts for different statuses within the batch.

    Declaration
    [JsonProperty("request_counts")]
    public RequestCounts RequestCounts { get; set; }
    Property Value
    Type Description
    RequestCounts
    | Edit this page View Source

    Status

    The current status of the batch.

    Declaration
    [JsonProperty("status")]
    public string Status { get; set; }
    Property Value
    Type Description
    string

    Extension Methods

    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    ResponseCastingExtensions.GetResult<T>(T)
    SystemExtensions.GetName(object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation