batch.md

Batch

Example Usage

import { Batch } from "argot-open-ai/models/components";

let value: Batch = {
  id: "<id>",
  object: "batch",
  endpoint: "<value>",
  inputFileId: "<id>",
  completionWindow: "<value>",
  status: "completed",
  createdAt: 304446,
};

Fields

Field	Type	Required	Description
id	string	✔️	N/A
object	components.BatchObject	✔️	The object type, which is always batch.
endpoint	string	✔️	The OpenAI API endpoint used by the batch.
errors	components.Errors	➖	N/A
inputFileId	string	✔️	The ID of the input file for the batch.
completionWindow	string	✔️	The time frame within which the batch should be processed.
status	components.BatchStatus	✔️	The current status of the batch.
outputFileId	string	➖	The ID of the file containing the outputs of successfully executed requests.
errorFileId	string	➖	The ID of the file containing the outputs of requests with errors.
createdAt	number	✔️	The Unix timestamp (in seconds) for when the batch was created.
inProgressAt	number	➖	The Unix timestamp (in seconds) for when the batch started processing.
expiresAt	number	➖	The Unix timestamp (in seconds) for when the batch will expire.
finalizingAt	number	➖	The Unix timestamp (in seconds) for when the batch started finalizing.
completedAt	number	➖	The Unix timestamp (in seconds) for when the batch was completed.
failedAt	number	➖	The Unix timestamp (in seconds) for when the batch failed.
expiredAt	number	➖	The Unix timestamp (in seconds) for when the batch expired.
cancellingAt	number	➖	The Unix timestamp (in seconds) for when the batch started cancelling.
cancelledAt	number	➖	The Unix timestamp (in seconds) for when the batch was cancelled.
requestCounts	components.RequestCounts	➖	The request counts for different statuses within the batch.
metadata	components.BatchMetadata	➖	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.