azure_cognitiveservices_formrecognizer 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE.txt +21 -0
  3. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer.rb +43 -0
  4. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/form_recognizer_client.rb +734 -0
  5. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/analyze_result.rb +91 -0
  6. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/error_information.rb +70 -0
  7. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/error_response.rb +48 -0
  8. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_key_value_pair.rb +78 -0
  9. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_page.rb +122 -0
  10. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_table.rb +68 -0
  11. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_table_column.rb +87 -0
  12. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_token.rb +81 -0
  13. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/form_document_report.rb +89 -0
  14. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/form_operation_error.rb +46 -0
  15. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/inner_error.rb +47 -0
  16. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/keys_result.rb +64 -0
  17. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/model_result.rb +80 -0
  18. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/models_result.rb +55 -0
  19. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/train_request.rb +50 -0
  20. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/train_result.rb +89 -0
  21. data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/module_definition.rb +9 -0
  22. data/lib/azure_cognitiveservices_formrecognizer.rb +6 -0
  23. data/lib/module_definition.rb +7 -0
  24. data/lib/profiles/latest/formrecognizer_latest_profile_client.rb +38 -0
  25. data/lib/profiles/latest/formrecognizer_module_definition.rb +8 -0
  26. data/lib/profiles/latest/modules/formrecognizer_profile_module.rb +121 -0
  27. data/lib/version.rb +7 -0
  28. metadata +143 -0
