BatchResponse

sttp.openai.requests.batch.BatchResponse
See theBatchResponse companion object
case class BatchResponse(id: String, `object`: String, endpoint: String, errors: Option[Errors], inputFileId: String, completionWindow: String, status: String, outputFileId: Option[String], errorFileId: Option[String], createdAt: Int, inProgressAt: Option[Int], expiresAt: Option[Int], finalizingAt: Option[Int], completedAt: Option[Int], failedAt: Option[Int], expiredAt: Option[Int], cancellingAt: Option[Int], cancelledAt: Option[Int], requestCounts: Option[RequestCounts], metadata: Option[Map[String, String]])

Value parameters

`object`

The object type, which is always batch.

cancelledAt

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

cancellingAt

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

completedAt

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

completionWindow

The time frame within which the batch should be processed.

createdAt

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

endpoint

The OpenAI API endpoint used by the batch.

errorFileId

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

errors

The errors object.

expiredAt

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

expiresAt

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

failedAt

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

finalizingAt

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

id

The ID of the batch.

inProgressAt

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

inputFileId

The ID of the input file for the batch.

metadata

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, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

outputFileId

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

requestCounts

The request counts for different statuses within the batch.

status

The current status of the batch.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product