azure_cognitiveservices_formrecognizer 0.17.0 → 0.17.1

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

@@ -0,0 +1,69 @@
+# 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
+    #
+    # Details about the API request error.
+    #
+    class ComputerVisionError
+
+      include MsRestAzure
+
+      # @return The error code.
+      attr_accessor :code
+
+      # @return [String] A message explaining the error reported by the
+      # service.
+      attr_accessor :message
+
+      # @return [String] A unique request identifier.
+      attr_accessor :request_id
+
+
+      #
+      # Mapper for ComputerVisionError class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ComputerVisionError',
+          type: {
+            name: 'Composite',
+            class_name: 'ComputerVisionError',
+            model_properties: {
+              code: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'code',
+                type: {
+                  name: 'Object'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              },
+              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/element_reference.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
+    #
+    # Reference to an OCR word.
+    #
+    class ElementReference
+
+      include MsRestAzure
+
+      # @return [String]
+      attr_accessor :ref
+
+
+      #
+      # Mapper for ElementReference class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'elementReference',
+          type: {
+            name: 'Composite',
+            class_name: 'ElementReference',
+            model_properties: {
+              ref: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: '$ref',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# 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
+    #
+    # Base class representing a recognized field value.
+    #
+    class FieldValue
+
+      include MsRestAzure
+
+      @@discriminatorMap = Hash.new
+      @@discriminatorMap["stringValue"] = "StringValue"
+      @@discriminatorMap["numberValue"] = "NumberValue"
+
+      def initialize
+        @valueType = "fieldValue"
+      end
+
+      attr_accessor :valueType
+
+      # @return [String] OCR text content of the recognized field.
+      attr_accessor :text
+
+      # @return [Array<ElementReference>] List of references to OCR words
+      # comprising the recognized field value.
+      attr_accessor :elements
+
+
+      #
+      # Mapper for FieldValue class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'fieldValue',
+          type: {
+            name: 'Composite',
+            polymorphic_discriminator: 'valueType',
+            uber_parent: 'FieldValue',
+            class_name: 'FieldValue',
+            model_properties: {
+              text: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              elements: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'elements',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ElementReferenceElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ElementReference'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/image_url.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 ImageUrl
+
+      include MsRestAzure
+
+      # @return [String] Publicly reachable URL of an image.
+      attr_accessor :url
+
+
+      #
+      # Mapper for ImageUrl class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ImageUrl',
+          type: {
+            name: 'Composite',
+            class_name: 'ImageUrl',
+            model_properties: {
+              url: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'url',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# 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
+    #
+    # An object representing a recognized text line.
+    #
+    class Line
+
+      include MsRestAzure
+
+      # @return [Array<Integer>] Bounding box of a recognized line.
+      attr_accessor :bounding_box
+
+      # @return [String] The text content of the line.
+      attr_accessor :text
+
+      # @return [Array<Word>] List of words in the text line.
+      attr_accessor :words
+
+
+      #
+      # Mapper for Line class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Line',
+          type: {
+            name: 'Composite',
+            class_name: 'Line',
+            model_properties: {
+              bounding_box: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'boundingBox',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'NumberElementType',
+                      type: {
+                        name: 'Number'
+                      }
+                  }
+                }
+              },
+              text: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              words: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'words',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'WordElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Word'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# 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
+    #
+    # Recognized numeric field value.
+    #
+    class NumberValue < FieldValue
+
+      include MsRestAzure
+
+
+      def initialize
+        @valueType = "numberValue"
+      end
+
+      attr_accessor :valueType
+
+      # @return [Float] Numeric value of the recognized field.
+      attr_accessor :value
+
+
+      #
+      # Mapper for NumberValue class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'numberValue',
+          type: {
+            name: 'Composite',
+            class_name: 'NumberValue',
+            model_properties: {
+              text: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              elements: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'elements',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ElementReferenceElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ElementReference'
+                      }
+                  }
+                }
+              },
+              valueType: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'valueType',
+                type: {
+                  name: 'String'
+                }
+              },
+              value: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'value',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/read_receipt_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
+    #
+    # Analysis result of the 'Batch Read Receipt' operation.
+    #
+    class ReadReceiptResult
+
+      include MsRestAzure
+
+      # @return [TextOperationStatusCodes] Status of the read operation.
+      # Possible values include: 'Not Started', 'Running', 'Failed',
+      # 'Succeeded'
+      attr_accessor :status
+
+      # @return [Array<TextRecognitionResult>] Text recognition result of the
+      # 'Batch Read Receipt' operation.
+      attr_accessor :recognition_results
+
+      # @return [Array<UnderstandingResult>] Semantic understanding result of
+      # the 'Batch Read Receipt' operation.
+      attr_accessor :understanding_results
+
+
+      #
+      # Mapper for ReadReceiptResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'readReceiptResult',
+          type: {
+            name: 'Composite',
+            class_name: 'ReadReceiptResult',
+            model_properties: {
+              status: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'status',
+                type: {
+                  name: 'Enum',
+                  module: 'TextOperationStatusCodes'
+                }
+              },
+              recognition_results: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'recognitionResults',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'TextRecognitionResultElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'TextRecognitionResult'
+                      }
+                  }
+                }
+              },
+              understanding_results: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'understandingResults',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UnderstandingResultElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'UnderstandingResult'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end