azure_cognitiveservices_formrecognizer 0.17.0 → 0.17.1

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/string_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 string field value.
+    #
+    class StringValue < FieldValue
+
+      include MsRestAzure
+
+
+      def initialize
+        @valueType = "stringValue"
+      end
+
+      attr_accessor :valueType
+
+      # @return [String] String value of the recognized field.
+      attr_accessor :value
+
+
+      #
+      # Mapper for StringValue class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'stringValue',
+          type: {
+            name: 'Composite',
+            class_name: 'StringValue',
+            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: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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
+    #
+    # Defines values for TextOperationStatusCodes
+    #
+    module TextOperationStatusCodes
+      NotStarted = "Not Started"
+      Running = "Running"
+      Failed = "Failed"
+      Succeeded = "Succeeded"
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# 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 region
+    #
+    class TextRecognitionResult
+
+      include MsRestAzure
+
+      # @return [Integer] The 1-based page number of the recognition result.
+      attr_accessor :page
+
+      # @return [Float] The orientation of the image in degrees in the
+      # clockwise direction. Range between [0, 360).
+      attr_accessor :clockwise_orientation
+
+      # @return [Float] The width of the image in pixels or the PDF in inches.
+      attr_accessor :width
+
+      # @return [Float] The height of the image in pixels or the PDF in inches.
+      attr_accessor :height
+
+      # @return [TextRecognitionResultDimensionUnit] The unit used in the
+      # Width, Height and BoundingBox. For images, the unit is 'pixel'. For
+      # PDF, the unit is 'inch'. Possible values include: 'pixel', 'inch'
+      attr_accessor :unit
+
+      # @return [Array<Line>] A list of recognized text lines.
+      attr_accessor :lines
+
+
+      #
+      # Mapper for TextRecognitionResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'TextRecognitionResult',
+          type: {
+            name: 'Composite',
+            class_name: 'TextRecognitionResult',
+            model_properties: {
+              page: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'page',
+                type: {
+                  name: 'Number'
+                }
+              },
+              clockwise_orientation: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'clockwiseOrientation',
+                type: {
+                  name: 'Double'
+                }
+              },
+              width: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'width',
+                type: {
+                  name: 'Double'
+                }
+              },
+              height: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'height',
+                type: {
+                  name: 'Double'
+                }
+              },
+              unit: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'unit',
+                type: {
+                  name: 'Enum',
+                  module: 'TextRecognitionResultDimensionUnit'
+                }
+              },
+              lines: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'lines',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'LineElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Line'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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
+    #
+    # Defines values for TextRecognitionResultConfidenceClass
+    #
+    module TextRecognitionResultConfidenceClass
+      High = "High"
+      Low = "Low"
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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
+    #
+    # Defines values for TextRecognitionResultDimensionUnit
+    #
+    module TextRecognitionResultDimensionUnit
+      Pixel = "pixel"
+      Inch = "inch"
+    end
+  end
+end

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

@@ -15,6 +15,10 @@ module Azure::CognitiveServices::FormRecognizer::V1_0_preview
       # @return [String] Get or set source path.
       attr_accessor :source
 
+      # @return [TrainSourceFilter] Get or set filter to further search the
+      # source path for content.
+      attr_accessor :source_filter
+
 
       #
       # Mapper for TrainRequest class as Ruby Hash.
@@ -40,6 +44,15 @@ module Azure::CognitiveServices::FormRecognizer::V1_0_preview
                 type: {
                   name: 'String'
                 }
+              },
+              source_filter: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'sourceFilter',
+                type: {
+                  name: 'Composite',
+                  class_name: 'TrainSourceFilter'
+                }
               }
             }
           }

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

@@ -0,0 +1,65 @@
+# 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
+    #
+    # Filters to be applied when traversing a data source.
+    #
+    class TrainSourceFilter
+
+      include MsRestAzure
+
+      # @return [String] A case-sensitive prefix string to filter content
+      # under the source location. For e.g., when using a Azure Blob
+      # Uri use the prefix to restrict subfolders for content.
+      attr_accessor :prefix
+
+      # @return [Boolean] A flag to indicate if sub folders within the set of
+      # prefix folders will also need to be included when searching
+      # for content to be preprocessed.
+      attr_accessor :include_sub_folders
+
+
+      #
+      # Mapper for TrainSourceFilter class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'TrainSourceFilter',
+          type: {
+            name: 'Composite',
+            class_name: 'TrainSourceFilter',
+            model_properties: {
+              prefix: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'prefix',
+                constraints: {
+                  MaxLength: 128,
+                  MinLength: 0
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              include_sub_folders: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'includeSubFolders',
+                type: {
+                  name: 'Boolean'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/understanding_result.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
+    #
+    # A set of extracted fields corresponding to a semantic object, such as a
+    # receipt, in the input document.
+    #
+    class UnderstandingResult
+
+      include MsRestAzure
+
+      # @return [Array<Integer>] List of pages where the document is found.
+      attr_accessor :pages
+
+      # @return [Hash{String => FieldValue}] Dictionary of recognized field
+      # values.
+      attr_accessor :fields
+
+
+      #
+      # Mapper for UnderstandingResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'understandingResult',
+          type: {
+            name: 'Composite',
+            class_name: 'UnderstandingResult',
+            model_properties: {
+              pages: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'pages',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'NumberElementType',
+                      type: {
+                        name: 'Number'
+                      }
+                  }
+                }
+              },
+              fields: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'fields',
+                type: {
+                  name: 'Dictionary',
+                  value: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'FieldValueElementType',
+                      type: {
+                        name: 'Composite',
+                        polymorphic_discriminator: 'valueType',
+                        uber_parent: 'FieldValue',
+                        class_name: 'FieldValue'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0-preview/generated/azure_cognitiveservices_formrecognizer/models/word.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
+    #
+    # An object representing a recognized word.
+    #
+    class Word
+
+      include MsRestAzure
+
+      # @return [Array<Integer>] Bounding box of a recognized word.
+      attr_accessor :bounding_box
+
+      # @return [String] The text content of the word.
+      attr_accessor :text
+
+      # @return [TextRecognitionResultConfidenceClass] Qualitative confidence
+      # measure. Possible values include: 'High', 'Low'
+      attr_accessor :confidence
+
+
+      #
+      # Mapper for Word class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Word',
+          type: {
+            name: 'Composite',
+            class_name: 'Word',
+            model_properties: {
+              bounding_box: {
+                client_side_validation: true,
+                required: true,
+                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: true,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              confidence: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'confidence',
+                type: {
+                  name: 'Enum',
+                  module: 'TextRecognitionResultConfidenceClass'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end