class Abbyy::Models::ProcessBusinessCardRequest
- Abbyy::Models::ProcessBusinessCardRequest
- Abbyy::Models::BaseRequest
- Abbyy::Models::BaseModel
- Reference
- Object
Overview
Request object for /processBusinessCard API-method.
Included Modules
Defined in:
abbyy/models/process_business_card_request.crConstant Summary
-
ALLOWED_EXPORT_FORMATS =
[ExportFormat::V_Card, ExportFormat::Csv, ExportFormat::Xml] -
DEFAULT_CORRECT_ORIENTATION =
true -
DEFAULT_CORRENT_SKEW =
true -
DEFAULT_DESCRITION =
"" -
DEFAULT_EXPORT_FORMAT =
ExportFormat::V_Card -
DEFAULT_IMAGE_SOURCE =
ImageSource::Auto -
DEFAULT_LANGUAGE =
Language::English -
DEFAULT_PDF_PASSWORD =
"" -
DEFAULT_PXML_WRITE_FIELD_COMPONENTS =
false -
DEFAULT_XML_WRITE_EXTENDED_CHARACTER_INFO =
false
Constructors
Instance Method Summary
-
#correct_orientation : Bool | Nil
Specifies whether the orientation of the image should be automatically detected and corrected.
-
#correct_orientation=(correct_orientation : Bool | Nil)
Specifies whether the orientation of the image should be automatically detected and corrected.
-
#correct_skew : Bool | Nil
Specifies whether the skew of the image should be automatically detected and corrected.
-
#correct_skew=(correct_skew : Bool | Nil)
Specifies whether the skew of the image should be automatically detected and corrected.
-
#description : String | Nil
Contains the description of the processing task.
- #description=(description : String | Nil)
-
#export_format : ExportFormat | Nil
Specifies the export format.
- #export_format=(export_format : ExportFormat | Array(ExportFormat) | Nil)
-
#image_source : ImageSource | Nil
Specifies the source of the image.
-
#image_source=(image_source : ImageSource | Nil)
Specifies the source of the image.
-
#language : Language | Array(Language) | Nil
Specifies recognition language of the document.
-
#language=(language : Language | Array(Language) | Nil)
Specifies recognition language of the document.
- #params : Hash(String, String)
-
#pdf_password : String | Nil
Contains a password for accessing password-protected images in PDF format.
-
#pdf_password=(pdf_password : String | Nil)
Contains a password for accessing password-protected images in PDF format.
-
#pdf_write_field_components : Bool | Nil
Specifies whether the field components should be written to an output file in XML format.
-
#pdf_write_field_components=(pdf_write_field_components : Bool | Nil)
Specifies whether the field components should be written to an output file in XML format.
-
#xml_write_extended_character_info : Bool | Nil
Specifies whether the additional information on the recognized characters (e.g.
-
#xml_write_extended_character_info=(xml_write_extended_character_info : Bool | Nil)
Specifies whether the additional information on the recognized characters (e.g.
Instance methods inherited from module Abbyy::Models::FileBody
body : HTTP::Client::BodyType
body,
file_path : String
file_path,
file_path=(file_path : String)
file_path=
Constructor methods inherited from module Abbyy::Models::FileBody
new(file_path : String)
new
Instance methods inherited from class Abbyy::Models::BaseRequest
body : HTTP::Client::BodyType
body,
params : Hash(String, String)
params
Constructor Detail
Instance Method Detail
Specifies whether the orientation of the image should be automatically detected and corrected. It can have one of the following values:
- true The page orientation is automatically detected, and if it differs from normal the image is rotated.
- false The page orientation detection and correction is not performed.
This parameter is not required.
Default value is true.
Specifies whether the orientation of the image should be automatically detected and corrected. It can have one of the following values:
- true The page orientation is automatically detected, and if it differs from normal the image is rotated.
- false The page orientation detection and correction is not performed.
This parameter is not required.
Default value is true.
Specifies whether the skew of the image should be automatically detected and corrected. It can have either true or false value.
This parameter is not required.
Default value is true.
Specifies whether the skew of the image should be automatically detected and corrected. It can have either true or false value.
This parameter is not required.
Default value is true.
Contains the description of the processing task. Cannot contain more than 255 characters.
This parameter is not required.
Specifies the export format. It can be one of the following:
This parameter is not required.
Default value is ExportFormat::Xml.
Specifies the source of the image. It can be either a scanned image, or a photograph created with a digital camera. Special preprocessing operations can be performed with the image depending on the selected source. For example, the system can automatically correct distorted text lines, poor focus and lighting on photos.
The value of this parameter can be one of the following:
ImageSource::AutoThe image source is detected automatically.ImageSource::PhotoImageSource::Scanner
This parameter is not required.
Default value is ImageSource::Auto.
Specifies the source of the image. It can be either a scanned image, or a photograph created with a digital camera. Special preprocessing operations can be performed with the image depending on the selected source. For example, the system can automatically correct distorted text lines, poor focus and lighting on photos.
The value of this parameter can be one of the following:
ImageSource::AutoThe image source is detected automatically.ImageSource::PhotoImageSource::Scanner
This parameter is not required.
Default value is ImageSource::Auto.
Specifies recognition language of the document. This parameter can contain one language or several languages in an array, for example:
request.language = Language::Spanish
# or
request.language = [
Language::English,
Language::French,
Language::German,
]See the list of available recognition languages.
This parameter is not required.
Default value is Language::English.
Specifies recognition language of the document. This parameter can contain one language or several languages in an array, for example:
request.language = Language::Spanish
# or
request.language = [
Language::English,
Language::French,
Language::German,
]See the list of available recognition languages.
This parameter is not required.
Default value is Language::English.
Contains a password for accessing password-protected images in PDF format.
Contains a password for accessing password-protected images in PDF format.
Specifies whether the field components should be written to an output file in XML format. For example, for the Name field the components can include first name and last name, returned separately.
This parameter can be used only if the #export_format parameter is set
to xml. The parameter can have one of the following values:
- true
- false
This parameter is not required.
Default value is false.
Specifies whether the field components should be written to an output file in XML format. For example, for the Name field the components can include first name and last name, returned separately.
This parameter can be used only if the #export_format parameter is set
to xml. The parameter can have one of the following values:
- true
- false
This parameter is not required.
Default value is false.
Specifies whether the additional information on the recognized characters
(e.g. whether the character is recognized uncertainly) should be written
to an output file in XML format. This parameter can be used only if the
#export_format parameter is set to xml.
The parameter can have one of the following values:
- true
- false
This parameter is not required.
Default value is false.
Specifies whether the additional information on the recognized characters
(e.g. whether the character is recognized uncertainly) should be written
to an output file in XML format. This parameter can be used only if the
#export_format parameter is set to xml.
The parameter can have one of the following values:
- true
- false
This parameter is not required.
Default value is false.