PortableLib/ai.formx.mobile.sdk

Package-level declarations

Types

data class Error(val code: Int, val message: String, val info: Map<String, Any>?)

data class ExtractDocument(val type: String?, val typeConfidence: Double?, val boundingBox: List<Double>?, val extractorId: String, val metaData: ExtractDocumentMetaData, rawData: HashMap<String, JsonElement>, rawDetailedData: HashMap<String, List<JsonObject>>) : ExtractDocumentResult

ExtractDocument contains single document result returned by the FormXAPIClient.extract

ExtractDocumentError

data class ExtractDocumentError(val extractorId: String?, val metaData: ExtractDocumentMetaData, val error: Error) : ExtractDocumentResult

ExtractDocumentError contains error info for parsing document

ExtractDocumentMetaData

data class ExtractDocumentMetaData(val pageNo: List<Int>, val sliceNo: Int, val extractorType: String?)

ExtractDocumentMetaData contains document meta data returned by the FormXAPIClient.extract

ExtractDocumentResult

sealed class ExtractDocumentResult

ExtractMetaData

data class ExtractMetaData(val extractorId: String, val requestId: String, val usage: Int, val jobId: String?)

ExtractMetaData contains api meta data returned by the FormXAPIClient.extract

FormXAPIClient

class FormXAPIClient(accessToken: String, apiHost: String? = null)

FormXAPIClient is a network client to communicate with the FormX API

FormXAPIDetectDocumentsResponse

data class FormXAPIDetectDocumentsResponse(val documents: List<FormXAPIDocument>, val status: String)

FormXAPIDetectDocumentsResponse contains the response from FormXAPIClient.findDocuments API

FormXAPIDocument

data class FormXAPIDocument(val bbox: List<Int>, val type: String)

FormXAPIDocument contains a detected document region

FormXAPIExtractErrorException

class FormXAPIExtractErrorException(val response: FormXAPIExtractErrorResponse) : Exception

FormXAPIExtractErrorException is a exception class threw when calling FormXAPIClient.extract with error

FormXAPIExtractErrorField

data class FormXAPIExtractErrorField(val code: Int, val message: String)

FormXAPIExtractErrorField contains an error of FormXAPIClient.extract

FormXAPIExtractErrorResponse

data class FormXAPIExtractErrorResponse(val status: String, val error: FormXAPIExtractErrorField)

FormXAPIExtractErrorResponse contains the error response return by FormXAPIClient.extract API.

FormXAPIExtractResponse

data class FormXAPIExtractResponse(val status: String = "", val metaData: ExtractMetaData, val documents: List<ExtractDocumentResult>)

FormXAPIExtractResponse contains the response from FormXAPIClient.extract API.

FormXDataBoolListValue

data class FormXDataBoolListValue(val detailedData: JsonObject, val value: List<Boolean>) : FormXDataValue

FormXDataBoolValue

data class FormXDataBoolValue(val detailedData: JsonObject, val value: Boolean) : FormXDataValue

FormXDataMapListValue

data class FormXDataMapListValue(val detailedData: JsonObject, val value: List<Map<String, Any?>>) : FormXDataValue

FormXDataMapValue

data class FormXDataMapValue(val detailedData: JsonObject, val value: Map<String, Any?>) : FormXDataValue

FormXDataNumListValue

data class FormXDataNumListValue(val detailedData: JsonObject, val value: List<Number>) : FormXDataValue

FormXDataNumValue

data class FormXDataNumValue(val detailedData: JsonObject, val value: Number) : FormXDataValue

FormXDataProductListValue

data class FormXDataProductListValue(val detailedData: JsonObject, val value: List<FormXProductValue>) : FormXDataValue

FormXDataStringListValue

data class FormXDataStringListValue(val detailedData: JsonObject, val value: List<String>) : FormXDataValue

FormXDataStringValue

data class FormXDataStringValue(val detailedData: JsonObject, val value: String) : FormXDataValue

FormXDataUnknownValue

data class FormXDataUnknownValue(val detailedData: JsonObject, val value: Any) : FormXDataValue

FormXDataValue

sealed class FormXDataValue

FormXDataValue is the base class of available extraction value returned by the FormXAPIClient.extract.

FormXDocumentRegion

data class FormXDocumentRegion(val topLeft: FormXPointF, val topRight: FormXPointF, val bottomRight: FormXPointF, val bottomLeft: FormXPointF, val boundingBox: FormXRectF)

FormXDocumentRegion represents a region in the document.

FormXDocumentRegionFilter

interface FormXDocumentRegionFilter

A filter to filter out invalid FormXDocumentRegion

FormXDocumentRegionSizeFilter

class FormXDocumentRegionSizeFilter : FormXDocumentRegionFilter

Filter out FormXDocumentRegion with size smaller than the threshold

FormXLetterbox

data class FormXLetterbox(val sourceWidth: Int = 0, val sourceHeight: Int = 0, val targetWidth: Int = 0, val targetHeight: Int = 0, val scale: Float = 0.0f, val offsetX: Int = 0, val offsetY: Int = 0, val scaledWidth: Int = 0, val scaledHeight: Int = 0)

FormXLetterbox contains the information of how to letterbox a source image to a target image

FormXPointF

data class FormXPointF(val x: Float, val y: Float)

FormXPointF is a point in the coordinate system of the image

FormXProductValue

data class FormXProductValue(val amount: Double?, val discount: String?, val name: String?, val quantity: Int?, val sku: String?, val unitPrice: Double?)

FormXProductValue contains the purchase information of a receipt

FormXRectF