Hide properties
Hide properties
string
The type of response, will always be “batch_processor_run”.
string
The unique identifier for this batch processor run.
string
The ID of the processor used for this run.
string
The ID of the specific processor version used.
string
The name of the processor.
object
The metrics for the batch processor run.
Show properties
Show properties
number
The total number of files that were processed.
number
The total number of pages that were processed.
string
The type of batch processor run. Possible values are
EXTRACT, CLASSIFY, and SPLITTER.The sections below show the fields in this object that are present for each type of run.Show EXTRACT
Show EXTRACT
object
Record mapping field names to their respective metrics.
Show Field Metrics Structure
Show Field Metrics Structure
number
The mean confidence score for this field across all documents.
number
The recall percentage for this field, representing how many of the expected values were correctly extracted.
number
The precision percentage for this field, representing how many of the extracted values were correct.
object
For nested object fields, this contains metrics for the child fields. Has the same structure as the parent fieldMetrics.
object
Maps the root array field name to a number indicating how many times the array field has the correct number of rows extracted.
Show CLASSIFY
Show CLASSIFY
number
The overall accuracy percentage.
number
The mean confidence score.
object
Record mapping classification values to their counts.
object
Mapping from classification to accuracy percentage as calculated from the confusion matrix.
object
Mapping from actual class to predicted class to count. Only present when accuracy percentage is present.
Show SPLITTER
Show SPLITTER
number
Number of predicted subdocuments that are in the expected set of subdocuments divided by total number of predicted subdocuments.
number
Number of expected subdocuments that are in the predicted set of subdocuments divided by total number of expected subdocuments.
number
The number of expected documents.
number
The number of predicted documents.
number
The number of correctly predicted documents.
number
The mean runtime in milliseconds per document.
string
The current status of the batch processor run. Possible values are
PENDING,
PROCESSING, PROCESSED, FAILED.string
The source of the batch processor run.
Show possible values
Show possible values
The batch processor run was made from an evaluation set. In this case, the
sourceId will be the ID of the evaluation set, such as ev_1234.The batch processor run was made from the playground. The
sourceId will
not be set for this value.The batch processor run was made for a processor in Studio. The
sourceId will be the
ID of the processor, such as dp_1234.string
The ID of the source of the batch processor run. See the
source field for
more details.number
The number of runs that were made.
object
string
The date and time the batch processor run was created.
string
The date and time the batch processor run was last updated.
{
"object": "batch_processor_run",
"id": "bpr_1234",
"processorId": "dp_5678",
"processorVersionId": "dpv_91011",
"processorName": "Invoice Extractor",
"metrics": {
"numFiles": 10,
"numPages": 25,
"meanRunTimeMs": 1500,
"type": "EXTRACT",
"fieldMetrics": {
"invoice_number": {
"meanConfidence": 0.95,
"recallPerc": 98.5,
"precisionPerc": 99.2
},
"invoice_date": {
"meanConfidence": 0.92,
"recallPerc": 95.1,
"precisionPerc": 97.3
}
}
},
"status": "PROCESSED",
"source": "STUDIO",
"sourceId": "dp_5678",
"runCount": 1,
"options": {
"fuzzyMatchFields": ["invoice_number"],
"excludeFields": ["internal_notes"],
"clearPreProcessingCache": false
},
"createdAt": "2023-05-15T10:30:45Z",
"updatedAt": "2023-05-15T10:35:22Z"
}