class Azure::CognitiveServices::ComputerVision::V2_1::Models::TextRecognitionResult

An object representing a recognized text region

Attributes

clockwise_orientation[RW]

@return [Float] The orientation of the image in degrees in the clockwise direction. Range between [0, 360).

height[RW]

@return [Float] The height of the image in pixels or the PDF in inches.

lines[RW]

@return [Array<Line>] A list of recognized text lines.

page[RW]

@return [Integer] The 1-based page number of the recognition result.

unit[RW]

@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'

width[RW]

@return [Float] The width of the image in pixels or the PDF in inches.

Private Class Methods

mapper() click to toggle source

Mapper for TextRecognitionResult class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2.1/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb, line 41
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