class Abbyy::Models::ProcessFieldsRequest

Overview

Request object for /processFields API-method.

Included Modules

Defined in:

abbyy/models/process_fields_request.cr

Constant Summary

DEFAULT_DESCRIPTION = ""
DEFAULT_WRITE_RECOGNITION_VARIANTS = false

Constructors

Instance Method Summary

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::TaskIdRequest

params : Hash(String, String) params, task_id : String | Nil task_id, task_id=(task_id : String | Nil) task_id=

Constructor methods inherited from class Abbyy::Models::TaskIdRequest

new(task_id : String | Nil = nil) new

Instance methods inherited from class Abbyy::Models::BaseRequest

body : HTTP::Client::BodyType body, params : Hash(String, String) params

Constructor Detail

def self.new(task_id : String, file_path : String, description : String | Nil = nil, write_recognition_variants : Bool | Nil = nil) #

[View source]

Instance Method Detail

def description : String | Nil #

Contains the description of the processing task. Cannot contain more than 255 characters.

This parameter is not required.


[View source]
def description=(description : String | Nil) #

[View source]
def params : Hash(String, String) #

[View source]
def set_description(description : String | Nil) #

[View source]
def task_id=(task_id : String | Nil) #

[View source]
def write_recognition_variants : Bool | Nil #

Specifies whether the recognition variants should be written to the result. It can have either true or false value.

If you set this value to true, additional recognition variants (charRecVariants) appear in the XML result file.

This parameter is not required.

Default value is false.


[View source]
def write_recognition_variants=(write_recognition_variants : Bool | Nil) #

Specifies whether the recognition variants should be written to the result. It can have either true or false value.

If you set this value to true, additional recognition variants (charRecVariants) appear in the XML result file.

This parameter is not required.

Default value is false.


[View source]