API Documentation
Workflow Endpoints
Processor Endpoints
Parse Endpoints
Evaluation Set Endpoints
Objects
Webhooks
The ProcessorVersion object
{
"object": "document_processor_version",
"id": "processor_version_5678",
"processorId": "processor_1234",
"processorName": "Invoice Processor",
"processorType": "EXTRACT",
"description": "Updated extraction rules for invoice processing",
"version": "1.2.0",
"config": { // Changes based on processor type
"schema": {
"type": "object",
"properties": {
"invoice_number": {
"type": ["string", "null"],
"description": "The unique identifier for this invoice"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": ["number", "null"]
},
"iso_4217_currency_code": {
"type": ["string", "null"]
}
},
"required": ["value", "iso_4217_currency_code"],
"additionalProperties": false
}
},
"required": ["invoice_number", "amount"],
"additionalProperties": false
}
},
"createdAt": "2024-02-15T10:30:00Z",
"updatedAt": "2024-02-15T10:30:00Z"
}
The ProcessorVersion object represents a specific version of a document processor in Extend. It contains detailed information about a particular iteration of a processor, including its processor configuration and version string.
The versions are semantic versions supporting only major/minor, and if no published versions exist, there is always a draft
version.
The type of the object, in this case it will always be “document_processor_version”.
The unique identifier for this version of the document processor.
The ID of the parent document processor.
The name of the parent document processor.
The type of the document processor. This field specifies the category or
functionality of the processor. Either EXTRACT
, CLASSIFY
, SPLITTER
, or
INSTRUCT_QA
.
An optional description of this version of the document processor.
The version number or identifier for this specific version of the document processor. The draft version will have version=“draft”.
The configuration settings for this version of the document processor. The structure of this object will vary depending on the processor type.
See the Processor Configs guide for more details on the configuration settings for each processor type.
The date and time when this version of the document processor was created, in ISO 8601 format.
The date and time when this version of the document processor was last updated, in ISO 8601 format.
{
"object": "document_processor_version",
"id": "processor_version_5678",
"processorId": "processor_1234",
"processorName": "Invoice Processor",
"processorType": "EXTRACT",
"description": "Updated extraction rules for invoice processing",
"version": "1.2.0",
"config": { // Changes based on processor type
"schema": {
"type": "object",
"properties": {
"invoice_number": {
"type": ["string", "null"],
"description": "The unique identifier for this invoice"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": ["number", "null"]
},
"iso_4217_currency_code": {
"type": ["string", "null"]
}
},
"required": ["value", "iso_4217_currency_code"],
"additionalProperties": false
}
},
"required": ["invoice_number", "amount"],
"additionalProperties": false
}
},
"createdAt": "2024-02-15T10:30:00Z",
"updatedAt": "2024-02-15T10:30:00Z"
}
{
"object": "document_processor_version",
"id": "processor_version_5678",
"processorId": "processor_1234",
"processorName": "Invoice Processor",
"processorType": "EXTRACT",
"description": "Updated extraction rules for invoice processing",
"version": "1.2.0",
"config": { // Changes based on processor type
"schema": {
"type": "object",
"properties": {
"invoice_number": {
"type": ["string", "null"],
"description": "The unique identifier for this invoice"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": ["number", "null"]
},
"iso_4217_currency_code": {
"type": ["string", "null"]
}
},
"required": ["value", "iso_4217_currency_code"],
"additionalProperties": false
}
},
"required": ["invoice_number", "amount"],
"additionalProperties": false
}
},
"createdAt": "2024-02-15T10:30:00Z",
"updatedAt": "2024-02-15T10:30:00Z"
}