azure_cognitiveservices_formrecognizer 0.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE.txt +21 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer.rb +43 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/form_recognizer_client.rb +734 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/analyze_result.rb +91 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/error_information.rb +70 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/error_response.rb +48 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_key_value_pair.rb +78 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_page.rb +122 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_table.rb +68 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_table_column.rb +87 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_token.rb +81 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/form_document_report.rb +89 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/form_operation_error.rb +46 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/inner_error.rb +47 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/keys_result.rb +64 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/model_result.rb +80 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/models_result.rb +55 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/train_request.rb +50 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/train_result.rb +89 -0
- data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/module_definition.rb +9 -0
- data/lib/azure_cognitiveservices_formrecognizer.rb +6 -0
- data/lib/module_definition.rb +7 -0
- data/lib/profiles/latest/formrecognizer_latest_profile_client.rb +38 -0
- data/lib/profiles/latest/formrecognizer_module_definition.rb +8 -0
- data/lib/profiles/latest/modules/formrecognizer_profile_module.rb +121 -0
- data/lib/version.rb +7 -0
- metadata +143 -0
@@ -0,0 +1,87 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Code generated by Microsoft (R) AutoRest Code Generator.
|
3
|
+
# Changes may cause incorrect behavior and will be lost if the code is
|
4
|
+
# regenerated.
|
5
|
+
|
6
|
+
module Azure::CognitiveServices::FormRecognizer::V1_0_preview
|
7
|
+
module Models
|
8
|
+
#
|
9
|
+
# Extraction information of a column in
|
10
|
+
# a table.
|
11
|
+
#
|
12
|
+
class ExtractedTableColumn
|
13
|
+
|
14
|
+
include MsRestAzure
|
15
|
+
|
16
|
+
# @return [Array<ExtractedToken>] List of extracted tokens for the column
|
17
|
+
# header.
|
18
|
+
attr_accessor :header
|
19
|
+
|
20
|
+
# @return [Array<Array<ExtractedToken>>] Extracted text for each cell of
|
21
|
+
# a column. Each cell
|
22
|
+
# in the column can have a list of one or more tokens.
|
23
|
+
attr_accessor :entries
|
24
|
+
|
25
|
+
|
26
|
+
#
|
27
|
+
# Mapper for ExtractedTableColumn class as Ruby Hash.
|
28
|
+
# This will be used for serialization/deserialization.
|
29
|
+
#
|
30
|
+
def self.mapper()
|
31
|
+
{
|
32
|
+
client_side_validation: true,
|
33
|
+
required: false,
|
34
|
+
serialized_name: 'ExtractedTableColumn',
|
35
|
+
type: {
|
36
|
+
name: 'Composite',
|
37
|
+
class_name: 'ExtractedTableColumn',
|
38
|
+
model_properties: {
|
39
|
+
header: {
|
40
|
+
client_side_validation: true,
|
41
|
+
required: false,
|
42
|
+
serialized_name: 'header',
|
43
|
+
type: {
|
44
|
+
name: 'Sequence',
|
45
|
+
element: {
|
46
|
+
client_side_validation: true,
|
47
|
+
required: false,
|
48
|
+
serialized_name: 'ExtractedTokenElementType',
|
49
|
+
type: {
|
50
|
+
name: 'Composite',
|
51
|
+
class_name: 'ExtractedToken'
|
52
|
+
}
|
53
|
+
}
|
54
|
+
}
|
55
|
+
},
|
56
|
+
entries: {
|
57
|
+
client_side_validation: true,
|
58
|
+
required: false,
|
59
|
+
serialized_name: 'entries',
|
60
|
+
type: {
|
61
|
+
name: 'Sequence',
|
62
|
+
element: {
|
63
|
+
client_side_validation: true,
|
64
|
+
required: false,
|
65
|
+
serialized_name: 'ArrayElementType',
|
66
|
+
type: {
|
67
|
+
name: 'Sequence',
|
68
|
+
element: {
|
69
|
+
client_side_validation: true,
|
70
|
+
required: false,
|
71
|
+
serialized_name: 'ExtractedTokenElementType',
|
72
|
+
type: {
|
73
|
+
name: 'Composite',
|
74
|
+
class_name: 'ExtractedToken'
|
75
|
+
}
|
76
|
+
}
|
77
|
+
}
|
78
|
+
}
|
79
|
+
}
|
80
|
+
}
|
81
|
+
}
|
82
|
+
}
|
83
|
+
}
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_token.rb
ADDED
@@ -0,0 +1,81 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Code generated by Microsoft (R) AutoRest Code Generator.
|
3
|
+
# Changes may cause incorrect behavior and will be lost if the code is
|
4
|
+
# regenerated.
|
5
|
+
|
6
|
+
module Azure::CognitiveServices::FormRecognizer::V1_0_preview
|
7
|
+
module Models
|
8
|
+
#
|
9
|
+
# Canonical representation of single extracted text.
|
10
|
+
#
|
11
|
+
class ExtractedToken
|
12
|
+
|
13
|
+
include MsRestAzure
|
14
|
+
|
15
|
+
# @return [String] String value of the extracted text.
|
16
|
+
attr_accessor :text
|
17
|
+
|
18
|
+
# @return [Array<Float>] Bounding box of the extracted text. Represents
|
19
|
+
# the
|
20
|
+
# location of the extracted text as a pair of
|
21
|
+
# cartesian co-ordinates. The co-ordinate pairs are arranged by
|
22
|
+
# top-left, top-right, bottom-right and bottom-left endpoints box
|
23
|
+
# with origin reference from the bottom-left of the page.
|
24
|
+
attr_accessor :bounding_box
|
25
|
+
|
26
|
+
# @return [Float] A measure of accuracy of the extracted text.
|
27
|
+
attr_accessor :confidence
|
28
|
+
|
29
|
+
|
30
|
+
#
|
31
|
+
# Mapper for ExtractedToken class as Ruby Hash.
|
32
|
+
# This will be used for serialization/deserialization.
|
33
|
+
#
|
34
|
+
def self.mapper()
|
35
|
+
{
|
36
|
+
client_side_validation: true,
|
37
|
+
required: false,
|
38
|
+
serialized_name: 'ExtractedToken',
|
39
|
+
type: {
|
40
|
+
name: 'Composite',
|
41
|
+
class_name: 'ExtractedToken',
|
42
|
+
model_properties: {
|
43
|
+
text: {
|
44
|
+
client_side_validation: true,
|
45
|
+
required: false,
|
46
|
+
serialized_name: 'text',
|
47
|
+
type: {
|
48
|
+
name: 'String'
|
49
|
+
}
|
50
|
+
},
|
51
|
+
bounding_box: {
|
52
|
+
client_side_validation: true,
|
53
|
+
required: false,
|
54
|
+
serialized_name: 'boundingBox',
|
55
|
+
type: {
|
56
|
+
name: 'Sequence',
|
57
|
+
element: {
|
58
|
+
client_side_validation: true,
|
59
|
+
required: false,
|
60
|
+
serialized_name: 'FloatElementType',
|
61
|
+
type: {
|
62
|
+
name: 'Double'
|
63
|
+
}
|
64
|
+
}
|
65
|
+
}
|
66
|
+
},
|
67
|
+
confidence: {
|
68
|
+
client_side_validation: true,
|
69
|
+
required: false,
|
70
|
+
serialized_name: 'confidence',
|
71
|
+
type: {
|
72
|
+
name: 'Double'
|
73
|
+
}
|
74
|
+
}
|
75
|
+
}
|
76
|
+
}
|
77
|
+
}
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/form_document_report.rb
ADDED
@@ -0,0 +1,89 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Code generated by Microsoft (R) AutoRest Code Generator.
|
3
|
+
# Changes may cause incorrect behavior and will be lost if the code is
|
4
|
+
# regenerated.
|
5
|
+
|
6
|
+
module Azure::CognitiveServices::FormRecognizer::V1_0_preview
|
7
|
+
module Models
|
8
|
+
#
|
9
|
+
# Model object.
|
10
|
+
#
|
11
|
+
#
|
12
|
+
class FormDocumentReport
|
13
|
+
|
14
|
+
include MsRestAzure
|
15
|
+
|
16
|
+
# @return [String] Reference to the data that the report is for.
|
17
|
+
attr_accessor :document_name
|
18
|
+
|
19
|
+
# @return [Integer] Total number of pages trained on.
|
20
|
+
attr_accessor :pages
|
21
|
+
|
22
|
+
# @return [Array<String>] List of errors per page.
|
23
|
+
attr_accessor :errors
|
24
|
+
|
25
|
+
# @return [Enum] Status of the training operation. Possible values
|
26
|
+
# include: 'success', 'partialSuccess', 'failure'
|
27
|
+
attr_accessor :status
|
28
|
+
|
29
|
+
|
30
|
+
#
|
31
|
+
# Mapper for FormDocumentReport class as Ruby Hash.
|
32
|
+
# This will be used for serialization/deserialization.
|
33
|
+
#
|
34
|
+
def self.mapper()
|
35
|
+
{
|
36
|
+
client_side_validation: true,
|
37
|
+
required: false,
|
38
|
+
serialized_name: 'FormDocumentReport',
|
39
|
+
type: {
|
40
|
+
name: 'Composite',
|
41
|
+
class_name: 'FormDocumentReport',
|
42
|
+
model_properties: {
|
43
|
+
document_name: {
|
44
|
+
client_side_validation: true,
|
45
|
+
required: false,
|
46
|
+
serialized_name: 'documentName',
|
47
|
+
type: {
|
48
|
+
name: 'String'
|
49
|
+
}
|
50
|
+
},
|
51
|
+
pages: {
|
52
|
+
client_side_validation: true,
|
53
|
+
required: false,
|
54
|
+
serialized_name: 'pages',
|
55
|
+
type: {
|
56
|
+
name: 'Number'
|
57
|
+
}
|
58
|
+
},
|
59
|
+
errors: {
|
60
|
+
client_side_validation: true,
|
61
|
+
required: false,
|
62
|
+
serialized_name: 'errors',
|
63
|
+
type: {
|
64
|
+
name: 'Sequence',
|
65
|
+
element: {
|
66
|
+
client_side_validation: true,
|
67
|
+
required: false,
|
68
|
+
serialized_name: 'StringElementType',
|
69
|
+
type: {
|
70
|
+
name: 'String'
|
71
|
+
}
|
72
|
+
}
|
73
|
+
}
|
74
|
+
},
|
75
|
+
status: {
|
76
|
+
client_side_validation: true,
|
77
|
+
required: false,
|
78
|
+
serialized_name: 'status',
|
79
|
+
type: {
|
80
|
+
name: 'String'
|
81
|
+
}
|
82
|
+
}
|
83
|
+
}
|
84
|
+
}
|
85
|
+
}
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/form_operation_error.rb
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Code generated by Microsoft (R) AutoRest Code Generator.
|
3
|
+
# Changes may cause incorrect behavior and will be lost if the code is
|
4
|
+
# regenerated.
|
5
|
+
|
6
|
+
module Azure::CognitiveServices::FormRecognizer::V1_0_preview
|
7
|
+
module Models
|
8
|
+
#
|
9
|
+
# Error reported during an operation.
|
10
|
+
#
|
11
|
+
class FormOperationError
|
12
|
+
|
13
|
+
include MsRestAzure
|
14
|
+
|
15
|
+
# @return [String] Message reported during the train operation.
|
16
|
+
attr_accessor :error_message
|
17
|
+
|
18
|
+
|
19
|
+
#
|
20
|
+
# Mapper for FormOperationError class as Ruby Hash.
|
21
|
+
# This will be used for serialization/deserialization.
|
22
|
+
#
|
23
|
+
def self.mapper()
|
24
|
+
{
|
25
|
+
client_side_validation: true,
|
26
|
+
required: false,
|
27
|
+
serialized_name: 'FormOperationError',
|
28
|
+
type: {
|
29
|
+
name: 'Composite',
|
30
|
+
class_name: 'FormOperationError',
|
31
|
+
model_properties: {
|
32
|
+
error_message: {
|
33
|
+
client_side_validation: true,
|
34
|
+
required: false,
|
35
|
+
serialized_name: 'errorMessage',
|
36
|
+
type: {
|
37
|
+
name: 'String'
|
38
|
+
}
|
39
|
+
}
|
40
|
+
}
|
41
|
+
}
|
42
|
+
}
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Code generated by Microsoft (R) AutoRest Code Generator.
|
3
|
+
# Changes may cause incorrect behavior and will be lost if the code is
|
4
|
+
# regenerated.
|
5
|
+
|
6
|
+
module Azure::CognitiveServices::FormRecognizer::V1_0_preview
|
7
|
+
module Models
|
8
|
+
#
|
9
|
+
# Model object.
|
10
|
+
#
|
11
|
+
#
|
12
|
+
class InnerError
|
13
|
+
|
14
|
+
include MsRestAzure
|
15
|
+
|
16
|
+
# @return [String]
|
17
|
+
attr_accessor :request_id
|
18
|
+
|
19
|
+
|
20
|
+
#
|
21
|
+
# Mapper for InnerError class as Ruby Hash.
|
22
|
+
# This will be used for serialization/deserialization.
|
23
|
+
#
|
24
|
+
def self.mapper()
|
25
|
+
{
|
26
|
+
client_side_validation: true,
|
27
|
+
required: false,
|
28
|
+
serialized_name: 'InnerError',
|
29
|
+
type: {
|
30
|
+
name: 'Composite',
|
31
|
+
class_name: 'InnerError',
|
32
|
+
model_properties: {
|
33
|
+
request_id: {
|
34
|
+
client_side_validation: true,
|
35
|
+
required: false,
|
36
|
+
serialized_name: 'requestId',
|
37
|
+
type: {
|
38
|
+
name: 'String'
|
39
|
+
}
|
40
|
+
}
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Code generated by Microsoft (R) AutoRest Code Generator.
|
3
|
+
# Changes may cause incorrect behavior and will be lost if the code is
|
4
|
+
# regenerated.
|
5
|
+
|
6
|
+
module Azure::CognitiveServices::FormRecognizer::V1_0_preview
|
7
|
+
module Models
|
8
|
+
#
|
9
|
+
# Result of an operation to get
|
10
|
+
# the keys extracted by a model.
|
11
|
+
#
|
12
|
+
class KeysResult
|
13
|
+
|
14
|
+
include MsRestAzure
|
15
|
+
|
16
|
+
# @return [Hash{String => Array<String>}] Object mapping ClusterIds to
|
17
|
+
# Key lists.
|
18
|
+
attr_accessor :clusters
|
19
|
+
|
20
|
+
|
21
|
+
#
|
22
|
+
# Mapper for KeysResult class as Ruby Hash.
|
23
|
+
# This will be used for serialization/deserialization.
|
24
|
+
#
|
25
|
+
def self.mapper()
|
26
|
+
{
|
27
|
+
client_side_validation: true,
|
28
|
+
required: false,
|
29
|
+
serialized_name: 'KeysResult',
|
30
|
+
type: {
|
31
|
+
name: 'Composite',
|
32
|
+
class_name: 'KeysResult',
|
33
|
+
model_properties: {
|
34
|
+
clusters: {
|
35
|
+
client_side_validation: true,
|
36
|
+
required: false,
|
37
|
+
serialized_name: 'clusters',
|
38
|
+
type: {
|
39
|
+
name: 'Dictionary',
|
40
|
+
value: {
|
41
|
+
client_side_validation: true,
|
42
|
+
required: false,
|
43
|
+
serialized_name: 'ArrayElementType',
|
44
|
+
type: {
|
45
|
+
name: 'Sequence',
|
46
|
+
element: {
|
47
|
+
client_side_validation: true,
|
48
|
+
required: false,
|
49
|
+
serialized_name: 'StringElementType',
|
50
|
+
type: {
|
51
|
+
name: 'String'
|
52
|
+
}
|
53
|
+
}
|
54
|
+
}
|
55
|
+
}
|
56
|
+
}
|
57
|
+
}
|
58
|
+
}
|
59
|
+
}
|
60
|
+
}
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -0,0 +1,80 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Code generated by Microsoft (R) AutoRest Code Generator.
|
3
|
+
# Changes may cause incorrect behavior and will be lost if the code is
|
4
|
+
# regenerated.
|
5
|
+
|
6
|
+
module Azure::CognitiveServices::FormRecognizer::V1_0_preview
|
7
|
+
module Models
|
8
|
+
#
|
9
|
+
# Result of a model status query operation.
|
10
|
+
#
|
11
|
+
class ModelResult
|
12
|
+
|
13
|
+
include MsRestAzure
|
14
|
+
|
15
|
+
# @return Get or set model identifier.
|
16
|
+
attr_accessor :model_id
|
17
|
+
|
18
|
+
# @return [Enum] Get or set the status of model. Possible values include:
|
19
|
+
# 'created', 'ready', 'invalid'
|
20
|
+
attr_accessor :status
|
21
|
+
|
22
|
+
# @return [DateTime] Get or set the created date time of the model.
|
23
|
+
attr_accessor :created_date_time
|
24
|
+
|
25
|
+
# @return [DateTime] Get or set the model last updated datetime.
|
26
|
+
attr_accessor :last_updated_date_time
|
27
|
+
|
28
|
+
|
29
|
+
#
|
30
|
+
# Mapper for ModelResult class as Ruby Hash.
|
31
|
+
# This will be used for serialization/deserialization.
|
32
|
+
#
|
33
|
+
def self.mapper()
|
34
|
+
{
|
35
|
+
client_side_validation: true,
|
36
|
+
required: false,
|
37
|
+
serialized_name: 'ModelResult',
|
38
|
+
type: {
|
39
|
+
name: 'Composite',
|
40
|
+
class_name: 'ModelResult',
|
41
|
+
model_properties: {
|
42
|
+
model_id: {
|
43
|
+
client_side_validation: true,
|
44
|
+
required: false,
|
45
|
+
serialized_name: 'modelId',
|
46
|
+
type: {
|
47
|
+
name: 'String'
|
48
|
+
}
|
49
|
+
},
|
50
|
+
status: {
|
51
|
+
client_side_validation: true,
|
52
|
+
required: false,
|
53
|
+
serialized_name: 'status',
|
54
|
+
type: {
|
55
|
+
name: 'String'
|
56
|
+
}
|
57
|
+
},
|
58
|
+
created_date_time: {
|
59
|
+
client_side_validation: true,
|
60
|
+
required: false,
|
61
|
+
serialized_name: 'createdDateTime',
|
62
|
+
type: {
|
63
|
+
name: 'DateTime'
|
64
|
+
}
|
65
|
+
},
|
66
|
+
last_updated_date_time: {
|
67
|
+
client_side_validation: true,
|
68
|
+
required: false,
|
69
|
+
serialized_name: 'lastUpdatedDateTime',
|
70
|
+
type: {
|
71
|
+
name: 'DateTime'
|
72
|
+
}
|
73
|
+
}
|
74
|
+
}
|
75
|
+
}
|
76
|
+
}
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|