Crop

Crop Item

class CropItem(server_response)

Result of a cropped document region.

Parameters:

server_response (dict[str, Any])

extract_from_input_source(input_source)

Apply the split range inference to a file and return a single extracted PDF.

Parameters:

input_source (LocalInputSource) – Local file to apply the inference to

Return type:

ExtractedImage

Returns:

Extracted PDF

extraction_response: ExtractionResponse | None = None

The extraction response associated with the crop.

location: FieldLocation

Location which includes cropping coordinates for the detected object, within the source document.

object_type: str

Type or classification of the detected object.

Crop Inference

class CropInference(raw_response)

Crop inference result.

Parameters:

raw_response (dict[str, Any])

file: InferenceFile

File info for the inference.

id: str

ID of the inference.

job: InferenceJob

Job the inference belongs to.

model: InferenceModel

Model info for the inference.

result: CropResult

Result of a crop inference.

Crop Response

class CropResponse(raw_response)

Represent a crop inference response from Mindee V2 API.

Parameters:

raw_response (dict[str, Any])

classmethod get_result_slug()

Getter for the inference slug.

Return type:

str

inference: CropInference

Inference object for crop inference.

property raw_http: str

Displays the result of the raw response as json string.

Crop Result

class CropResult(raw_response)

Crop result info.

Parameters:

raw_response (dict[str, Any])

extract_from_input_source(input_source)

Apply all the crops to a file and return a single extracted PDF.

Parameters:

input_source (LocalInputSource) – Input file

Return type:

CropFiles