@@ -0,0 +1,91 @@
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
+ # Analyze API call result.
10
+ #
11
+ class AnalyzeResult
12
+
13
+ include MsRestAzure
14
+
15
+ # @return [Enum] Status of the analyze operation. Possible values
16
+ # include: 'success', 'partialSuccess', 'failure'
17
+ attr_accessor :status
18
+
19
+ # @return [Array<ExtractedPage>] Page level information extracted in the
20
+ # analyzed
21
+ # document.
22
+ attr_accessor :pages
23
+
24
+ # @return [Array<FormOperationError>] List of errors reported during the
25
+ # analyze
26
+ # operation.
27
+ attr_accessor :errors
28
+
29
+
30
+ #
31
+ # Mapper for AnalyzeResult 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: 'AnalyzeResult',
39
+ type: {
40
+ name: 'Composite',
41
+ class_name: 'AnalyzeResult',
42
+ model_properties: {
43
+ status: {
44
+ client_side_validation: true,
45
+ required: false,
46
+ serialized_name: 'status',
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: 'Sequence',
57
+ element: {
58
+ client_side_validation: true,
59
+ required: false,
60
+ serialized_name: 'ExtractedPageElementType',
61
+ type: {
62
+ name: 'Composite',
63
+ class_name: 'ExtractedPage'
64
+ }
65
+ }
66
+ }
67
+ },
68
+ errors: {
69
+ client_side_validation: true,
70
+ required: false,
71
+ serialized_name: 'errors',
72
+ type: {
73
+ name: 'Sequence',
74
+ element: {
75
+ client_side_validation: true,
76
+ required: false,
77
+ serialized_name: 'FormOperationErrorElementType',
78
+ type: {
79
+ name: 'Composite',
80
+ class_name: 'FormOperationError'
81
+ }
82
+ }
83
+ }
84
+ }
85
+ }
86
+ }
87
+ }
88
+ end
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,70 @@
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 ErrorInformation
13
+
14
+ include MsRestAzure
15
+
16
+ # @return [String]
17
+ attr_accessor :code
18
+
19
+ # @return [InnerError]
20
+ attr_accessor :inner_error
21
+
22
+ # @return [String]
23
+ attr_accessor :message
24
+
25
+
26
+ #
27
+ # Mapper for ErrorInformation 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: 'ErrorInformation',
35
+ type: {
36
+ name: 'Composite',
37
+ class_name: 'ErrorInformation',
38
+ model_properties: {
39
+ code: {
40
+ client_side_validation: true,
41
+ required: false,
42
+ serialized_name: 'code',
43
+ type: {
44
+ name: 'String'
45
+ }
46
+ },
47
+ inner_error: {
48
+ client_side_validation: true,
49
+ required: false,
50
+ serialized_name: 'innerError',
51
+ type: {
52
+ name: 'Composite',
53
+ class_name: 'InnerError'
54
+ }
55
+ },
56
+ message: {
57
+ client_side_validation: true,
58
+ required: false,
59
+ serialized_name: 'message',
60
+ type: {
61
+ name: 'String'
62
+ }
63
+ }
64
+ }
65
+ }
66
+ }
67
+ end
68
+ end
69
+ end
70
+ end
@@ -0,0 +1,48 @@
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 ErrorResponse
13
+
14
+ include MsRestAzure
15
+
16
+ # @return [ErrorInformation]
17
+ attr_accessor :error
18
+
19
+
20
+ #
21
+ # Mapper for ErrorResponse 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: 'ErrorResponse',
29
+ type: {
30
+ name: 'Composite',
31
+ class_name: 'ErrorResponse',
32
+ model_properties: {
33
+ error: {
34
+ client_side_validation: true,
35
+ required: false,
36
+ serialized_name: 'error',
37
+ type: {
38
+ name: 'Composite',
39
+ class_name: 'ErrorInformation'
40
+ }
41
+ }
42
+ }
43
+ }
44
+ }
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,78 @@
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
+ # Representation of a key-value pair as a list
10
+ # of key and value tokens.
11
+ #
12
+ class ExtractedKeyValuePair
13
+
14
+ include MsRestAzure
15
+
16
+ # @return [Array<ExtractedToken>] List of tokens for the extracted key in
17
+ # a key-value pair.
18
+ attr_accessor :key
19
+
20
+ # @return [Array<ExtractedToken>] List of tokens for the extracted value
21
+ # in a key-value pair.
22
+ attr_accessor :value
23
+
24
+
25
+ #
26
+ # Mapper for ExtractedKeyValuePair class as Ruby Hash.
27
+ # This will be used for serialization/deserialization.
28
+ #
29
+ def self.mapper()
30
+ {
31
+ client_side_validation: true,
32
+ required: false,
33
+ serialized_name: 'ExtractedKeyValuePair',
34
+ type: {
35
+ name: 'Composite',
36
+ class_name: 'ExtractedKeyValuePair',
37
+ model_properties: {
38
+ key: {
39
+ client_side_validation: true,
40
+ required: false,
41
+ serialized_name: 'key',
42
+ type: {
43
+ name: 'Sequence',
44
+ element: {
45
+ client_side_validation: true,
46
+ required: false,
47
+ serialized_name: 'ExtractedTokenElementType',
48
+ type: {
49
+ name: 'Composite',
50
+ class_name: 'ExtractedToken'
51
+ }
52
+ }
53
+ }
54
+ },
55
+ value: {
56
+ client_side_validation: true,
57
+ required: false,
58
+ serialized_name: 'value',
59
+ type: {
60
+ name: 'Sequence',
61
+ element: {
62
+ client_side_validation: true,
63
+ required: false,
64
+ serialized_name: 'ExtractedTokenElementType',
65
+ type: {
66
+ name: 'Composite',
67
+ class_name: 'ExtractedToken'
68
+ }
69
+ }
70
+ }
71
+ }
72
+ }
73
+ }
74
+ }
75
+ end
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,122 @@
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 single page in a
10
+ # with a document.
11
+ #
12
+ class ExtractedPage
13
+
14
+ include MsRestAzure
15
+
16
+ # @return [Integer] Page number.
17
+ attr_accessor :number
18
+
19
+ # @return [Integer] Height of the page (in pixels).
20
+ attr_accessor :height
21
+
22
+ # @return [Integer] Width of the page (in pixels).
23
+ attr_accessor :width
24
+
25
+ # @return [Integer] Cluster identifier.
26
+ attr_accessor :cluster_id
27
+
28
+ # @return [Array<ExtractedKeyValuePair>] List of Key-Value pairs
29
+ # extracted from the page.
30
+ attr_accessor :key_value_pairs
31
+
32
+ # @return [Array<ExtractedTable>] List of Tables and their information
33
+ # extracted from the page.
34
+ attr_accessor :tables
35
+
36
+
37
+ #
38
+ # Mapper for ExtractedPage class as Ruby Hash.
39
+ # This will be used for serialization/deserialization.
40
+ #
41
+ def self.mapper()
42
+ {
43
+ client_side_validation: true,
44
+ required: false,
45
+ serialized_name: 'ExtractedPage',
46
+ type: {
47
+ name: 'Composite',
48
+ class_name: 'ExtractedPage',
49
+ model_properties: {
50
+ number: {
51
+ client_side_validation: true,
52
+ required: false,
53
+ serialized_name: 'number',
54
+ type: {
55
+ name: 'Number'
56
+ }
57
+ },
58
+ height: {
59
+ client_side_validation: true,
60
+ required: false,
61
+ serialized_name: 'height',
62
+ type: {
63
+ name: 'Number'
64
+ }
65
+ },
66
+ width: {
67
+ client_side_validation: true,
68
+ required: false,
69
+ serialized_name: 'width',
70
+ type: {
71
+ name: 'Number'
72
+ }
73
+ },
74
+ cluster_id: {
75
+ client_side_validation: true,
76
+ required: false,
77
+ serialized_name: 'clusterId',
78
+ type: {
79
+ name: 'Number'
80
+ }
81
+ },
82
+ key_value_pairs: {
83
+ client_side_validation: true,
84
+ required: false,
85
+ serialized_name: 'keyValuePairs',
86
+ type: {
87
+ name: 'Sequence',
88
+ element: {
89
+ client_side_validation: true,
90
+ required: false,
91
+ serialized_name: 'ExtractedKeyValuePairElementType',
92
+ type: {
93
+ name: 'Composite',
94
+ class_name: 'ExtractedKeyValuePair'
95
+ }
96
+ }
97
+ }
98
+ },
99
+ tables: {
100
+ client_side_validation: true,
101
+ required: false,
102
+ serialized_name: 'tables',
103
+ type: {
104
+ name: 'Sequence',
105
+ element: {
106
+ client_side_validation: true,
107
+ required: false,
108
+ serialized_name: 'ExtractedTableElementType',
109
+ type: {
110
+ name: 'Composite',
111
+ class_name: 'ExtractedTable'
112
+ }
113
+ }
114
+ }
115
+ }
116
+ }
117
+ }
118
+ }
119
+ end
120
+ end
121
+ end
122
+ end
@@ -0,0 +1,68 @@
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 about a table
10
+ # contained in a page.
11
+ #
12
+ class ExtractedTable
13
+
14
+ include MsRestAzure
15
+
16
+ # @return [String] Table identifier.
17
+ attr_accessor :id
18
+
19
+ # @return [Array<ExtractedTableColumn>] List of columns contained in the
20
+ # table.
21
+ attr_accessor :columns
22
+
23
+
24
+ #
25
+ # Mapper for ExtractedTable class as Ruby Hash.
26
+ # This will be used for serialization/deserialization.
27
+ #
28
+ def self.mapper()
29
+ {
30
+ client_side_validation: true,
31
+ required: false,
32
+ serialized_name: 'ExtractedTable',
33
+ type: {
34
+ name: 'Composite',
35
+ class_name: 'ExtractedTable',
36
+ model_properties: {
37
+ id: {
38
+ client_side_validation: true,
39
+ required: false,
40
+ serialized_name: 'id',
41
+ type: {
42
+ name: 'String'
43
+ }
44
+ },
45
+ columns: {
46
+ client_side_validation: true,
47
+ required: false,
48
+ serialized_name: 'columns',
49
+ type: {
50
+ name: 'Sequence',
51
+ element: {
52
+ client_side_validation: true,
53
+ required: false,
54
+ serialized_name: 'ExtractedTableColumnElementType',
55
+ type: {
56
+ name: 'Composite',
57
+ class_name: 'ExtractedTableColumn'
58
+ }
59
+ }
60
+ }
61
+ }
62
+ }
63
+ }
64
+ }
65
+ end
66
+ end
67
+ end
68
+ end