azure_cognitiveservices_formrecognizer 0.17.0

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

@@ -0,0 +1,87 @@
+# 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 column in
+    # a table.
+    #
+    class ExtractedTableColumn
+
+      include MsRestAzure
+
+      # @return [Array<ExtractedToken>] List of extracted tokens for the column
+      # header.
+      attr_accessor :header
+
+      # @return [Array<Array<ExtractedToken>>] Extracted text for each cell of
+      # a column. Each cell
+      # in the column can have a list of one or more tokens.
+      attr_accessor :entries
+
+
+      #
+      # Mapper for ExtractedTableColumn class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ExtractedTableColumn',
+          type: {
+            name: 'Composite',
+            class_name: 'ExtractedTableColumn',
+            model_properties: {
+              header: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'header',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ExtractedTokenElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ExtractedToken'
+                      }
+                  }
+                }
+              },
+              entries: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'entries',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ArrayElementType',
+                      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_token.rb

@@ -0,0 +1,81 @@
+# 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
+    #
+    # Canonical representation of single extracted text.
+    #
+    class ExtractedToken
+
+      include MsRestAzure
+
+      # @return [String] String value of the extracted text.
+      attr_accessor :text
+
+      # @return [Array<Float>] Bounding box of the extracted text. Represents
+      # the
+      # location of the extracted text as a pair of
+      # cartesian co-ordinates. The co-ordinate pairs are arranged by
+      # top-left, top-right, bottom-right and bottom-left endpoints box
+      # with origin reference from the bottom-left of the page.
+      attr_accessor :bounding_box
+
+      # @return [Float] A measure of accuracy of the extracted text.
+      attr_accessor :confidence
+
+
+      #
+      # Mapper for ExtractedToken class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ExtractedToken',
+          type: {
+            name: 'Composite',
+            class_name: 'ExtractedToken',
+            model_properties: {
+              text: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              bounding_box: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'boundingBox',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'FloatElementType',
+                      type: {
+                        name: 'Double'
+                      }
+                  }
+                }
+              },
+              confidence: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'confidence',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# 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 FormDocumentReport
+
+      include MsRestAzure
+
+      # @return [String] Reference to the data that the report is for.
+      attr_accessor :document_name
+
+      # @return [Integer] Total number of pages trained on.
+      attr_accessor :pages
+
+      # @return [Array<String>] List of errors per page.
+      attr_accessor :errors
+
+      # @return [Enum] Status of the training operation. Possible values
+      # include: 'success', 'partialSuccess', 'failure'
+      attr_accessor :status
+
+
+      #
+      # Mapper for FormDocumentReport class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'FormDocumentReport',
+          type: {
+            name: 'Composite',
+            class_name: 'FormDocumentReport',
+            model_properties: {
+              document_name: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'documentName',
+                type: {
+                  name: 'String'
+                }
+              },
+              pages: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'pages',
+                type: {
+                  name: 'Number'
+                }
+              },
+              errors: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'errors',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'StringElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              status: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'status',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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
+    #
+    # Error reported during an operation.
+    #
+    class FormOperationError
+
+      include MsRestAzure
+
+      # @return [String] Message reported during the train operation.
+      attr_accessor :error_message
+
+
+      #
+      # Mapper for FormOperationError class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'FormOperationError',
+          type: {
+            name: 'Composite',
+            class_name: 'FormOperationError',
+            model_properties: {
+              error_message: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'errorMessage',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# 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 InnerError
+
+      include MsRestAzure
+
+      # @return [String]
+      attr_accessor :request_id
+
+
+      #
+      # Mapper for InnerError class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'InnerError',
+          type: {
+            name: 'Composite',
+            class_name: 'InnerError',
+            model_properties: {
+              request_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'requestId',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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
+    #
+    # Result of an operation to get
+    # the keys extracted by a model.
+    #
+    class KeysResult
+
+      include MsRestAzure
+
+      # @return [Hash{String => Array<String>}] Object mapping ClusterIds to
+      # Key lists.
+      attr_accessor :clusters
+
+
+      #
+      # Mapper for KeysResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'KeysResult',
+          type: {
+            name: 'Composite',
+            class_name: 'KeysResult',
+            model_properties: {
+              clusters: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'clusters',
+                type: {
+                  name: 'Dictionary',
+                  value: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ArrayElementType',
+                      type: {
+                        name: 'Sequence',
+                        element: {
+                            client_side_validation: true,
+                            required: false,
+                            serialized_name: 'StringElementType',
+                            type: {
+                              name: 'String'
+                            }
+                        }
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# 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
+    #
+    # Result of a model status query operation.
+    #
+    class ModelResult
+
+      include MsRestAzure
+
+      # @return Get or set model identifier.
+      attr_accessor :model_id
+
+      # @return [Enum] Get or set the status of model. Possible values include:
+      # 'created', 'ready', 'invalid'
+      attr_accessor :status
+
+      # @return [DateTime] Get or set the created date time of the model.
+      attr_accessor :created_date_time
+
+      # @return [DateTime] Get or set the model last updated datetime.
+      attr_accessor :last_updated_date_time
+
+
+      #
+      # Mapper for ModelResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ModelResult',
+          type: {
+            name: 'Composite',
+            class_name: 'ModelResult',
+            model_properties: {
+              model_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'modelId',
+                type: {
+                  name: 'String'
+                }
+              },
+              status: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'status',
+                type: {
+                  name: 'String'
+                }
+              },
+              created_date_time: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'createdDateTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              last_updated_date_time: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'lastUpdatedDateTime',
+                type: {
+                  name: 'DateTime'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end