BatchJob
A batch job submitted for asynchronous processing
Operations
- GetCompleted
- GetCompletedAt
- GetCreatedAt
- GetEndpoint
- GetErrorFileId
- GetFailed
- GetId
- GetInputFileId
- GetOutputFileId
- GetStatus
- GetTotal
- IsComplete
GetCompleted
method : public : GetCompleted() ~ IntReturn
| Type | Description |
|---|---|
| Int | number of successfully completed requests |
GetCompletedAt
method : public : GetCompletedAt() ~ IntReturn
| Type | Description |
|---|---|
| Int | Unix timestamp when the batch completed |
GetCreatedAt
method : public : GetCreatedAt() ~ IntReturn
| Type | Description |
|---|---|
| Int | Unix timestamp when the batch was created |
GetEndpoint
method : public : GetEndpoint() ~ StringReturn
| Type | Description |
|---|---|
| String | API endpoint this batch targets |
GetErrorFileId
method : public : GetErrorFileId() ~ StringReturn
| Type | Description |
|---|---|
| String | ID of the error file (available when completed) |
GetInputFileId
method : public : GetInputFileId() ~ StringReturn
| Type | Description |
|---|---|
| String | ID of the uploaded input .jsonl file |
GetOutputFileId
method : public : GetOutputFileId() ~ StringReturn
| Type | Description |
|---|---|
| String | ID of the output file (available when completed) |
GetStatus
method : public : GetStatus() ~ StringReturn
| Type | Description |
|---|---|
| String | status: 'validating', 'in_progress', 'completed', 'failed', 'cancelled' |
GetTotal
method : public : GetTotal() ~ IntReturn
| Type | Description |
|---|---|
| Int | total number of requests in the batch |
IsComplete
method : public : IsComplete() ~ BoolReturn
| Type | Description |
|---|---|
| Bool | true if the batch has finished processing |