azure_cognitiveservices_formrecognizer 0.17.0

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/analyze_result.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::FormRecognizer::V1_0_preview
+  module Models
+    #
+    # Analyze API call result.
+    #
+    class AnalyzeResult
+
+      include MsRestAzure
+
+      # @return [Enum] Status of the analyze operation. Possible values
+      # include: 'success', 'partialSuccess', 'failure'
+      attr_accessor :status
+
+      # @return [Array<ExtractedPage>] Page level information extracted in the
+      # analyzed
+      # document.
+      attr_accessor :pages
+
+      # @return [Array<FormOperationError>] List of errors reported during the
+      # analyze
+      # operation.
+      attr_accessor :errors
+
+
+      #
+      # Mapper for AnalyzeResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'AnalyzeResult',
+          type: {
+            name: 'Composite',
+            class_name: 'AnalyzeResult',
+            model_properties: {
+              status: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'status',
+                type: {
+                  name: 'String'
+                }
+              },
+              pages: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'pages',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ExtractedPageElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ExtractedPage'
+                      }
+                  }
+                }
+              },
+              errors: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'errors',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'FormOperationErrorElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'FormOperationError'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/error_information.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::FormRecognizer::V1_0_preview
+  module Models
+    #
+    # Model object.
+    #
+    #
+    class ErrorInformation
+
+      include MsRestAzure
+
+      # @return [String]
+      attr_accessor :code
+
+      # @return [InnerError]
+      attr_accessor :inner_error
+
+      # @return [String]
+      attr_accessor :message
+
+
+      #
+      # Mapper for ErrorInformation class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ErrorInformation',
+          type: {
+            name: 'Composite',
+            class_name: 'ErrorInformation',
+            model_properties: {
+              code: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'code',
+                type: {
+                  name: 'String'
+                }
+              },
+              inner_error: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'innerError',
+                type: {
+                  name: 'Composite',
+                  class_name: 'InnerError'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/error_response.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::FormRecognizer::V1_0_preview
+  module Models
+    #
+    # Model object.
+    #
+    #
+    class ErrorResponse
+
+      include MsRestAzure
+
+      # @return [ErrorInformation]
+      attr_accessor :error
+
+
+      #
+      # Mapper for ErrorResponse class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ErrorResponse',
+          type: {
+            name: 'Composite',
+            class_name: 'ErrorResponse',
+            model_properties: {
+              error: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'error',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ErrorInformation'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_key_value_pair.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::FormRecognizer::V1_0_preview
+  module Models
+    #
+    # Representation of a key-value pair as a list
+    # of key and value tokens.
+    #
+    class ExtractedKeyValuePair
+
+      include MsRestAzure
+
+      # @return [Array<ExtractedToken>] List of tokens for the extracted key in
+      # a key-value pair.
+      attr_accessor :key
+
+      # @return [Array<ExtractedToken>] List of tokens for the extracted value
+      # in a key-value pair.
+      attr_accessor :value
+
+
+      #
+      # Mapper for ExtractedKeyValuePair class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ExtractedKeyValuePair',
+          type: {
+            name: 'Composite',
+            class_name: 'ExtractedKeyValuePair',
+            model_properties: {
+              key: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'key',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ExtractedTokenElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ExtractedToken'
+                      }
+                  }
+                }
+              },
+              value: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'value',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ExtractedTokenElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ExtractedToken'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_page.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::FormRecognizer::V1_0_preview
+  module Models
+    #
+    # Extraction information of a single page in a
+    # with a document.
+    #
+    class ExtractedPage
+
+      include MsRestAzure
+
+      # @return [Integer] Page number.
+      attr_accessor :number
+
+      # @return [Integer] Height of the page (in pixels).
+      attr_accessor :height
+
+      # @return [Integer] Width of the page (in pixels).
+      attr_accessor :width
+
+      # @return [Integer] Cluster identifier.
+      attr_accessor :cluster_id
+
+      # @return [Array<ExtractedKeyValuePair>] List of Key-Value pairs
+      # extracted from the page.
+      attr_accessor :key_value_pairs
+
+      # @return [Array<ExtractedTable>] List of Tables and their information
+      # extracted from the page.
+      attr_accessor :tables
+
+
+      #
+      # Mapper for ExtractedPage class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ExtractedPage',
+          type: {
+            name: 'Composite',
+            class_name: 'ExtractedPage',
+            model_properties: {
+              number: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'number',
+                type: {
+                  name: 'Number'
+                }
+              },
+              height: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'height',
+                type: {
+                  name: 'Number'
+                }
+              },
+              width: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'width',
+                type: {
+                  name: 'Number'
+                }
+              },
+              cluster_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'clusterId',
+                type: {
+                  name: 'Number'
+                }
+              },
+              key_value_pairs: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'keyValuePairs',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ExtractedKeyValuePairElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ExtractedKeyValuePair'
+                      }
+                  }
+                }
+              },
+              tables: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'tables',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ExtractedTableElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ExtractedTable'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/extracted_table.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::FormRecognizer::V1_0_preview
+  module Models
+    #
+    # Extraction information about a table
+    # contained in a page.
+    #
+    class ExtractedTable
+
+      include MsRestAzure
+
+      # @return [String] Table identifier.
+      attr_accessor :id
+
+      # @return [Array<ExtractedTableColumn>] List of columns contained in the
+      # table.
+      attr_accessor :columns
+
+
+      #
+      # Mapper for ExtractedTable class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ExtractedTable',
+          type: {
+            name: 'Composite',
+            class_name: 'ExtractedTable',
+            model_properties: {
+              id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              columns: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'columns',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ExtractedTableColumnElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ExtractedTableColumn'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end